opm-common/opm/material/thermal/SomertonThermalConductionLawParams.hpp
2021-06-18 13:24:02 +02:00

111 lines
3.1 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
* \copydoc Opm::SomertonThermalConductionLawParams
*/
#ifndef OPM_SOMERTON_THERMAL_CONDUCTION_LAW_PARAMS_HPP
#define OPM_SOMERTON_THERMAL_CONDUCTION_LAW_PARAMS_HPP
#include <cassert>
namespace Opm {
/*!
* \brief The default implementation of a parameter object for the
* Somerton thermal conduction law.
*/
template <unsigned numPhases, class ScalarT>
class SomertonThermalConductionLawParams
{
// do not copy!
SomertonThermalConductionLawParams(const SomertonThermalConductionLawParams&)
{}
public:
typedef ScalarT Scalar;
SomertonThermalConductionLawParams()
{ }
/*!
* \brief Return the "fully saturated" thermal conductivity of the
* porous medium [W/m^2 / (K/m)].
*
* In this context "fully saturated" means that the whole pore
* space of the porous medium is filled by a given fluid phase.
*/
Scalar fullySaturatedLambda(unsigned phaseIdx) const
{
assert(phaseIdx < numPhases);
return fullySaturatedLambda_[phaseIdx];
}
/*!
* \brief Set the "fully saturated" thermal conductivity of the
* porous medium [W/m^2 / (K/m)].
*
* In this context "fully saturated" means that the whole pore
* space of the porous medium is filled by a given fluid phase.
*/
void setFullySaturatedLambda(unsigned phaseIdx, Scalar value)
{
assert(phaseIdx < numPhases);
assert(value > 0);
fullySaturatedLambda_[phaseIdx] = value;
}
/*!
* \brief Return the thermal conductivity of the porous medium at
* vacuum [W/m^2 / (K/m)].
*/
Scalar vacuumLambda() const
{
return vacuumLambda_;
}
/*!
* \brief Set the "fully saturated" thermal conductivity of the
* porous medium [W/m^2 / (K/m)].
*
* In this context "fully saturated" means that the whole pore
* space of the porous medium is filled by a given fluid phase.
*/
void setVacuumLambda(Scalar value)
{
assert(value > 0);
vacuumLambda_ = value;
}
private:
Scalar fullySaturatedLambda_[numPhases];
Scalar vacuumLambda_;
};
} // namespace Opm
#endif