Loading...
Searching...
No Matches
VanGenuchtenParams.hpp
Go to the documentation of this file.
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
#ifndef VAN_GENUCHTEN_PARAMS_HPP
#define VAN_GENUCHTEN_PARAMS_HPP
#include <opm/material/common/EnsureFinalized.hpp>
namespace Opm {
template<class TraitsT>
class VanGenuchtenParams : public EnsureFinalized
{
typedef typename TraitsT::Scalar Scalar;
public:
using EnsureFinalized :: finalize;
typedef TraitsT Traits;
VanGenuchtenParams()
{
}
VanGenuchtenParams(Scalar alphaParam, Scalar nParam)
{
setVgAlpha(alphaParam);
setVgN(nParam);
finalize();
}
Scalar vgAlpha() const
{ EnsureFinalized::check(); return vgAlpha_; }
void setVgAlpha(Scalar v)
{ vgAlpha_ = v; }
Scalar vgM() const
{ EnsureFinalized::check(); return vgM_; }
void setVgM(Scalar m)
{ vgM_ = m; vgN_ = 1/(1 - vgM_); }
Scalar vgN() const
{ EnsureFinalized::check(); return vgN_; }
void setVgN(Scalar n)
{ vgN_ = n; vgM_ = 1 - 1/vgN_; }
private:
Scalar vgAlpha_;
Scalar vgM_;
Scalar vgN_;
};
} // namespace Opm
#endif
EnsureFinalized.hpp
Default implementation for asserting finalization of parameter objects.
Opm::EnsureFinalized::EnsureFinalized
OPM_HOST_DEVICE EnsureFinalized()
The default constructor.
Definition EnsureFinalized.hpp:58
Opm::EnsureFinalized::finalize
OPM_HOST_DEVICE void finalize()
Mark the object as finalized.
Definition EnsureFinalized.hpp:82
Opm::VanGenuchtenParams::setVgN
void setVgN(Scalar n)
Set the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:107
Opm::VanGenuchtenParams::vgM
Scalar vgM() const
Return the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:82
Opm::VanGenuchtenParams::vgN
Scalar vgN() const
Return the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:98
Opm::VanGenuchtenParams::vgAlpha
Scalar vgAlpha() const
Return the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:68
Opm::VanGenuchtenParams::setVgM
void setVgM(Scalar m)
Set the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:91
Opm::VanGenuchtenParams::setVgAlpha
void setVgAlpha(Scalar v)
Set the shape parameter of van Genuchten's curve.
Definition VanGenuchtenParams.hpp:75
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30