7cbffc22c6
it is called "simple" because the usage is somewhat simpler: The quantities are stored and those which are not can be specified using simple boolean template arguments instead of having to pass the class names of the storage modules. The definition of the class is quite a bit more involved than the non-"simple" variant, though.
164 lines
4.5 KiB
C++
164 lines
4.5 KiB
C++
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
// vi: set et ts=4 sw=4 sts=4:
|
|
/*
|
|
Copyright (C) 2011-2013 by Andreas Lauser
|
|
|
|
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/>.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \brief Modules for the ModularFluidState which represent density.
|
|
*/
|
|
#ifndef OPM_FLUID_STATE_DENSITY_MODULES_HPP
|
|
#define OPM_FLUID_STATE_DENSITY_MODULES_HPP
|
|
|
|
#include <opm/material/common/ErrorMacros.hpp>
|
|
#include <opm/material/common/Exceptions.hpp>
|
|
|
|
#include <opm/material/common/MathToolbox.hpp>
|
|
#include <opm/material/common/Valgrind.hpp>
|
|
|
|
#include <algorithm>
|
|
|
|
namespace Opm {
|
|
|
|
/*!
|
|
* \brief Module for the modular fluid state which stores the
|
|
* densities explicitly.
|
|
*/
|
|
template <class Scalar,
|
|
int numPhases,
|
|
class Implementation>
|
|
class FluidStateExplicitDensityModule
|
|
{
|
|
public:
|
|
FluidStateExplicitDensityModule()
|
|
{ Valgrind::SetUndefined(density_); }
|
|
|
|
/*!
|
|
* \brief The density of a fluid phase [kg/m^3]
|
|
*/
|
|
const Scalar& density(int phaseIdx) const
|
|
{ return density_[phaseIdx]; }
|
|
|
|
/*!
|
|
* \brief The molar density of a fluid phase [mol/m^3]
|
|
*/
|
|
Scalar molarDensity(int phaseIdx) const
|
|
{ return density_[phaseIdx]/asImp_().averageMolarMass(phaseIdx); }
|
|
|
|
/*!
|
|
* \brief The molar volume of a fluid phase [m^3/mol]
|
|
*/
|
|
Scalar molarVolume(int phaseIdx) const
|
|
{ return 1/molarDensity(phaseIdx); }
|
|
|
|
/*!
|
|
* \brief Set the density of a phase [kg/m^3]
|
|
*/
|
|
void setDensity(int phaseIdx, const Scalar& value)
|
|
{ density_[phaseIdx] = value; }
|
|
|
|
/*!
|
|
* \brief Retrieve all parameters from an arbitrary fluid
|
|
* state.
|
|
*/
|
|
template <class FluidState>
|
|
void assign(const FluidState& fs)
|
|
{
|
|
typedef typename FluidState::Scalar FsScalar;
|
|
typedef Opm::MathToolbox<FsScalar> FsToolbox;
|
|
for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
density_[phaseIdx] = FsToolbox::template toLhs<Scalar>(fs.density(phaseIdx));
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Make sure that all attributes are defined.
|
|
*
|
|
* This method does not do anything if the program is not run
|
|
* under valgrind. If it is, then valgrind will print an error
|
|
* message if some attributes of the object have not been properly
|
|
* defined.
|
|
*/
|
|
void checkDefined() const
|
|
{
|
|
Valgrind::CheckDefined(density_);
|
|
}
|
|
|
|
protected:
|
|
const Implementation &asImp_() const
|
|
{ return *static_cast<const Implementation*>(this); }
|
|
|
|
Scalar density_[numPhases];
|
|
};
|
|
|
|
/*!
|
|
* \brief Module for the modular fluid state which does not the
|
|
* densities but throws std::logic_error instead.
|
|
*/
|
|
template <class Scalar,
|
|
int numPhases,
|
|
class Implementation>
|
|
class FluidStateNullDensityModule
|
|
{
|
|
public:
|
|
FluidStateNullDensityModule()
|
|
{ }
|
|
|
|
/*!
|
|
* \brief The density of a fluid phase [kg/m^3]
|
|
*/
|
|
const Scalar& density(int phaseIdx) const
|
|
{ OPM_THROW(std::logic_error, "Density is not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief The molar density of a fluid phase [mol/m^3]
|
|
*/
|
|
Scalar molarDensity(int phaseIdx) const
|
|
{ OPM_THROW(std::logic_error, "Molar density is not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief The molar volume of a fluid phase [m^3/mol]
|
|
*/
|
|
Scalar molarVolume(int phaseIdx) const
|
|
{ OPM_THROW(std::logic_error, "Molar volume is not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief Retrieve all parameters from an arbitrary fluid
|
|
* state.
|
|
*/
|
|
template <class FluidState>
|
|
void assign(const FluidState& fs)
|
|
{ }
|
|
|
|
/*!
|
|
* \brief Make sure that all attributes are defined.
|
|
*
|
|
* This method does not do anything if the program is not run
|
|
* under valgrind. If it is, then valgrind will print an error
|
|
* message if some attributes of the object have not been properly
|
|
* defined.
|
|
*/
|
|
void checkDefined() const
|
|
{ }
|
|
};
|
|
|
|
} // namespace Opm
|
|
|
|
#endif
|