Opm::SatFunc::CreateEPS::Vertical Struct Reference

#include <ECLEndPointScaling.hpp>

Public Types

using SatFuncEvaluator = std::function< double(int, double)>
 
using FuncValVector = std::vector< VerticalScalingInterface::FunctionValues >
 

Static Public Member Functions

static std::unique_ptr< VerticalScalingInterfacefromECLOutput (const ECLGraph &G, const ECLInitFileData &init, const EPSOptions &opt, const RawTableEndPoints &tep, const FuncValVector &fvals)
 
static std::vector< VerticalScalingInterface::FunctionValuesunscaledFunctionValues (const ECLGraph &G, const ECLInitFileData &init, const RawTableEndPoints &ep, const EPSOptions &opt, const SatFuncEvaluator &evalSF)
 

Detailed Description

Named constructors for vertical (value) scaling of saturation functions.

Member Typedef Documentation

◆ FuncValVector

◆ SatFuncEvaluator

using Opm::SatFunc::CreateEPS::Vertical::SatFuncEvaluator = std::function<double(int, double)>

Member Function Documentation

◆ fromECLOutput()

static std::unique_ptr< VerticalScalingInterface > Opm::SatFunc::CreateEPS::Vertical::fromECLOutput ( const ECLGraph G,
const ECLInitFileData init,
const EPSOptions opt,
const RawTableEndPoints tep,
const FuncValVector fvals 
)
static

Construct a vertical saturation function value scaling from a particular ECL result set.

Parameters
[in]GConnected topology of current model's active cells. Needed to linearise table end-points that may be distributed on local grids to all of the model's active cells (member functions
G.rawLinearisedCellData()
and
G.linearisedCellData()
).
[in]initContainer of tabulated saturation functions and saturation table end points for all active cells.
[in]optOptions that identify a particular end-point scaling behaviour of a particular saturation function curve.
[in]tepTable end-points. Used to define critical saturations of displacing phase for vertical scaling at displacing saturation. Otherwise unused.
[in]fvalsFunction values at selected saturation points. Typically constructed by means of function unscaledFunctionValues().
Returns
Vertical scaling operator for the particular curve defined by the input options.

◆ unscaledFunctionValues()

static std::vector< VerticalScalingInterface::FunctionValues > Opm::SatFunc::CreateEPS::Vertical::unscaledFunctionValues ( const ECLGraph G,
const ECLInitFileData init,
const RawTableEndPoints ep,
const EPSOptions opt,
const SatFuncEvaluator evalSF 
)
static

Extract table end points relevant to a particular vertical scaling evaluator from raw tabulated saturation functions.

Parameters
[in]epCollection of all raw table saturation end points for all tabulated saturation functions. Typically computed by direct calls to the
connateSat()
,
criticalSat()
, and
maximumSat()
of the currently active
Opm::SatFuncInterpolant \code objects.
\param[in] opt Options that identify a particular end-point
scaling behaviour of a particular saturation function
curve.
\return Subset of the input end points in a format intended
for passing as the first argument of member function
\code eval()
char const int const cJSON_bool format
Definition: cJSON.h:161
std::function< double(double, double)> function
Definition: Operate.hpp:28
@ end
Definition: ActionValue.hpp:20
of the
Protocol for computing scaled saturation values.
Definition: ECLEndPointScaling.hpp:41
that corresponds to the input options.

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