Loading...
Searching...
No Matches
FluidStateDensityModules.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_DENSITY_MODULES_HPP
#define OPM_FLUID_STATE_DENSITY_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 FluidStateExplicitDensityModule
{
public:
FluidStateExplicitDensityModule()
{ Valgrind::SetUndefined(density_); }
const Scalar& density(unsigned phaseIdx) const
{ return density_[phaseIdx]; }
Scalar molarDensity(unsigned phaseIdx) const
{ return density_[phaseIdx]/asImp_().averageMolarMass(phaseIdx); }
Scalar molarVolume(unsigned phaseIdx) const
{ return 1/molarDensity(phaseIdx); }
void setDensity(unsigned phaseIdx, const Scalar& value)
{ density_[phaseIdx] = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
density_[phaseIdx] = decay<Scalar>(fs.density(phaseIdx));
}
}
void checkDefined() const
{
Valgrind::CheckDefined(density_);
}
protected:
const Implementation& asImp_() const
{ return *static_cast<const Implementation*>(this); }
Scalar density_[numPhases];
};
template <class Scalar,
unsigned numPhases,
class Implementation>
class FluidStateNullDensityModule
{
public:
FluidStateNullDensityModule()
{ }
const Scalar& density(unsigned /* phaseIdx */) const
{ throw std::logic_error("Density is not provided by this fluid state"); }
const Scalar& molarDensity(unsigned /* phaseIdx */) const
{ throw std::logic_error("Molar density is not provided by this fluid state"); }
const Scalar& molarVolume(unsigned /* phaseIdx */) const
{ throw std::logic_error("Molar volume 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::FluidStateExplicitDensityModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateDensityModules.hpp:95
Opm::FluidStateExplicitDensityModule::molarDensity
Scalar molarDensity(unsigned phaseIdx) const
The molar density of a fluid phase [mol/m^3].
Definition FluidStateDensityModules.hpp:60
Opm::FluidStateExplicitDensityModule::molarVolume
Scalar molarVolume(unsigned phaseIdx) const
The molar volume of a fluid phase [m^3/mol].
Definition FluidStateDensityModules.hpp:66
Opm::FluidStateExplicitDensityModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateDensityModules.hpp:80
Opm::FluidStateExplicitDensityModule::setDensity
void setDensity(unsigned phaseIdx, const Scalar &value)
Set the density of a phase [kg/m^3].
Definition FluidStateDensityModules.hpp:72
Opm::FluidStateExplicitDensityModule::density
const Scalar & density(unsigned phaseIdx) const
The density of a fluid phase [kg/m^3].
Definition FluidStateDensityModules.hpp:54
Opm::FluidStateNullDensityModule::density
const Scalar & density(unsigned) const
The density of a fluid phase [kg/m^3].
Definition FluidStateDensityModules.hpp:123
Opm::FluidStateNullDensityModule::molarDensity
const Scalar & molarDensity(unsigned) const
The molar density of a fluid phase [mol/m^3].
Definition FluidStateDensityModules.hpp:129
Opm::FluidStateNullDensityModule::molarVolume
const Scalar & molarVolume(unsigned) const
The molar volume of a fluid phase [m^3/mol].
Definition FluidStateDensityModules.hpp:135
Opm::FluidStateNullDensityModule::assign
void assign(const FluidState &)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateDensityModules.hpp:143
Opm::FluidStateNullDensityModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateDensityModules.hpp:154
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30