Loading...
Searching...
No Matches
EffToAbsLawParams.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_EFF_TO_ABS_LAW_PARAMS_HPP
#define OPM_EFF_TO_ABS_LAW_PARAMS_HPP
#include <cassert>
#include <opm/material/common/EnsureFinalized.hpp>
namespace Opm {
template <class EffLawParamsT, int numPhases>
class EffToAbsLawParams : public EffLawParamsT
{
typedef EffLawParamsT EffLawParams;
typedef typename EffLawParams::Traits::Scalar Scalar;
public:
typedef typename EffLawParams::Traits Traits;
EffToAbsLawParams()
: EffLawParams()
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
residualSaturation_[phaseIdx] = 0.0;
}
void finalize()
{
sumResidualSaturations_ = 0.0;
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx)
sumResidualSaturations_ += residualSaturation_[phaseIdx];
EffLawParams::finalize();
}
Scalar residualSaturation(unsigned phaseIdx) const
{ EnsureFinalized::check(); return residualSaturation_[phaseIdx]; }
Scalar sumResidualSaturations() const
{ EnsureFinalized::check(); return sumResidualSaturations_; }
void setResidualSaturation(unsigned phaseIdx, Scalar value)
{ residualSaturation_[phaseIdx] = value; }
private:
Scalar residualSaturation_[numPhases];
Scalar sumResidualSaturations_;
};
} // namespace Opm
#endif
EnsureFinalized.hpp
Default implementation for asserting finalization of parameter objects.
Opm::EffToAbsLawParams::residualSaturation
Scalar residualSaturation(unsigned phaseIdx) const
Return the residual saturation of a phase.
Definition EffToAbsLawParams.hpp:75
Opm::EffToAbsLawParams::sumResidualSaturations
Scalar sumResidualSaturations() const
Return the sum of the residual saturations.
Definition EffToAbsLawParams.hpp:81
Opm::EffToAbsLawParams::finalize
void finalize()
Calculate all dependent quantities once the independent quantities of the parameter object have been ...
Definition EffToAbsLawParams.hpp:63
Opm::EffToAbsLawParams::setResidualSaturation
void setResidualSaturation(unsigned phaseIdx, Scalar value)
Set the residual saturation of a phase.
Definition EffToAbsLawParams.hpp:87
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30