da401551be
this patch removes the in-file lists in favor of a global list of in the COPYING file. this is done because (a) maintaining a list of authors at the beginning of each source file is a major pain in the a**, (b) for this reason, the list of authors was not accurate in about 85% of all cases where more than one person was involved and (c) this list is not legally binding in any way (the copyright is at the person who authored a given change; if these lists had any legal relevance, one could "aquire" the copyright of the module by forking it and replacing the lists...)
317 lines
11 KiB
C++
317 lines
11 KiB
C++
// -*- 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.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \brief Modules for the ModularFluidState which represent composition.
|
|
*/
|
|
#ifndef OPM_FLUID_STATE_COMPOSITION_MODULES_HPP
|
|
#define OPM_FLUID_STATE_COMPOSITION_MODULES_HPP
|
|
|
|
#include <opm/material/common/Valgrind.hpp>
|
|
#include <opm/material/common/MathToolbox.hpp>
|
|
|
|
#include <opm/common/ErrorMacros.hpp>
|
|
#include <opm/common/Exceptions.hpp>
|
|
|
|
#include <algorithm>
|
|
#include <cmath>
|
|
|
|
namespace Opm {
|
|
|
|
/*!
|
|
* \brief Module for the modular fluid state which stores the
|
|
* phase compositions explicitly in terms of mole fractions.
|
|
*/
|
|
template <class Scalar,
|
|
class FluidSystem,
|
|
class Implementation>
|
|
class FluidStateExplicitCompositionModule
|
|
{
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
enum { numComponents = FluidSystem::numComponents };
|
|
|
|
public:
|
|
FluidStateExplicitCompositionModule()
|
|
{
|
|
Valgrind::SetDefined(moleFraction_);
|
|
Valgrind::SetUndefined(averageMolarMass_);
|
|
Valgrind::SetUndefined(sumMoleFractions_);
|
|
}
|
|
|
|
/*!
|
|
* \brief The mole fraction of a component in a phase []
|
|
*/
|
|
const Scalar& moleFraction(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return moleFraction_[phaseIdx][compIdx]; }
|
|
|
|
/*!
|
|
* \brief The mass fraction of a component in a phase []
|
|
*/
|
|
Scalar massFraction(unsigned phaseIdx, unsigned compIdx) const
|
|
{
|
|
typedef Opm::MathToolbox<Scalar> Toolbox;
|
|
|
|
return
|
|
Toolbox::abs(sumMoleFractions_[phaseIdx])
|
|
*moleFraction_[phaseIdx][compIdx]
|
|
*FluidSystem::molarMass(compIdx)
|
|
/ Toolbox::max(1e-40, Toolbox::abs(averageMolarMass_[phaseIdx]));
|
|
}
|
|
|
|
/*!
|
|
* \brief The mean molar mass of a fluid phase [kg/mol]
|
|
*
|
|
* The average molar mass is the mean mass of one mole of the
|
|
* fluid at current composition. It is defined as the sum of the
|
|
* component's molar masses weighted by the current mole fraction:
|
|
* \f[ \bar M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa \f]
|
|
*/
|
|
const Scalar& averageMolarMass(unsigned phaseIdx) const
|
|
{ return averageMolarMass_[phaseIdx]; }
|
|
|
|
/*!
|
|
* \brief The concentration of a component in a phase [mol/m^3]
|
|
*
|
|
* This quantity is often called "molar concentration" or just
|
|
* "concentration", but there are many other (though less common)
|
|
* measures for concentration.
|
|
*
|
|
* http://en.wikipedia.org/wiki/Concentration
|
|
*/
|
|
Scalar molarity(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return asImp_().molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
|
|
|
|
/*!
|
|
* \brief Set the mole fraction of a component in a phase []
|
|
* and update the average molar mass [kg/mol] according
|
|
* to the current composition of the phase
|
|
*/
|
|
void setMoleFraction(unsigned phaseIdx, unsigned compIdx, const Scalar& value)
|
|
{
|
|
Valgrind::CheckDefined(value);
|
|
Valgrind::SetUndefined(sumMoleFractions_[phaseIdx]);
|
|
Valgrind::SetUndefined(averageMolarMass_[phaseIdx]);
|
|
Valgrind::SetUndefined(moleFraction_[phaseIdx][compIdx]);
|
|
|
|
moleFraction_[phaseIdx][compIdx] = value;
|
|
|
|
// re-calculate the mean molar mass
|
|
sumMoleFractions_[phaseIdx] = 0.0;
|
|
averageMolarMass_[phaseIdx] = 0.0;
|
|
for (unsigned compJIdx = 0; compJIdx < numComponents; ++compJIdx) {
|
|
sumMoleFractions_[phaseIdx] += moleFraction_[phaseIdx][compJIdx];
|
|
averageMolarMass_[phaseIdx] += moleFraction_[phaseIdx][compJIdx]*FluidSystem::molarMass(compJIdx);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \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 (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
|
|
averageMolarMass_[phaseIdx] = 0;
|
|
sumMoleFractions_[phaseIdx] = 0;
|
|
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
|
|
moleFraction_[phaseIdx][compIdx] =
|
|
FsToolbox::template toLhs<Scalar>(fs.moleFraction(phaseIdx, compIdx));
|
|
|
|
averageMolarMass_[phaseIdx] += moleFraction_[phaseIdx][compIdx]*FluidSystem::molarMass(compIdx);
|
|
sumMoleFractions_[phaseIdx] += moleFraction_[phaseIdx][compIdx];
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \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(moleFraction_);
|
|
Valgrind::CheckDefined(averageMolarMass_);
|
|
Valgrind::CheckDefined(sumMoleFractions_);
|
|
}
|
|
|
|
protected:
|
|
const Implementation &asImp_() const
|
|
{ return *static_cast<const Implementation*>(this); }
|
|
|
|
Scalar moleFraction_[numPhases][numComponents];
|
|
Scalar averageMolarMass_[numPhases];
|
|
Scalar sumMoleFractions_[numPhases];
|
|
};
|
|
|
|
/*!
|
|
* \brief Module for the modular fluid state which provides the
|
|
* phase compositions assuming immiscibility.
|
|
*/
|
|
template <class Scalar,
|
|
class FluidSystem,
|
|
class Implementation>
|
|
class FluidStateImmiscibleCompositionModule
|
|
{
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
|
|
public:
|
|
enum { numComponents = FluidSystem::numComponents };
|
|
static_assert((int) numPhases == (int) numComponents,
|
|
"The number of phases must be the same as the number of (pseudo-) components if you assume immiscibility");
|
|
|
|
FluidStateImmiscibleCompositionModule()
|
|
{ }
|
|
|
|
/*!
|
|
* \brief The mole fraction of a component in a phase []
|
|
*/
|
|
Scalar moleFraction(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return (phaseIdx == compIdx)?1.0:0.0; }
|
|
|
|
/*!
|
|
* \brief The mass fraction of a component in a phase []
|
|
*/
|
|
Scalar massFraction(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return (phaseIdx == compIdx)?1.0:0.0; }
|
|
|
|
/*!
|
|
* \brief The mean molar mass of a fluid phase [kg/mol]
|
|
*
|
|
* The average mass is the mean molar mass of a molecule of the
|
|
* fluid at current composition. It is defined as the sum of the
|
|
* component's molar masses weighted by the current mole fraction:
|
|
* \f[ \bar M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa \f]
|
|
*/
|
|
Scalar averageMolarMass(unsigned phaseIdx) const
|
|
{ return FluidSystem::molarMass(/*compIdx=*/phaseIdx); }
|
|
|
|
/*!
|
|
* \brief The concentration of a component in a phase [mol/m^3]
|
|
*
|
|
* This quantity is often called "molar concentration" or just
|
|
* "concentration", but there are many other (though less common)
|
|
* measures for concentration.
|
|
*
|
|
* http://en.wikipedia.org/wiki/Concentration
|
|
*/
|
|
Scalar molarity(unsigned phaseIdx, unsigned compIdx) const
|
|
{ return asImp_().molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
|
|
|
|
/*!
|
|
* \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
|
|
{ }
|
|
|
|
protected:
|
|
const Implementation &asImp_() const
|
|
{ return *static_cast<const Implementation*>(this); }
|
|
};
|
|
|
|
/*!
|
|
* \brief Module for the modular fluid state which does not store the
|
|
* compositions but throws std::logic_error instead.
|
|
*/
|
|
template <class Scalar>
|
|
class FluidStateNullCompositionModule
|
|
{
|
|
public:
|
|
enum { numComponents = 0 };
|
|
|
|
FluidStateNullCompositionModule()
|
|
{ }
|
|
|
|
/*!
|
|
* \brief The mole fraction of a component in a phase []
|
|
*/
|
|
Scalar moleFraction(int /* phaseIdx */, int /* compIdx */) const
|
|
{ OPM_THROW(std::logic_error, "Mole fractions are not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief The mass fraction of a component in a phase []
|
|
*/
|
|
Scalar massFraction(int /* phaseIdx */, int /* compIdx */) const
|
|
{ OPM_THROW(std::logic_error, "Mass fractions are not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief The mean molar mass of a fluid phase [kg/mol]
|
|
*
|
|
* The average mass is the mean molar mass of a molecule of the
|
|
* fluid at current composition. It is defined as the sum of the
|
|
* component's molar masses weighted by the current mole fraction:
|
|
* \f[ \bar M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa \f]
|
|
*/
|
|
Scalar averageMolarMass(int /* phaseIdx */) const
|
|
{ OPM_THROW(std::logic_error, "Mean molar masses are not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \brief The concentration of a component in a phase [mol/m^3]
|
|
*
|
|
* This quantity is often called "molar concentration" or just
|
|
* "concentration", but there are many other (though less common)
|
|
* measures for concentration.
|
|
*
|
|
* http://en.wikipedia.org/wiki/Concentration
|
|
*/
|
|
Scalar molarity(int /* phaseIdx */, int /* compIdx */) const
|
|
{ OPM_THROW(std::logic_error, "Molarities are not provided by this fluid state"); }
|
|
|
|
/*!
|
|
* \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
|