Contains the high level supplements required to extend the black oil model by polymer. More...

#include <blackoilpolymermodules.hh>

Public Member Functions
const Scalar	molarMass () const

Static Public Member Functions
static TabulatedTwoDFunction &	getPlymwinjTable (const int tableNumber)
	get the PLYMWINJ table More...

static TabulatedTwoDFunction &	getSkprwatTable (const int tableNumber)
	get the SKPRWAT table More...

static BlackOilPolymerParams< Scalar >::SkprpolyTable &	getSkprpolyTable (const int tableNumber)
	get the SKPRPOLY table More...

static void	registerParameters ()
	Register all run-time parameters for the black-oil polymer module. More...

static void	registerOutputModules (Model &model, Simulator &simulator)
	Register all polymer specific VTK and ECL output modules. More...

static bool	primaryVarApplies (unsigned pvIdx)

static std::string	primaryVarName (unsigned pvIdx)

static Scalar	primaryVarWeight (unsigned pvIdx)

static bool	eqApplies (unsigned eqIdx)

static std::string	eqName (unsigned eqIdx)

static Scalar	eqWeight (unsigned eqIdx)

template<class LhsEval >
static void	addStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)

static void	computeFlux (RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)

static Scalar	computeUpdateError (const PrimaryVariables &, const EqVector &)
	Return how much a Newton-Raphson update is considered an error. More...

template<class DofEntity >
static void	serializeEntity (const Model &model, std::ostream &outstream, const DofEntity &dof)

template<class DofEntity >
static void	deserializeEntity (Model &model, std::istream &instream, const DofEntity &dof)

static const Scalar	plyrockDeadPoreVolume (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const Scalar	plyrockResidualResistanceFactor (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const Scalar	plyrockRockDensityFactor (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const Scalar	plyrockAdsorbtionIndex (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const Scalar	plyrockMaxAdsorbtion (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const TabulatedFunction &	plyadsAdsorbedPolymer (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const TabulatedFunction &	plyviscViscosityMultiplierTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const TabulatedFunction &	plyviscViscosityMultiplierTable (unsigned pvtnumRegionIdx)

static const Scalar	plymaxMaxConcentration (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const Scalar	plymixparToddLongstaff (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)

static const BlackOilPolymerParams< Scalar >::PlyvmhCoefficients &	plyvmhCoefficients (const ElementContext &elemCtx, const unsigned scvIdx, const unsigned timeIdx)

static bool	hasPlyshlog ()

static bool	hasShrate ()

static const Scalar	shrate (unsigned pvtnumRegionIdx)

template<class Evaluation >
static Evaluation	computeShearFactor (const Evaluation &polymerConcentration, unsigned pvtnumRegionIdx, const Evaluation &v0)
	Computes the shear factor. More...

Detailed Description

template<class TypeTag, bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>
class Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >

Contains the high level supplements required to extend the black oil model by polymer.

Member Function Documentation

◆ addStorage()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

template<class LhsEval >

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::addStorage	(	Dune::FieldVector< LhsEval, numEq > &	storage,
		const IntensiveQuantities &	intQuants
	)

inlinestatic

Referenced by Opm::BlackOilLocalResidual< TypeTag >::computeStorage(), and Opm::BlackOilLocalResidualTPFA< TypeTag >::computeStorage().

◆ computeFlux()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::computeFlux	(	RateVector &	flux,
		const ElementContext &	elemCtx,
		unsigned	scvfIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilLocalResidual< TypeTag >::computeFlux().

◆ computeShearFactor()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

template<class Evaluation >

static Evaluation Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::computeShearFactor	(	const Evaluation &	polymerConcentration,
		unsigned	pvtnumRegionIdx,
		const Evaluation &	v0
	)

inlinestatic

Computes the shear factor.

Input is polymer concentration and either the water velocity or the shrate if hasShrate_ is true. The pvtnumRegionIdx is needed to make sure the right table is used.

Referenced by Opm::BlackOilPolymerExtensiveQuantities< TypeTag, enablePolymerV >::updateShearMultipliers().

◆ computeUpdateError()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::computeUpdateError	(	const PrimaryVariables &	,
		const EqVector &
	)

inlinestatic

Return how much a Newton-Raphson update is considered an error.

◆ deserializeEntity()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

template<class DofEntity >

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::deserializeEntity	(	Model &	model,
		std::istream &	instream,
		const DofEntity &	dof
	)

inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::deserializeEntity().

◆ eqApplies()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static bool Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqApplies ( unsigned eqIdx )

inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::eqName(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqName(), and Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqWeight().

◆ eqName()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static std::string Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqName ( unsigned eqIdx )

inlinestatic

References Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqApplies().

Referenced by Opm::BlackOilModel< TypeTag >::eqName().

◆ eqWeight()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqWeight ( unsigned eqIdx )

inlinestatic

References Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqApplies().

◆ getPlymwinjTable()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static TabulatedTwoDFunction & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::getPlymwinjTable ( const int tableNumber )

inlinestatic

get the PLYMWINJ table

◆ getSkprpolyTable()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static BlackOilPolymerParams< Scalar >::SkprpolyTable & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::getSkprpolyTable ( const int tableNumber )

inlinestatic

get the SKPRPOLY table

◆ getSkprwatTable()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static TabulatedTwoDFunction & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::getSkprwatTable ( const int tableNumber )

inlinestatic

get the SKPRWAT table

◆ hasPlyshlog()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static bool Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::hasPlyshlog ( )

inlinestatic

Referenced by Opm::BlackOilPolymerExtensiveQuantities< TypeTag, enablePolymerV >::updateShearMultipliers().

◆ hasShrate()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static bool Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::hasShrate ( )

inlinestatic

Referenced by Opm::BlackOilPolymerExtensiveQuantities< TypeTag, enablePolymerV >::updateShearMultipliers().

◆ molarMass()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::molarMass ( ) const

inline

Referenced by Opm::BlackOilRateVector< TypeTag >::setMolarRate().

◆ plyadsAdsorbedPolymer()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const TabulatedFunction & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyadsAdsorbedPolymer	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plymaxMaxConcentration()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plymaxMaxConcentration	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plymixparToddLongstaff()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plymixparToddLongstaff	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyrockAdsorbtionIndex()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyrockAdsorbtionIndex	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyrockDeadPoreVolume()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyrockDeadPoreVolume	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyrockMaxAdsorbtion()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyrockMaxAdsorbtion	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyrockResidualResistanceFactor()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyrockResidualResistanceFactor	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyrockRockDensityFactor()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyrockRockDensityFactor	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyviscViscosityMultiplierTable() [1/2]

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const TabulatedFunction & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyviscViscosityMultiplierTable	(	const ElementContext &	elemCtx,
		unsigned	scvIdx,
		unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ plyviscViscosityMultiplierTable() [2/2]

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const TabulatedFunction & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyviscViscosityMultiplierTable ( unsigned pvtnumRegionIdx )

inlinestatic

◆ plyvmhCoefficients()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const BlackOilPolymerParams< Scalar >::PlyvmhCoefficients & Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::plyvmhCoefficients	(	const ElementContext &	elemCtx,
		const unsigned	scvIdx,
		const unsigned	timeIdx
	)

inlinestatic

Referenced by Opm::BlackOilPolymerIntensiveQuantities< TypeTag, enablePolymerV >::polymerPropertiesUpdate_().

◆ primaryVarApplies()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static bool Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarApplies ( unsigned pvIdx )

inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::primaryVarName(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarName(), Opm::BlackOilModel< TypeTag >::primaryVarWeight(), and Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarWeight().

◆ primaryVarName()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static std::string Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarName ( unsigned pvIdx )

inlinestatic

References Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarApplies().

Referenced by Opm::BlackOilModel< TypeTag >::primaryVarName().

◆ primaryVarWeight()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarWeight ( unsigned pvIdx )

inlinestatic

References Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarApplies().

Referenced by Opm::BlackOilModel< TypeTag >::primaryVarWeight().

◆ registerOutputModules()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::registerOutputModules	(	Model &	model,
		Simulator &	simulator
	)

inlinestatic

Register all polymer specific VTK and ECL output modules.

Referenced by Opm::BlackOilModel< TypeTag >::registerOutputModules_().

◆ registerParameters()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::registerParameters ( )

inlinestatic

Register all run-time parameters for the black-oil polymer module.

Referenced by Opm::BlackOilModel< TypeTag >::registerParameters().

◆ serializeEntity()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

template<class DofEntity >

static void Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::serializeEntity	(	const Model &	model,
		std::ostream &	outstream,
		const DofEntity &	dof
	)

inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::serializeEntity().

◆ shrate()

template<class TypeTag , bool enablePolymerV = getPropValue<TypeTag, Properties::EnablePolymer>()>

static const Scalar Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::shrate ( unsigned pvtnumRegionIdx )

inlinestatic

Referenced by Opm::BlackOilPolymerExtensiveQuantities< TypeTag, enablePolymerV >::updateShearMultipliers().

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

blackoilpolymermodules.hh

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addStorage()

◆ computeFlux()

◆ computeShearFactor()

◆ computeUpdateError()

◆ deserializeEntity()

◆ eqApplies()

◆ eqName()

◆ eqWeight()

◆ getPlymwinjTable()

◆ getSkprpolyTable()

◆ getSkprwatTable()

◆ hasPlyshlog()

◆ hasShrate()

◆ molarMass()

◆ plyadsAdsorbedPolymer()

◆ plymaxMaxConcentration()

◆ plymixparToddLongstaff()

◆ plyrockAdsorbtionIndex()

◆ plyrockDeadPoreVolume()

◆ plyrockMaxAdsorbtion()

◆ plyrockResidualResistanceFactor()

◆ plyrockRockDensityFactor()

◆ plyviscViscosityMultiplierTable() [1/2]

◆ plyviscViscosityMultiplierTable() [2/2]

◆ plyvmhCoefficients()

◆ primaryVarApplies()

◆ primaryVarName()

◆ primaryVarWeight()

◆ registerOutputModules()

◆ registerParameters()

◆ serializeEntity()

◆ shrate()