A property class for incompressible two-phase flow. More...

#include <ReservoirPropertyCommon.hpp>

Inheritance diagram for Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >:

Public Types
enum	{ NumberOfPhases = 2 }
	The number of phases. More...

typedef ImmutableCMatrix	PermTensor
	Tensor type for read-only access to permeability. More...

typedef OwnCMatrix	MutablePermTensor
	Tensor type to be used for holding copies of permeability tensors. More...

typedef SharedCMatrix	SharedPermTensor
	Tensor type for read and write access to permeability. More...

Public Member Functions
	ReservoirPropertyCommon ()
	Default constructor. More...

void	init (Opm::DeckConstPtr deck, const std::vector< int > &global_cell, const double perm_threshold=0.0, const std::string *rock_list_filename=0, const bool use_jfunction_scaling=true, const double sigma=1.0, const double theta=0.0)
	Initialize from a grdecl file. More...

void	init (const int num_cells, const double uniform_poro=0.2, const double uniform_perm=100.0 Opm::prefix::milli Opm::unit::darcy)
	Initialize a uniform reservoir. More...

void	setViscosities (double v1, double v2)
	Set viscosities of both faces. More...

void	setDensities (double d1, double d2)
	Set densitities of both faces. More...

double	viscosityFirstPhase () const
	Viscosity of first (water) phase. More...

double	viscositySecondPhase () const
	Viscosity of second (oil) phase. More...

double	densityFirstPhase () const
	Density of first (water) phase. More...

double	densitySecondPhase () const
	Density of second (oil) phase. More...

double	porosity (int cell_index) const
	Read-access to porosity. More...

double	ntg (int cell_index) const
	Read-access to ntg. More...

double	swcr (int cell_index) const
	Read-access to swcr. More...

double	sowcr (int cell_index) const
	Read-access to sowcr. More...

PermTensor	permeability (int cell_index) const
	Read-access to permeability. More...

SharedPermTensor	permeabilityModifiable (int cell_index)
	Read- and write-access to permeability. Use with caution. More...

template<class Vector >
void	phaseDensities (int, Vector &density) const
	Densities for both phases. More...

double	densityDifference () const
	Difference of densities. More...

double	cflFactor () const
	A factor useful in cfl computations. More...

double	cflFactorGravity () const
	A factor useful in gravity cfl computations. More...

double	cflFactorCapillary () const
	A factor useful in gravity cfl computations. More...

double	capillaryPressure (int cell_index, double saturation) const
	Capillary pressure. More...

double	capillaryPressureDeriv (int c, double s) const
	Derivative of Capillary pressure. More...

double	s_min (int c) const

double	s_max (int c) const

double	saturationFromCapillaryPressure (int cell_index, double cap_press) const
	Inverse of the capillary pressure function. More...

void	writeSintefLegacyFormat (const std::string &grid_prefix) const
	Write permeability and porosity in the Sintef legacy format. More...

Protected Member Functions
void	assignPorosity (Opm::DeckConstPtr deck, const std::vector< int > &global_cell)

void	assignNTG (Opm::DeckConstPtr deck, const std::vector< int > &global_cell)

void	assignSWCR (Opm::DeckConstPtr deck, const std::vector< int > &global_cell)

void	assignSOWCR (Opm::DeckConstPtr deck, const std::vector< int > &global_cell)

void	assignPermeability (Opm::DeckConstPtr deck, const std::vector< int > &global_cell, const double perm_threshold)

void	assignRockTable (Opm::DeckConstPtr deck, const std::vector< int > &global_cell)

void	readRocks (const std::string &rock_list_file)

RPImpl &	asImpl ()

Protected Attributes
std::vector< double >	porosity_

std::vector< double >	ntg_

std::vector< double >	swcr_

std::vector< double >	sowcr_

std::vector< double >	permeability_

std::vector< unsigned char >	permfield_valid_

double	density1_

double	density2_

double	viscosity1_

double	viscosity2_

double	cfl_factor_

double	cfl_factor_gravity_

double	cfl_factor_capillary_

std::vector< RockType >	rock_

std::vector< int >	cell_to_rock_

PermeabilityKind	permeability_kind_

Detailed Description

template<int dim, class RPImpl, class RockType>
class Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >

A property class for incompressible two-phase flow.

Template Parameters

dim	the dimension of the space, used for giving permeability tensors the right size.

Member Typedef Documentation

◆ MutablePermTensor

template<int dim, class RPImpl , class RockType >

typedef OwnCMatrix Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::MutablePermTensor

Tensor type to be used for holding copies of permeability tensors.

◆ PermTensor

template<int dim, class RPImpl , class RockType >

typedef ImmutableCMatrix Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::PermTensor

Tensor type for read-only access to permeability.

◆ SharedPermTensor

template<int dim, class RPImpl , class RockType >

typedef SharedCMatrix Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::SharedPermTensor

Tensor type for read and write access to permeability.

Member Enumeration Documentation

◆ anonymous enum

template<int dim, class RPImpl , class RockType >

anonymous enum

The number of phases.

Enumerator
NumberOfPhases

Constructor & Destructor Documentation

◆ ReservoirPropertyCommon()

template<int dim, class RPImpl , class RockType >

Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::ReservoirPropertyCommon

Default constructor.

Member Function Documentation

◆ asImpl()

template<int dim, class RPImpl , class RockType >

RPImpl & Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::asImpl

protected

◆ assignNTG()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignNTG	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell
	)

protected

◆ assignPermeability()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignPermeability	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell,
		const double	perm_threshold
	)

protected

References Opm::zero().

◆ assignPorosity()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignPorosity	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell
	)

protected

◆ assignRockTable()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignRockTable	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell
	)

protected

◆ assignSOWCR()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignSOWCR	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell
	)

protected

◆ assignSWCR()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::assignSWCR	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell
	)

protected

◆ capillaryPressure()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::capillaryPressure	(	int	cell_index,
		double	saturation
	)		const

Capillary pressure.

Parameters

cell_index	index of a grid cell.
saturation	a saturation value.

Returns: capillary pressure at the given cell and saturation.

Referenced by Opm::TwophaseFluidWrapper::pc().

◆ capillaryPressureDeriv()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::capillaryPressureDeriv	(	int	c,
		double	s
	)		const

Derivative of Capillary pressure.

Parameters

cell_index	index of a grid cell.
saturation	a saturation value.

Returns: capillary pressure at the given cell and saturation.

Referenced by Opm::TwophaseFluidWrapper::pc().

◆ cflFactor()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cflFactor

A factor useful in cfl computations.

Returns: the cfl factor.

◆ cflFactorCapillary()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cflFactorCapillary

A factor useful in gravity cfl computations.

Returns: the capillary cfl factor.

◆ cflFactorGravity()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cflFactorGravity

A factor useful in gravity cfl computations.

Returns: the gravity cfl factor.

◆ densityDifference()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::densityDifference

Difference of densities.

Returns: densityFirstPhase() - densitySecondPhase()

◆ densityFirstPhase()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::densityFirstPhase

Density of first (water) phase.

Returns: the density value.

Referenced by Opm::TwophaseFluidWrapper::density().

◆ densitySecondPhase()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::densitySecondPhase

Density of second (oil) phase.

Returns: the density value.

Referenced by Opm::TwophaseFluidWrapper::density().

◆ init() [1/2]

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::init	(	const int	num_cells,
		const double	uniform_poro = `0.2`,
		const double	uniform_perm = `100.0Opm::prefix::milliOpm::unit::darcy`
	)

Initialize a uniform reservoir.

Parameters

num_cells	number of cells in the grid.
uniform_poro	the uniform porosity.
uniform_perm	the uniform (scalar) permeability.

◆ init() [2/2]

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::init	(	Opm::DeckConstPtr	deck,
		const std::vector< int > &	global_cell,
		const double	perm_threshold = `0.0`,
		const std::string *	rock_list_filename = `0`,
		const bool	use_jfunction_scaling = `true`,
		const double	sigma = `1.0`,
		const double	theta = `0.0`
	)

Initialize from a grdecl file.

Parameters

deck	the deck holding the grdecl data.
global_cell	the mapping from cell indices to the logical cartesian indices of the grdecl file.
perm_threshold	lower threshold for permeability.
rock_list_filename	if non-null, the referred string gives the filename for the rock list.
use_jfunction_scaling	if true, use j-function scaling of capillary pressure, if applicable.
sigma	interface tension for j-scaling, if applicable.
theta	angle for j-scaling, if applicable.

◆ ntg()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::ntg ( int cell_index ) const

Read-access to ntg.

Parameters

cell_index index of a grid cell.

Returns: ntg value of the cell.

◆ permeability()

template<int dim, class RPImpl , class RockType >

ReservoirPropertyCommon< dim, RPImpl, RockType >::PermTensor Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::permeability ( int cell_index ) const

Read-access to permeability.

Parameters

cell_index index of a grid cell.

Returns: permeability value of the cell.

◆ permeabilityModifiable()

template<int dim, class RPImpl , class RockType >

ReservoirPropertyCommon< dim, RPImpl, RockType >::SharedPermTensor Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::permeabilityModifiable ( int cell_index )

Read- and write-access to permeability. Use with caution.

Parameters

cell_index index of a grid cell.

Returns: permeability value of the cell.

◆ phaseDensities()

template<int dim, class RPImpl , class RockType >

template<class Vector >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::phaseDensities	(	int	,
		Vector &	density
	)		const

Densities for both phases.

Template Parameters

Vector a class with size() and operator[].

Parameters

	cell_index	index of a grid cell (not used).
[out]	density	the phase densities. Expected to be of size 2 before (and after) the call.

◆ porosity()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::porosity ( int cell_index ) const

Read-access to porosity.

Parameters

cell_index index of a grid cell.

Returns: porosity value of the cell.

◆ readRocks()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::readRocks ( const std::string & rock_list_file )

protected

◆ s_max()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::s_max ( int c ) const

Parameters

cell_index index of a grid cell.

Returns: maximum saturation in given cell.

Referenced by Opm::TwophaseFluidWrapper::s_max().

◆ s_min()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::s_min ( int c ) const

Parameters

cell_index index of a grid cell.

Returns: minimum saturation in given cell.

Referenced by Opm::TwophaseFluidWrapper::s_min().

◆ saturationFromCapillaryPressure()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::saturationFromCapillaryPressure	(	int	cell_index,
		double	cap_press
	)		const

Inverse of the capillary pressure function.

Parameters

cell_index	index of a grid cell.
cap_press	a capillary pressure value.

Returns: the saturation at the given cell has the given capillary pressure.

◆ setDensities()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::setDensities	(	double	d1,
		double	d2
	)

Set densitities of both faces.

Parameters

d1	the densitity of the first (water) phase.
d2	the densitity of the second (oil) phase.

◆ setViscosities()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::setViscosities	(	double	v1,
		double	v2
	)

Set viscosities of both faces.

Parameters

v1	the viscosity of the first (water) phase.
v2	the viscosity of the second (oil) phase.

◆ sowcr()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::sowcr ( int cell_index ) const

Read-access to sowcr.

Parameters

cell_index index of a grid cell.

Returns: sowcr value of the cell.

◆ swcr()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::swcr ( int cell_index ) const

Read-access to swcr.

Parameters

cell_index index of a grid cell.

Returns: swcr value of the cell.

◆ viscosityFirstPhase()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::viscosityFirstPhase

Viscosity of first (water) phase.

Returns: the viscosity value.

◆ viscositySecondPhase()

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::viscositySecondPhase

Viscosity of second (oil) phase.

Returns: the viscosity value.

◆ writeSintefLegacyFormat()

template<int dim, class RPImpl , class RockType >

void Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::writeSintefLegacyFormat ( const std::string & grid_prefix ) const

Write permeability and porosity in the Sintef legacy format.

Parameters

grid_prefix the prefix of all files output by this function.

References Opm::DiagonalPerm, Opm::None, Opm::ScalarPerm, and Opm::TensorPerm.

Member Data Documentation

◆ cell_to_rock_

template<int dim, class RPImpl , class RockType >

std::vector<int> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cell_to_rock_

protected

◆ cfl_factor_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cfl_factor_

protected

◆ cfl_factor_capillary_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cfl_factor_capillary_

protected

◆ cfl_factor_gravity_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::cfl_factor_gravity_

protected

◆ density1_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::density1_

protected

◆ density2_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::density2_

protected

◆ ntg_

template<int dim, class RPImpl , class RockType >

std::vector<double> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::ntg_

protected

◆ permeability_

template<int dim, class RPImpl , class RockType >

std::vector<double> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::permeability_

protected

◆ permeability_kind_

template<int dim, class RPImpl , class RockType >

PermeabilityKind Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::permeability_kind_

protected

◆ permfield_valid_

template<int dim, class RPImpl , class RockType >

std::vector<unsigned char> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::permfield_valid_

protected

◆ porosity_

template<int dim, class RPImpl , class RockType >

std::vector<double> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::porosity_

protected

◆ rock_

template<int dim, class RPImpl , class RockType >

std::vector<RockType> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::rock_

protected

◆ sowcr_

template<int dim, class RPImpl , class RockType >

std::vector<double> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::sowcr_

protected

◆ swcr_

template<int dim, class RPImpl , class RockType >

std::vector<double> Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::swcr_

protected

◆ viscosity1_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::viscosity1_

protected

◆ viscosity2_

template<int dim, class RPImpl , class RockType >

double Opm::ReservoirPropertyCommon< dim, RPImpl, RockType >::viscosity2_

protected

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MutablePermTensor

◆ PermTensor

◆ SharedPermTensor

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ReservoirPropertyCommon()

Member Function Documentation

◆ asImpl()

◆ assignNTG()

◆ assignPermeability()

◆ assignPorosity()

◆ assignRockTable()

◆ assignSOWCR()

◆ assignSWCR()

◆ capillaryPressure()

◆ capillaryPressureDeriv()

◆ cflFactor()

◆ cflFactorCapillary()

◆ cflFactorGravity()

◆ densityDifference()

◆ densityFirstPhase()

◆ densitySecondPhase()

◆ init() [1/2]

◆ init() [2/2]

◆ ntg()

◆ permeability()

◆ permeabilityModifiable()

◆ phaseDensities()

◆ porosity()

◆ readRocks()

◆ s_max()

◆ s_min()

◆ saturationFromCapillaryPressure()

◆ setDensities()

◆ setViscosities()

◆ sowcr()

◆ swcr()

◆ viscosityFirstPhase()

◆ viscositySecondPhase()

◆ writeSintefLegacyFormat()

Member Data Documentation

◆ cell_to_rock_

◆ cfl_factor_

◆ cfl_factor_capillary_

◆ cfl_factor_gravity_

◆ density1_

◆ density2_

◆ ntg_

◆ permeability_

◆ permeability_kind_

◆ permfield_valid_

◆ porosity_

◆ rock_

◆ sowcr_

◆ swcr_

◆ viscosity1_

◆ viscosity2_