Public Attributes | List of all members
Opm::SatFunc::CreateEPS::EPSOptions Struct Reference

Set of options that uniquely define a single EPS operation. More...

#include <ECLEndPointScaling.hpp>

Public Attributes

bool use3PtScaling
 
FunctionCategory curve
 Curve-type for which to create an EPS. More...
 
SubSystem subSys
 Part of global fluid system for which to create an EPS. More...
 
::Opm::ECLPhaseIndex thisPh
 

Detailed Description

Set of options that uniquely define a single EPS operation.

Member Data Documentation

◆ curve

FunctionCategory Opm::SatFunc::CreateEPS::EPSOptions::curve

Curve-type for which to create an EPS.

◆ subSys

SubSystem Opm::SatFunc::CreateEPS::EPSOptions::subSys

Part of global fluid system for which to create an EPS.

◆ thisPh

::Opm::ECLPhaseIndex Opm::SatFunc::CreateEPS::EPSOptions::thisPh

Phase for whose curve in which subSys to create an EPS.

Example: Create a standard (two-point) EPS for the relative permeability of oil in the oil-gas subsystem of an oil-gas-water active phase system.

auto opt = EPSOptions{};
opt.use3PtScaling = false;
opt.curve = FunctionCategory::Relperm;
opt.subSys = SubSystem::OilGas;
opt.thisPh = ECLPhaseIndex::Oil;
auto eps = CreateEPS::fromECLOutput(G, init, opt);
Opm::satfunc::init
std::vector< double > init(const std::string &kewyord, const TableManager &tables, const Phases &phases, const std::vector< double > &cell_depth, const std::vector< int > &num, const std::vector< int > &endnum)
Opm::SatFunc::CreateEPS::EPSOptions
Set of options that uniquely define a single EPS operation.
Definition: ECLEndPointScaling.hpp:534
Opm::SatFunc::CreateEPS::EPSOptions::use3PtScaling
bool use3PtScaling
Definition: ECLEndPointScaling.hpp:538
Opm::SatFunc::CreateEPS::SubSystem::OilGas
@ OilGas
Create an EPS for a curve in the Oil-Gas (sub-) system.

◆ use3PtScaling

bool Opm::SatFunc::CreateEPS::EPSOptions::use3PtScaling

Whether or not to employ the alternative (i.e., 3-pt) scaling procedure. Only applicable to FunctionCategory::Relperm and ignored in the case of FunctionCategory::CapPress.

The documentation for this struct was generated from the following file: