Loading...
Searching...
No Matches
Runspec.hpp
/*
Copyright 2016 Statoil ASA.
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 3 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/>.
*/
#ifndef OPM_RUNSPEC_HPP
#define OPM_RUNSPEC_HPP
#include <opm/common/OpmLog/KeywordLocation.hpp>
#include <opm/input/eclipse/EclipseState/EndpointScaling.hpp>
#include <opm/input/eclipse/EclipseState/Phase.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Regdims.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Tabdims.hpp>
#include <opm/input/eclipse/Schedule/Action/Actdims.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQParams.hpp>
#include <bitset>
#include <cstddef>
#include <ctime>
#include <optional>
namespace Opm {
class Deck;
} // namespace Opm
namespace Opm {
class Phases
{
public:
Phases() noexcept = default;
Phases(bool oil, bool gas, bool wat,
bool solvent = false,
bool polymer = false,
bool energy = false,
bool polymw = false,
bool foam = false,
bool brine = false,
bool zfraction = false) noexcept;
static Phases serializationTestObject();
bool active( Phase ) const noexcept;
size_t size() const noexcept;
bool operator==(const Phases& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(bits);
}
private:
std::bitset<NUM_PHASES_IN_ENUM> bits;
};
class Welldims {
public:
Welldims() = default;
explicit Welldims(const Deck& deck);
static Welldims serializationTestObject();
int maxConnPerWell() const
{
return this->nCWMax;
}
int maxWellsPerGroup() const
{
return this->nWGMax;
}
int maxGroupsInField() const
{
return this->nGMax;
}
int maxWellsInField() const
{
return this->nWMax;
}
int maxWellListsPrWell() const
{
return this->nWlistPrWellMax;
}
int maxDynamicWellLists() const
{
return this->nDynWlistMax;
}
const std::optional<KeywordLocation>& location() const
{
return this->m_location;
}
static bool rst_cmp(const Welldims& full_dims, const Welldims& rst_dims) {
return full_dims.maxConnPerWell() == rst_dims.maxConnPerWell() &&
full_dims.maxWellsPerGroup() == rst_dims.maxWellsPerGroup() &&
full_dims.maxGroupsInField() == rst_dims.maxGroupsInField() &&
full_dims.maxWellsInField() == rst_dims.maxWellsInField() &&
full_dims.maxWellListsPrWell() == rst_dims.maxWellListsPrWell() &&
full_dims.maxDynamicWellLists() == rst_dims.maxDynamicWellLists();
}
bool operator==(const Welldims& data) const {
return this->location() == data.location() &&
rst_cmp(*this, data);
}
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(nWMax);
serializer(nCWMax);
serializer(nWGMax);
serializer(nGMax);
serializer(nWlistPrWellMax);
serializer(nDynWlistMax);
serializer(m_location);
}
private:
int nWMax { 0 };
int nCWMax { 0 };
int nWGMax { 0 };
int nGMax { 0 };
int nWlistPrWellMax { 1 };
int nDynWlistMax { 1 };
std::optional<KeywordLocation> m_location;
};
class WellSegmentDims {
public:
WellSegmentDims();
explicit WellSegmentDims(const Deck& deck);
static WellSegmentDims serializationTestObject();
int maxSegmentedWells() const
{
return this->nSegWellMax;
}
int maxSegmentsPerWell() const
{
return this->nSegmentMax;
}
int maxLateralBranchesPerWell() const
{
return this->nLatBranchMax;
}
const std::optional<KeywordLocation>& location() const
{
return this->location_;
}
bool operator==(const WellSegmentDims& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(nSegWellMax);
serializer(nSegmentMax);
serializer(nLatBranchMax);
serializer(location_);
}
private:
int nSegWellMax;
int nSegmentMax;
int nLatBranchMax;
std::optional<KeywordLocation> location_;
};
class NetworkDims {
public:
NetworkDims();
explicit NetworkDims(const Deck& deck);
static NetworkDims serializationTestObject();
int maxNONodes() const
{
return this->nMaxNoNodes;
}
int maxNoBranches() const
{
return this->nMaxNoBranches;
}
int maxNoBranchesConToNode() const
{
return this->nMaxNoBranchesConToNode;
}
bool extendedNetwork() const
{
return this->type_ == Type::Extended;
}
bool standardNetwork() const
{
return this->type_ == Type::Standard;
}
bool active() const
{
return this->extendedNetwork()
|| this->standardNetwork();
}
bool operator==(const NetworkDims& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(nMaxNoNodes);
serializer(nMaxNoBranches);
serializer(nMaxNoBranchesConToNode);
}
private:
enum class Type { None, Extended, Standard, };
int nMaxNoNodes;
int nMaxNoBranches;
int nMaxNoBranchesConToNode;
Type type_{ Type::None };
};
class AquiferDimensions {
public:
AquiferDimensions();
explicit AquiferDimensions(const Deck& deck);
static AquiferDimensions serializationTestObject();
int maxAnalyticAquifers() const
{
return this->maxNumAnalyticAquifers;
}
int maxAnalyticAquiferConnections() const
{
return this->maxNumAnalyticAquiferConn;
}
template <class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(this->maxNumAnalyticAquifers);
serializer(this->maxNumAnalyticAquiferConn);
}
private:
int maxNumAnalyticAquifers;
int maxNumAnalyticAquiferConn;
};
bool operator==(const AquiferDimensions& lhs, const AquiferDimensions& rhs);
class EclHysterConfig
{
public:
EclHysterConfig() = default;
explicit EclHysterConfig(const Deck& deck);
static EclHysterConfig serializationTestObject();
//void setActive(bool yesno);
bool active() const;
int pcHysteresisModel() const;
int krHysteresisModel() const;
double modParamTrapped() const;
double curvatureCapPrs() const;
bool activeWag() const;
bool operator==(const EclHysterConfig& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(activeHyst);
serializer(pcHystMod);
serializer(krHystMod);
serializer(modParamTrappedValue);
serializer(curvatureCapPrsValue);
serializer(activeWagHyst);
}
private:
// enable hysteresis at all
bool activeHyst { false };
// the capillary pressure and the relperm hysteresis models to be used
int pcHystMod { -1 };
int krHystMod { -1 };
// regularisation parameter used for Killough model
double modParamTrappedValue { 0.1 };
// curvature parameter for capillary pressure
double curvatureCapPrsValue { 0.1 };
// enable WAG hysteresis
bool activeWagHyst { false };
};
class SatFuncControls {
public:
enum class ThreePhaseOilKrModel {
Default,
Stone1,
Stone2
};
enum class KeywordFamily {
Family_I, // SGOF, SWOF, SLGOF
Family_II, // SGFN, SOF{2,3}, SWFN, SGWFN
Family_III, // GSF, WSF
Undefined,
};
SatFuncControls();
explicit SatFuncControls(const Deck& deck);
explicit SatFuncControls(const double tolcritArg,
const ThreePhaseOilKrModel model,
const KeywordFamily family);
static SatFuncControls serializationTestObject();
double minimumRelpermMobilityThreshold() const
{
return this->tolcrit;
}
ThreePhaseOilKrModel krModel() const
{
return this->krmodel;
}
KeywordFamily family() const
{
return this->satfunc_family;
}
bool operator==(const SatFuncControls& rhs) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(tolcrit);
serializer(krmodel);
serializer(satfunc_family);
}
private:
double tolcrit;
ThreePhaseOilKrModel krmodel = ThreePhaseOilKrModel::Default;
KeywordFamily satfunc_family = KeywordFamily::Undefined;
};
class Nupcol {
public:
Nupcol();
explicit Nupcol(int min_value);
void update(int value);
int value() const;
static Nupcol serializationTestObject();
bool operator==(const Nupcol& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer) {
serializer(this->nupcol_value);
serializer(this->min_nupcol);
}
private:
int min_nupcol;
int nupcol_value;
};
class Tracers {
public:
Tracers() = default;
explicit Tracers(const Deck& );
int water_tracers() const;
template<class Serializer>
void serializeOp(Serializer& serializer) {
serializer(this->m_oil_tracers);
serializer(this->m_water_tracers);
serializer(this->m_gas_tracers);
serializer(this->m_env_tracers);
serializer(this->diffusion_control);
serializer(this->max_iter);
serializer(this->min_iter);
}
static Tracers serializationTestObject();
bool operator==(const Tracers& data) const;
private:
int m_oil_tracers{};
int m_water_tracers{};
int m_gas_tracers{};
int m_env_tracers{};
bool diffusion_control{false};
int max_iter{};
int min_iter{};
// The TRACERS keyword has some additional options which seem quite arcane,
// for now not included here.
};
class Runspec {
public:
Runspec() = default;
explicit Runspec( const Deck& );
static Runspec serializationTestObject();
std::time_t start_time() const noexcept;
const UDQParams& udqParams() const noexcept;
const Phases& phases() const noexcept;
const Tabdims& tabdims() const noexcept;
const Regdims& regdims() const noexcept;
const EndpointScaling& endpointScaling() const noexcept;
const Welldims& wellDimensions() const noexcept;
const WellSegmentDims& wellSegmentDimensions() const noexcept;
const NetworkDims& networkDimensions() const noexcept;
const AquiferDimensions& aquiferDimensions() const noexcept;
int eclPhaseMask( ) const noexcept;
const EclHysterConfig& hysterPar() const noexcept;
const Actdims& actdims() const noexcept;
const SatFuncControls& saturationFunctionControls() const noexcept;
const Nupcol& nupcol() const noexcept;
const Tracers& tracers() const;
bool compositionalMode() const;
size_t numComps() const;
bool co2Storage() const noexcept;
bool co2Sol() const noexcept;
bool h2Sol() const noexcept;
bool h2Storage() const noexcept;
bool micp() const noexcept;
bool mech() const noexcept;
bool operator==(const Runspec& data) const;
static bool rst_cmp(const Runspec& full_state, const Runspec& rst_state);
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(this->m_start_time);
serializer(active_phases);
serializer(m_tabdims);
serializer(m_regdims);
serializer(endscale);
serializer(welldims);
serializer(wsegdims);
serializer(netwrkdims);
serializer(aquiferdims);
serializer(udq_params);
serializer(hystpar);
serializer(m_actdims);
serializer(m_sfuncctrl);
serializer(m_nupcol);
serializer(m_tracers);
serializer(m_comps);
serializer(m_co2storage);
serializer(m_co2sol);
serializer(m_h2sol);
serializer(m_h2storage);
serializer(m_micp);
serializer(m_mech);
}
private:
std::time_t m_start_time;
Phases active_phases;
Tabdims m_tabdims;
Regdims m_regdims;
EndpointScaling endscale;
Welldims welldims;
WellSegmentDims wsegdims;
NetworkDims netwrkdims;
AquiferDimensions aquiferdims;
UDQParams udq_params;
EclHysterConfig hystpar;
Actdims m_actdims;
SatFuncControls m_sfuncctrl;
Nupcol m_nupcol;
Tracers m_tracers;
size_t m_comps = 0;
bool m_co2storage;
bool m_co2sol;
bool m_h2sol;
bool m_h2storage;
bool m_micp;
bool m_mech;
};
std::size_t declaredMaxRegionID(const Runspec& rspec);
} // namespace Opm
#endif // OPM_RUNSPEC_HPP
Opm::Actdims
Definition Actdims.hpp:30
Opm::AquiferDimensions
Definition Runspec.hpp:255
Opm::Deck
Definition Deck.hpp:49
Opm::EclHysterConfig
Definition Runspec.hpp:287
Opm::EclHysterConfig::pcHysteresisModel
int pcHysteresisModel() const
Return the type of the hysteresis model which is used for capillary pressure.
Definition Runspec.cpp:467
Opm::EclHysterConfig::modParamTrapped
double modParamTrapped() const
Regularisation parameter used for Killough model.
Definition Runspec.cpp:473
Opm::EclHysterConfig::curvatureCapPrs
double curvatureCapPrs() const
Curvature parameter used for capillary pressure hysteresis.
Definition Runspec.cpp:476
Opm::EclHysterConfig::activeWag
bool activeWag() const
Wag hysteresis.
Definition Runspec.cpp:479
Opm::EclHysterConfig::active
bool active() const
Specify whether hysteresis is enabled or not.
Definition Runspec.cpp:464
Opm::EclHysterConfig::krHysteresisModel
int krHysteresisModel() const
Return the type of the hysteresis model which is used for relative permeability.
Definition Runspec.cpp:470
Opm::EndpointScaling
Definition EndpointScaling.hpp:28
Opm::NetworkDims
Definition Runspec.hpp:198
Opm::Nupcol
Definition Runspec.hpp:424
Opm::Phases
Definition Runspec.hpp:46
Opm::Regdims
Definition Regdims.hpp:36
Opm::Runspec
Definition Runspec.hpp:480
Opm::SatFuncControls
Definition Runspec.hpp:368
Opm::Serializer
Class for (de-)serializing.
Definition Serializer.hpp:91
Opm::Tabdims
Definition Tabdims.hpp:36
Opm::Tracers
Definition Runspec.hpp:446
Opm::UDQParams
Definition UDQParams.hpp:31
Opm::WellSegmentDims
Definition Runspec.hpp:153
Opm::Welldims
Definition Runspec.hpp:75
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30