Loading...
Searching...
No Matches
FluidStateTemperatureModules.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_TEMPERATURE_MODULES_HPP
#define OPM_FLUID_STATE_TEMPERATURE_MODULES_HPP
#include <opm/material/common/Valgrind.hpp>
#include <opm/material/common/MathToolbox.hpp>
#include <algorithm>
#include <cassert>
namespace Opm {
template <class Scalar,
unsigned numPhases,
class Implementation>
class FluidStateExplicitTemperatureModule
{
public:
FluidStateExplicitTemperatureModule()
{ Valgrind::SetUndefined(temperature_); }
const Scalar& temperature(unsigned phaseIdx) const
{ return temperature_[phaseIdx]; }
void setTemperature(unsigned phaseIdx, const Scalar& value)
{ temperature_[phaseIdx] = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
temperature_[phaseIdx] = fs.temperature(phaseIdx);
}
}
void checkDefined() const
{
Valgrind::CheckDefined(temperature_);
}
protected:
Scalar temperature_[numPhases];
};
template <class Scalar,
unsigned numPhases,
class Implementation>
class FluidStateEquilibriumTemperatureModule
{
public:
FluidStateEquilibriumTemperatureModule()
{ Valgrind::SetUndefined(temperature_); }
const Scalar& temperature(unsigned /*phaseIdx*/) const
{ return temperature_; }
void setTemperature(const Scalar& value)
{ temperature_ = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
temperature_ = decay<Scalar>(fs.temperature(/*phaseIdx=*/0));
#ifndef NDEBUG
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
assert(std::abs(scalarValue(fs.temperature(phaseIdx))
- scalarValue(temperature_)) < 1e-30);
}
#endif
}
void checkDefined() const
{
Valgrind::CheckDefined(temperature_);
}
protected:
Scalar temperature_;
};
template <class Scalar>
class FluidStateNullTemperatureModule
{
public:
FluidStateNullTemperatureModule()
{ }
const Scalar& temperature(unsigned /* phaseIdx */) const
{ throw std::runtime_error("Temperature 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::FluidStateEquilibriumTemperatureModule
Module for the modular fluid state which stores the temperatures explicitly and assumes thermal equil...
Definition FluidStateTemperatureModules.hpp:102
Opm::FluidStateEquilibriumTemperatureModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateTemperatureModules.hpp:124
Opm::FluidStateEquilibriumTemperatureModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateTemperatureModules.hpp:144
Opm::FluidStateEquilibriumTemperatureModule::setTemperature
void setTemperature(const Scalar &value)
Set the temperature of a phase [-].
Definition FluidStateTemperatureModules.hpp:116
Opm::FluidStateEquilibriumTemperatureModule::temperature
const Scalar & temperature(unsigned) const
The temperature of a fluid phase [-].
Definition FluidStateTemperatureModules.hpp:110
Opm::FluidStateExplicitTemperatureModule
Module for the modular fluid state which stores the temperatures explicitly.
Definition FluidStateTemperatureModules.hpp:48
Opm::FluidStateExplicitTemperatureModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateTemperatureModules.hpp:70
Opm::FluidStateExplicitTemperatureModule::temperature
const Scalar & temperature(unsigned phaseIdx) const
The temperature of a fluid phase [-].
Definition FluidStateTemperatureModules.hpp:56
Opm::FluidStateExplicitTemperatureModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateTemperatureModules.hpp:85
Opm::FluidStateExplicitTemperatureModule::setTemperature
void setTemperature(unsigned phaseIdx, const Scalar &value)
Set the temperature of a phase [-].
Definition FluidStateTemperatureModules.hpp:62
Opm::FluidStateNullTemperatureModule
Module for the modular fluid state which does not the temperatures but throws std::logic_error instea...
Definition FluidStateTemperatureModules.hpp:159
Opm::FluidStateNullTemperatureModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateTemperatureModules.hpp:186
Opm::FluidStateNullTemperatureModule::temperature
const Scalar & temperature(unsigned) const
The temperature of a fluid phase [-].
Definition FluidStateTemperatureModules.hpp:167
Opm::FluidStateNullTemperatureModule::assign
void assign(const FluidState &)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateTemperatureModules.hpp:175
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30