Opm::ECLFluxCalc Class Reference

Class for computing connection fluxes in the absence of flux output. More...

#include <ECLFluxCalc.hpp>

Classes
struct	DynamicData

Public Member Functions
	ECLFluxCalc (const ECLGraph &graph, const ECLInitFileData &init, const double grav, const bool useEPS)
std::vector< double >	flux (const ECLRestartData &rstrt, const ECLPhaseIndex phase) const
std::vector< double >	massflux (const ECLRestartData &rstrt, const ECLPhaseIndex phase) const
DynamicData	phaseProperties (const ECLRestartData &rstrt, const ECLPhaseIndex phase) const
double	surfaceDensity (const ECLPhaseIndex phase) const

Detailed Description

Class for computing connection fluxes in the absence of flux output.

Constructor & Destructor Documentation

ECLFluxCalc()

Opm::ECLFluxCalc::ECLFluxCalc	(	const ECLGraph &	graph,
		const ECLInitFileData &	init,
		const double	grav,
		const bool	useEPS
	)

Construct from ECLGraph and Run Initialization Data.

Parameters

[in]	graph	Connectivity data, as well as providing a means to read data from the restart file.
[in]	init	ECLIPSE result set static initialization data ("INIT" file).
[in]	grav	Gravity constant (9.80665 m/s^2 at Tellus equator).
[in]	useEPS	Whether or not to include effects of saturation function end-point scaling if activated in the result set.

Member Function Documentation

flux()

std::vector< double > Opm::ECLFluxCalc::flux	(	const ECLRestartData &	rstrt,
		const ECLPhaseIndex	phase
	)		const

Retrive phase flux on all connections defined by

graph.neighbours() 

.

Parameters

[in]	rstrt	ECL Restart data set from which to extract relevant data per cell.
[in]	phase	Canonical phase for which to retrive flux.

Returns

Flux values corresponding to selected phase. Empty if requisite data is missing. Numerical values in SI units (rm^3/s).

Referenced by example::extractFluxField().

massflux()

std::vector< double > Opm::ECLFluxCalc::massflux	(	const ECLRestartData &	rstrt,
		const ECLPhaseIndex	phase
	)		const

Retrive phase mass flux on all connections defined by

graph.neighbours() 

.

Parameters

[in]	rstrt	ECL Restart data set from which to extract relevant data per cell.
[in]	phase	Canonical phase for which to retrive flux.

Returns

Mass flux values corresponding to selected phase. Empty if requisite data is missing. Numerical values in SI units (kg/s).

phaseProperties()

DynamicData Opm::ECLFluxCalc::phaseProperties	(	const ECLRestartData &	rstrt,
		const ECLPhaseIndex	phase
	)		const

Retrive dynamical properties of a single phase on all cells.

Parameters

[in]	rstrt	ECL Restart data set from which to extract relevant data per cell.
[in]	phase	Canonical phase for which to retrive properties.

Returns

DynamicData struct containing cell-values for phase properties. Numerical values in SI units (kg/s).

surfaceDensity()

double Opm::ECLFluxCalc::surfaceDensity

(

const ECLPhaseIndex

phase

)

const

Retrive the constant surface density of a phase.

Parameters

[in]

phase

Canonical phase for which to retrive the surface density.

Returns

Density of given phase at surface conditions. Numerical value in SI units (kg/m^3).

---

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

• ECLFluxCalc.hpp