Files
opm-common/opm/material/fluidmatrixinteractions/EclDefaultMaterialParams.hpp
2017-02-07 13:05:21 +01:00

141 lines
4.2 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::EclDefaultMaterialParams
*/
#ifndef OPM_ECL_DEFAULT_MATERIAL_PARAMS_HPP
#define OPM_ECL_DEFAULT_MATERIAL_PARAMS_HPP
#include <type_traits>
#include <cassert>
#include <memory>
#include <opm/material/common/EnsureFinalized.hpp>
namespace Opm {
/*!
* \brief Default implementation for the parameters required by the
* default three-phase capillary pressure model used by
* Eclipse.
*
* Essentially, this class just stores the two parameter objects for
* the twophase capillary pressure laws.
*/
template<class Traits, class GasOilParamsT, class OilWaterParamsT>
class EclDefaultMaterialParams : public EnsureFinalized
{
typedef typename Traits::Scalar Scalar;
enum { numPhases = 3 };
public:
using EnsureFinalized :: finalize;
typedef GasOilParamsT GasOilParams;
typedef OilWaterParamsT OilWaterParams;
/*!
* \brief The default constructor.
*/
EclDefaultMaterialParams()
{
}
/*!
* \brief The parameter object for the gas-oil twophase law.
*/
const GasOilParams& gasOilParams() const
{ EnsureFinalized::check(); return *gasOilParams_; }
/*!
* \brief The parameter object for the gas-oil twophase law.
*/
GasOilParams& gasOilParams()
{ EnsureFinalized::check(); return *gasOilParams_; }
/*!
* \brief Set the parameter object for the gas-oil twophase law.
*/
void setGasOilParams(std::shared_ptr<GasOilParams> val)
{ gasOilParams_ = val; }
/*!
* \brief The parameter object for the oil-water twophase law.
*/
const OilWaterParams& oilWaterParams() const
{ EnsureFinalized::check(); return *oilWaterParams_; }
/*!
* \brief The parameter object for the oil-water twophase law.
*/
OilWaterParams& oilWaterParams()
{ EnsureFinalized::check(); return *oilWaterParams_; }
/*!
* \brief Set the parameter object for the oil-water twophase law.
*/
void setOilWaterParams(std::shared_ptr<OilWaterParams> val)
{ oilWaterParams_ = val; }
/*!
* \brief Set the saturation of "connate" water.
*
* According to
*
* http://www.glossary.oilfield.slb.com/en/Terms/c/connate_water.aspx
*
* the connate water is the water which is trapped in the pores of the rock during
* the rock's formation. For our application, this is basically a reduction of the
* rock's porosity...
*/
void setSwl(Scalar val)
{ Swl_ = val; }
/*!
* \brief Return the saturation of "connate" water.
*/
Scalar Swl() const
{ EnsureFinalized::check(); return Swl_; }
/*!
* \brief Specify whether inconsistent saturations should be used to update the
* hysteresis parameters.
*
* Returning 'true' is wrong from a physical point of view because the saturations
* which are used to update the hysteresis parameters are calculated differently than
* the ones used to calculate the relperms and capillary pressures. Since Eclipse
* E100 probably uses inconsistent saturations, we return true here anyway.
*/
bool inconsistentHysteresisUpdate() const
{ return true; }
private:
std::shared_ptr<GasOilParams> gasOilParams_;
std::shared_ptr<OilWaterParams> oilWaterParams_;
Scalar Swl_;
};
} // namespace Opm
#endif