Loading...
Searching...
No Matches
FluidStateFugacityModules.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_FUGACITY_MODULES_HPP
#define OPM_FLUID_STATE_FUGACITY_MODULES_HPP
#include <opm/material/common/Valgrind.hpp>
#include <algorithm>
#include <limits>
#include <stdexcept>
namespace Opm {
template <class Scalar,
unsigned numPhases,
unsigned numComponents,
class Implementation>
class FluidStateExplicitFugacityModule
{
public:
FluidStateExplicitFugacityModule()
{
Valgrind::SetUndefined(fugacityCoefficient_);
}
const Scalar& fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
{ return fugacityCoefficient_[phaseIdx][compIdx]; }
Scalar fugacity(unsigned phaseIdx, unsigned compIdx) const
{ return asImp_().pressure(phaseIdx)*fugacityCoefficient_[phaseIdx][compIdx]*asImp_().moleFraction(phaseIdx, compIdx); }
void setFugacityCoefficient(unsigned phaseIdx, unsigned compIdx, const Scalar& value)
{ fugacityCoefficient_[phaseIdx][compIdx] = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
fugacityCoefficient_[phaseIdx][compIdx] = fs.fugacityCoefficient(phaseIdx, compIdx);
}
}
}
void checkDefined() const
{
Valgrind::CheckDefined(fugacityCoefficient_);
}
protected:
const Implementation& asImp_() const
{ return *static_cast<const Implementation*>(this); }
Scalar fugacityCoefficient_[numPhases][numComponents];
};
template <class Scalar,
unsigned numPhases,
unsigned numComponents,
class Implementation>
class FluidStateImmiscibleFugacityModule
{
static_assert(numPhases == numComponents,
"The number of phases must be the same as the number of (pseudo-) components if you assume immiscibility");
public:
FluidStateImmiscibleFugacityModule()
{ Valgrind::SetUndefined(fugacityCoefficient_); }
Scalar fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
{ return (phaseIdx == compIdx)?fugacityCoefficient_[phaseIdx]:std::numeric_limits<Scalar>::infinity(); }
Scalar fugacity(unsigned phaseIdx, unsigned compIdx) const
{ return asImp_().pressure(phaseIdx)*fugacityCoefficient(phaseIdx, compIdx)*asImp_().moleFraction(phaseIdx, compIdx); }
void setFugacityCoefficient(unsigned phaseIdx, const Scalar& value)
{ fugacityCoefficient_[phaseIdx] = value; }
template <class FluidState>
void assign(const FluidState& fs)
{
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
fugacityCoefficient_[phaseIdx] = fs.fugacityCoefficient(phaseIdx, /*compIdx=*/phaseIdx);
}
}
void checkDefined() const
{
Valgrind::CheckDefined(fugacityCoefficient_);
}
protected:
const Implementation& asImp_() const
{ return *static_cast<const Implementation*>(this); }
Scalar fugacityCoefficient_[numPhases];
};
template <class Scalar>
class FluidStateNullFugacityModule
{
public:
FluidStateNullFugacityModule()
{ }
const Scalar& fugacityCoefficient(unsigned /* phaseIdx */, unsigned /* compIdx */) const
{ throw std::logic_error("Fugacity coefficients are not provided by this fluid state"); }
const Scalar& fugacity(unsigned /* phaseIdx */, unsigned /* compIdx */) const
{ throw std::logic_error("Fugacities coefficients are not provided by this fluid state"); }
void checkDefined() const
{ }
};
} // namespace Opm
#endif
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::FluidStateExplicitFugacityModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateFugacityModules.hpp:78
Opm::FluidStateExplicitFugacityModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateFugacityModules.hpp:95
Opm::FluidStateExplicitFugacityModule::setFugacityCoefficient
void setFugacityCoefficient(unsigned phaseIdx, unsigned compIdx, const Scalar &value)
Set the fugacity of a component in a phase [].
Definition FluidStateFugacityModules.hpp:70
Opm::FluidStateExplicitFugacityModule::fugacity
Scalar fugacity(unsigned phaseIdx, unsigned compIdx) const
The fugacity of a component in a phase [Pa].
Definition FluidStateFugacityModules.hpp:64
Opm::FluidStateExplicitFugacityModule::fugacityCoefficient
const Scalar & fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
The fugacity coefficient of a component in a phase [].
Definition FluidStateFugacityModules.hpp:58
Opm::FluidStateImmiscibleFugacityModule::assign
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition FluidStateFugacityModules.hpp:147
Opm::FluidStateImmiscibleFugacityModule::fugacityCoefficient
Scalar fugacityCoefficient(unsigned phaseIdx, unsigned compIdx) const
The fugacity coefficient of a component in a phase [].
Definition FluidStateFugacityModules.hpp:127
Opm::FluidStateImmiscibleFugacityModule::setFugacityCoefficient
void setFugacityCoefficient(unsigned phaseIdx, const Scalar &value)
Set the fugacity of a component in a phase [].
Definition FluidStateFugacityModules.hpp:139
Opm::FluidStateImmiscibleFugacityModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateFugacityModules.hpp:162
Opm::FluidStateImmiscibleFugacityModule::fugacity
Scalar fugacity(unsigned phaseIdx, unsigned compIdx) const
The fugacity of a component in a phase [Pa].
Definition FluidStateFugacityModules.hpp:133
Opm::FluidStateNullFugacityModule::fugacity
const Scalar & fugacity(unsigned, unsigned) const
The fugacity of a component in a phase [Pa].
Definition FluidStateFugacityModules.hpp:194
Opm::FluidStateNullFugacityModule::fugacityCoefficient
const Scalar & fugacityCoefficient(unsigned, unsigned) const
The fugacity coefficient of a component in a phase [].
Definition FluidStateFugacityModules.hpp:188
Opm::FluidStateNullFugacityModule::checkDefined
void checkDefined() const
Make sure that all attributes are defined.
Definition FluidStateFugacityModules.hpp:205
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30