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

#include <ReservoirPropertyCapillaryAnisotropicRelperm.hpp>

Inheritance diagram for Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >:

Public Types
typedef TensorMobility< dim >	Mobility
	The (tensorial) mobility type. More...

enum
	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
template<class MatrixType >
void	phaseMobility (int phase_index, int cell_index, double saturation, MatrixType &phase_mob) const
	Anisotropic phase mobility. More...

double	fractionalFlow (int cell_index, double saturation) const
	Some approximation to a scalar fractional flow (of the first phase). More...

void	computeCflFactors ()

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...

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)

ReservoirPropertyCapillaryAnisotropicRelperm< dim > &	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< RockAnisotropicRelperm >	rock_

std::vector< int >	cell_to_rock_

PermeabilityKind	permeability_kind_

Detailed Description

template<int dim>
class Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >

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

◆ Mobility

template<int dim>

typedef TensorMobility<dim> Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >::Mobility

The (tensorial) mobility type.

◆ MutablePermTensor

typedef OwnCMatrix Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::MutablePermTensor

inherited

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

◆ PermTensor

typedef ImmutableCMatrix Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::PermTensor

inherited

Tensor type for read-only access to permeability.

◆ SharedPermTensor

typedef SharedCMatrix Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::SharedPermTensor

inherited

Tensor type for read and write access to permeability.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

The number of phases.

Member Function Documentation

◆ asImpl()

ReservoirPropertyCapillaryAnisotropicRelperm< dim > & Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::asImpl

protectedinherited

◆ assignNTG()

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

protectedinherited

◆ assignPermeability()

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

protectedinherited

◆ assignPorosity()

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

protectedinherited

◆ assignRockTable()

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

protectedinherited

◆ assignSOWCR()

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

protectedinherited

◆ assignSWCR()

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

protectedinherited

◆ capillaryPressure()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::capillaryPressure	(	int	cell_index,
		double	saturation
	)		const

inherited

Capillary pressure.

Parameters

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

Returns: capillary pressure at the given cell and saturation.

◆ capillaryPressureDeriv()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::capillaryPressureDeriv	(	int	c,
		double	s
	)		const

inherited

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.

◆ cflFactor()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cflFactor

inherited

A factor useful in cfl computations.

Returns: the cfl factor.

◆ cflFactorCapillary()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cflFactorCapillary

inherited

A factor useful in gravity cfl computations.

Returns: the capillary cfl factor.

◆ cflFactorGravity()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cflFactorGravity

inherited

A factor useful in gravity cfl computations.

Returns: the gravity cfl factor.

◆ computeCflFactors()

template<int dim>

void Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >::computeCflFactors

◆ densityDifference()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::densityDifference

inherited

Difference of densities.

Returns: densityFirstPhase() - densitySecondPhase()

◆ densityFirstPhase()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::densityFirstPhase

inherited

Density of first (water) phase.

Returns: the density value.

◆ densitySecondPhase()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::densitySecondPhase

inherited

Density of second (oil) phase.

Returns: the density value.

◆ fractionalFlow()

template<int dim>

double Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >::fractionalFlow	(	int	cell_index,
		double	saturation
	)		const

Some approximation to a scalar fractional flow (of the first phase).

Parameters

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

Returns: fractional flow value at the given cell and saturation.

References Opm::TensorMobility< dim >::mob.

◆ init() [1/2]

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

inherited

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]

void Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::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`
	)

inherited

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()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::ntg ( int cell_index ) const

inherited

Read-access to ntg.

Parameters

cell_index index of a grid cell.

Returns: ntg value of the cell.

◆ permeability()

ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::PermTensor Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::permeability ( int cell_index ) const

inherited

Read-access to permeability.

Parameters

cell_index index of a grid cell.

Returns: permeability value of the cell.

◆ permeabilityModifiable()

ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::SharedPermTensor Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::permeabilityModifiable ( int cell_index )

inherited

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

Parameters

cell_index index of a grid cell.

Returns: permeability value of the cell.

◆ phaseDensities()

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

inherited

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.

◆ phaseMobility()

template<int dim>

template<class MatrixType >

void Opm::ReservoirPropertyCapillaryAnisotropicRelperm< dim >::phaseMobility	(	int	phase_index,
		int	cell_index,
		double	saturation,
		MatrixType &	phase_mob
	)		const

Anisotropic phase mobility.

Parameters

	phase_index	phase for which to compute mobility.
	cell_index	index of a grid cell.
	saturation	a saturation value.
[out]	phase_mob	anisotropic phase mobility tensor at the given cell and saturation.

◆ porosity()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::porosity ( int cell_index ) const

inherited

Read-access to porosity.

Parameters

cell_index index of a grid cell.

Returns: porosity value of the cell.

◆ readRocks()

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

protectedinherited

◆ s_max()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::s_max ( int c ) const

inherited

Parameters

cell_index index of a grid cell.

Returns: maximum saturation in given cell.

◆ s_min()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::s_min ( int c ) const

inherited

Parameters

cell_index index of a grid cell.

Returns: minimum saturation in given cell.

◆ saturationFromCapillaryPressure()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::saturationFromCapillaryPressure	(	int	cell_index,
		double	cap_press
	)		const

inherited

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()

void Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::setDensities	(	double	d1,
		double	d2
	)

inherited

Set densitities of both faces.

Parameters

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

◆ setViscosities()

void Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::setViscosities	(	double	v1,
		double	v2
	)

inherited

Set viscosities of both faces.

Parameters

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

◆ sowcr()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::sowcr ( int cell_index ) const

inherited

Read-access to sowcr.

Parameters

cell_index index of a grid cell.

Returns: sowcr value of the cell.

◆ swcr()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::swcr ( int cell_index ) const

inherited

Read-access to swcr.

Parameters

cell_index index of a grid cell.

Returns: swcr value of the cell.

◆ viscosityFirstPhase()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::viscosityFirstPhase

inherited

Viscosity of first (water) phase.

Returns: the viscosity value.

◆ viscositySecondPhase()

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::viscositySecondPhase

inherited

Viscosity of second (oil) phase.

Returns: the viscosity value.

◆ writeSintefLegacyFormat()

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

inherited

Write permeability and porosity in the Sintef legacy format.

Parameters

grid_prefix the prefix of all files output by this function.

Member Data Documentation

◆ cell_to_rock_

std::vector<int> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cell_to_rock_

protectedinherited

◆ cfl_factor_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cfl_factor_

protectedinherited

◆ cfl_factor_capillary_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cfl_factor_capillary_

protectedinherited

◆ cfl_factor_gravity_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::cfl_factor_gravity_

protectedinherited

◆ density1_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::density1_

protectedinherited

◆ density2_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::density2_

protectedinherited

◆ ntg_

std::vector<double> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::ntg_

protectedinherited

◆ permeability_

std::vector<double> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::permeability_

protectedinherited

◆ permeability_kind_

PermeabilityKind Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::permeability_kind_

protectedinherited

◆ permfield_valid_

std::vector<unsigned char> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::permfield_valid_

protectedinherited

◆ porosity_

std::vector<double> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::porosity_

protectedinherited

◆ rock_

std::vector<RockAnisotropicRelperm > Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::rock_

protectedinherited

◆ sowcr_

std::vector<double> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::sowcr_

protectedinherited

◆ swcr_

std::vector<double> Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::swcr_

protectedinherited

◆ viscosity1_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::viscosity1_

protectedinherited

◆ viscosity2_

double Opm::ReservoirPropertyCommon< dim, ReservoirPropertyCapillaryAnisotropicRelperm< dim > , RockAnisotropicRelperm >::viscosity2_

protectedinherited

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

◆ Mobility

◆ MutablePermTensor

◆ PermTensor

◆ SharedPermTensor

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ asImpl()

◆ assignNTG()

◆ assignPermeability()

◆ assignPorosity()

◆ assignRockTable()

◆ assignSOWCR()

◆ assignSWCR()

◆ capillaryPressure()

◆ capillaryPressureDeriv()

◆ cflFactor()

◆ cflFactorCapillary()

◆ cflFactorGravity()

◆ computeCflFactors()

◆ densityDifference()

◆ densityFirstPhase()

◆ densitySecondPhase()

◆ fractionalFlow()

◆ init() [1/2]

◆ init() [2/2]

◆ ntg()

◆ permeability()

◆ permeabilityModifiable()

◆ phaseDensities()

◆ phaseMobility()

◆ 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_