Loading...
Searching...
No Matches
FluidStateSaturationModules.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_FLUID_STATE_SATURATION_MODULES_HPP
#define OPM_FLUID_STATE_SATURATION_MODULES_HPP
#include <opm/material/common/MathToolbox.hpp>
#include <opm/material/common/Valgrind.hpp>
#include <algorithm>
namespace Opm {
template <class Scalar,
unsigned numPhases,
class Implementation>
class FluidStateExplicitSaturationModule
{
public:
FluidStateExplicitSaturationModule()
{ Valgrind::SetUndefined(saturation_); }
const Scalar& saturation(unsigned phaseIdx) const
{ return saturation_[phaseIdx]; }
void setSaturation(unsigned phaseIdx, const Scalar& value)
{ saturation_[phaseIdx] = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
saturation_[phaseIdx] = decay<Scalar>(fs.saturation(phaseIdx));
}
}
void checkDefined() const
{
Valgrind::CheckDefined(saturation_);
}
protected:
Scalar saturation_[numPhases];
};
template <class Scalar>
class FluidStateNullSaturationModule
{
public:
FluidStateNullSaturationModule()
{ }
const Scalar& saturation(unsigned /* phaseIdx */) const
{ throw std::runtime_error("Saturation is not provided by this fluid state"); }
template <class FluidState>
void assign(const FluidState& /* fs */)
{ }
void checkDefined() const
{ }
};
} // namespace Opm
#endif
MathToolbox.hpp
A traits class which provides basic mathematical functions for arbitrary scalar floating point values...
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::Valgrind::CheckDefined
OPM_HOST_DEVICE bool CheckDefined(const T &value)
Make valgrind complain if any of the memory occupied by an object is undefined.
Definition Valgrind.hpp:76
Opm::FluidStateExplicitSaturationModule::saturation
const Scalar & saturation(unsigned phaseIdx) const
The saturation of a fluid phase [-].
Definition FluidStateSaturationModules.hpp:54
Opm::FluidStateExplicitSaturationModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateSaturationModules.hpp:83
Opm::FluidStateExplicitSaturationModule::setSaturation
void setSaturation(unsigned phaseIdx, const Scalar &value)
Set the saturation of a phase [-].
Definition FluidStateSaturationModules.hpp:60
Opm::FluidStateExplicitSaturationModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateSaturationModules.hpp:68
Opm::FluidStateNullSaturationModule::assign
void assign(const FluidState &)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateSaturationModules.hpp:114
Opm::FluidStateNullSaturationModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateSaturationModules.hpp:125
Opm::FluidStateNullSaturationModule::saturation
const Scalar & saturation(unsigned) const
The saturation of a fluid phase [-].
Definition FluidStateSaturationModules.hpp:106
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30