Files
opm-common/opm/material/fluidmatrixinteractions/LinearMaterialParams.hpp
Robert Kloefkorn e02a5d63e8 Converted all *Params classes to use EnsureFinalized. By default this feature is
enabled until an optional switch will be implemented.
2017-02-07 16:10:54 +01:00

104 lines
2.9 KiB
C++

// -*- 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.
*/
/*!
* \file
* \copydoc Opm::LinearMaterialParams
*/
#ifndef OPM_LINEAR_MATERIAL_PARAMS_HPP
#define OPM_LINEAR_MATERIAL_PARAMS_HPP
#include <cassert>
#include <opm/material/common/EnsureFinalized.hpp>
namespace Opm {
/*!
* \brief Reference implementation of params for the linear M-phase
* material material.
*/
template<class TraitsT>
class LinearMaterialParams : public EnsureFinalized
{
enum { numPhases = TraitsT::numPhases };
typedef typename TraitsT::Scalar Scalar;
public:
using EnsureFinalized :: finalize;
typedef TraitsT Traits;
/*!
* \brief The default constructor.
*
* We set the capillary pressure to zero, if not specified otherwise.
*/
LinearMaterialParams()
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
setPcMinSat(phaseIdx, 0.0);
setPcMaxSat(phaseIdx, 0.0);
}
}
/*!
* \brief Return the relative phase pressure at the minimum saturation of a phase.
*
* This means \f$p_{c\alpha}\f$ at \f$S_\alpha=0\f$.
*/
Scalar pcMinSat(unsigned phaseIdx) const
{ EnsureFinalized::check();return pcMinSat_[phaseIdx]; }
/*!
* \brief Set the relative phase pressure at the minimum saturation of a phase.
*
* This means \f$p_{c\alpha}\f$ at \f$S_\alpha=0\f$.
*/
void setPcMinSat(unsigned phaseIdx, Scalar val)
{ pcMinSat_[phaseIdx] = val; }
/*!
* \brief Return the relative phase pressure at the maximum saturation of a phase.
*
* This means \f$p_{c\alpha}\f$ at \f$S_\alpha=1\f$.
*/
Scalar pcMaxSat(unsigned phaseIdx) const
{ EnsureFinalized::check(); return pcMaxSat_[phaseIdx]; }
/*!
* \brief Set the relative phase pressure at the maximum saturation of a phase.
*
* This means \f$p_{c\alpha}\f$ at \f$S_\alpha=1\f$.
*/
void setPcMaxSat(unsigned phaseIdx, Scalar val)
{ pcMaxSat_[phaseIdx] = val; }
private:
Scalar pcMaxSat_[numPhases];
Scalar pcMinSat_[numPhases];
};
} // namespace Opm
#endif