Loading...
Searching...
No Matches
BrooksCoreyParams.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 OPM_BROOKS_COREY_PARAMS_HPP
#define OPM_BROOKS_COREY_PARAMS_HPP
#include <opm/material/common/Valgrind.hpp>
#include <opm/material/common/EnsureFinalized.hpp>
#include <cassert>
namespace Opm {
template <class TraitsT>
class BrooksCoreyParams : public EnsureFinalized
{
typedef typename TraitsT::Scalar Scalar;
public:
using EnsureFinalized :: finalize;
typedef TraitsT Traits;
BrooksCoreyParams()
{
Valgrind::SetUndefined(*this);
}
BrooksCoreyParams(Scalar ePressure, Scalar shapeParam)
: entryPressure_(ePressure), lambda_(shapeParam)
{
finalize();
}
Scalar entryPressure() const
{ EnsureFinalized::check(); return entryPressure_; }
void setEntryPressure(Scalar v)
{ entryPressure_ = v; }
Scalar lambda() const
{ EnsureFinalized::check(); return lambda_; }
void setLambda(Scalar v)
{ lambda_ = v; }
private:
Scalar entryPressure_;
Scalar lambda_;
};
} // namespace Opm
#endif
EnsureFinalized.hpp
Default implementation for asserting finalization of parameter objects.
Valgrind.hpp
Some templates to wrap the valgrind client request macros.
Opm::Valgrind::SetUndefined
OPM_HOST_DEVICE void SetUndefined(const T &value)
Make the memory on which an object resides undefined in valgrind runs.
Definition Valgrind.hpp:174
Opm::BrooksCoreyParams::lambda
Scalar lambda() const
Returns the lambda shape parameter.
Definition BrooksCoreyParams.hpp:81
Opm::BrooksCoreyParams::setEntryPressure
void setEntryPressure(Scalar v)
Set the entry pressure [Pa].
Definition BrooksCoreyParams.hpp:74
Opm::BrooksCoreyParams::setLambda
void setLambda(Scalar v)
Set the lambda shape parameter.
Definition BrooksCoreyParams.hpp:87
Opm::BrooksCoreyParams::entryPressure
Scalar entryPressure() const
Returns the entry pressure [Pa].
Definition BrooksCoreyParams.hpp:68
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
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30