OPM - Reference Documentation for opm-material

Here is a list of all files with brief descriptions:

Air.hpp	A simple class implementing the fluid properties of air.
Air_Mesitylene.hpp	Binary coefficients for water and mesitylene.
Air_Xylene.hpp	Binary coefficients for water and xylene.
BaseFluidSystem.hpp	The base class for all fluid systems.
BlackOilFluidSystem.hpp	A fluid system which uses the black-oil parameters to calculate termodynamically meaningful quantities.
Brine.hpp	A class for the brine fluid properties.
Brine_CO2.hpp	Binary coefficients for brine and CO2.
BrineCO2FluidSystem.hpp	A two-phase fluid system with water and CO2.
BrooksCorey.hpp	Implementation of the Brooks-Corey capillary pressure <-> saturation relation.
BrooksCoreyParams.hpp	Specification of the material parameters for the Brooks-Corey constitutive relations.
ClassName.hpp	A free function to provide the demangled class name of a given object or type as a string
CO2.hpp	A class for the CO2 fluid properties.
Common.hpp	Implements relations which are common for all regions of the IAPWS '97 formulation.
Component.hpp	Abstract base class of a pure chemical species.
CompositionalFluidState.hpp	Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium
CompositionFromFugacities.hpp	Calculates the chemical equilibrium from the component fugacities in a phase.
ComputeFromReferencePhase.hpp	Computes all quantities of a generic fluid state if a reference phase has been specified.
ConstantCompressibilityOilPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the oil phase without dissolved gas and constant compressibility/"viscosibility".
ConstantCompressibilityWaterPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the gas phase without vaporized oil.
Constants.hpp	A central place for various physical constants occuring in some equations.
DeadOilPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the oil phase without dissolved gas.
Dnapl.hpp	A simple implementation of a dense non-aqueous phase liquid (DNAPL).
DryGasPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the gas phase without vaporized oil.
DummyHeatConductionLaw.hpp	Implements a dummy law for heat conduction to which isothermal models can fall back to.
EclDefaultMaterial.hpp	Implements the default three phase capillary pressure law used by the ECLipse simulator.
EclDefaultMaterialParams.hpp	Default implementation for the parameters required by the default three-phase capillary pressure model used by Eclipse.
EclEpsConfig.hpp	Specifies the configuration used by the endpoint scaling code.
EclEpsScalingPoints.hpp
EclEpsTwoPhaseLaw.hpp	This material law takes a material law defined for unscaled saturation and converts it to a material law defined on scaled saturations.
EclEpsTwoPhaseLawParams.hpp	A default implementation of the parameters for the material law adapter class which implements ECL endpoint scaleing .
EclHysteresisConfig.hpp	Specifies the configuration used by the ECL kr/pC hysteresis code.
EclHysteresisTwoPhaseLaw.hpp	This material law implements the hysteresis model of the ECL file format.
EclHysteresisTwoPhaseLawParams.hpp	A default implementation of the parameters for the material law which implements the ECL relative permeability and capillary pressure hysteresis.
EclMaterialLawManager.hpp	Provides an simple way to create and manage the material law objects for a complete ECL deck.
EclMultiplexerMaterial.hpp	Implements a multiplexer class that provides all three phase capillary pressure laws used by the ECLipse simulator.
EclMultiplexerMaterialParams.hpp	Multiplexer implementation for the parameters required by the multiplexed three-phase material law.
EclStone1Material.hpp	Implements the second phase capillary pressure/relperm law suggested by Stone as used by the ECLipse simulator.
EclStone1MaterialParams.hpp	Default implementation for the parameters required by the three-phase capillary pressure/relperm Stone 2 model used by Eclipse.
EclStone2Material.hpp	Implements the second phase capillary pressure/relperm law suggested by Stone as used by the ECLipse simulator.
EclStone2MaterialParams.hpp	Default implementation for the parameters required by the three-phase capillary pressure/relperm Stone 2 model used by Eclipse.
EclTwoPhaseMaterial.hpp	Implements a multiplexer class that provides ECL saturation functions for twophase simulations.
EclTwoPhaseMaterialParams.hpp	Implementation for the parameters required by the material law for two-phase simulations.
EffToAbsLaw.hpp	This material law takes a material law defined for effective saturations and converts it to a material law defined on absolute saturations.
EffToAbsLawParams.hpp	A default implementation of the parameters for the adapter class to convert material laws from effective to absolute saturations.
Evaluation.hpp	Representation of an evaluation of a function and its derivatives w.r.t. a set of variables in the localized OPM automatic differentiation (AD) framework
FluidConduction.hpp	Implements a heat conduction law which just takes the conductivity of a given fluid phase.
FluidConductionParams.hpp	Parameters for the heat conduction law which just takes the conductivity of a given fluid phase.
FluidStateCompositionModules.hpp	Modules for the ModularFluidState which represent composition
FluidStateDensityModules.hpp	Modules for the ModularFluidState which represent density
FluidStateEnthalpyModules.hpp	Modules for the ModularFluidState which represent enthalpy
FluidStateFugacityModules.hpp	Modules for the ModularFluidState which represent fugacity/chemical potential
FluidStatePressureModules.hpp	Modules for the ModularFluidState which represent pressure
FluidStateSaturationModules.hpp	Modules for the ModularFluidState which represent saturation
FluidStateTemperatureModules.hpp	Modules for the ModularFluidState which represent temperature
FluidStateViscosityModules.hpp	Modules for the ModularFluidState which represent viscosity
FullerMethod.hpp	Estimate binary diffusion coefficents $\mathrm{[m^2/s]}$ in gases according to the method by Fuller.
GasPhase.hpp	Represents the gas phase of a single (pseudo-) component.
GasPvtMultiplexer.hpp	This class represents the Pressure-Volume-Temperature relations of the oil phase in the black-oil model.
H2O.hpp	Material properties of pure water .
H2O_Air.hpp	Binary coefficients for water and nitrogen.
H2O_CO2.hpp	Binary coefficients for water and CO2.
H2O_Mesitylene.hpp	Binary coefficients for water and mesitylene.
H2O_N2.hpp	Binary coefficients for water and nitrogen.
H2O_Xylene.hpp	Binary coefficients for water and xylene.
H2OAirFluidSystem.hpp	A fluid system with a liquid and a gaseous phase and water and air as components.
H2OAirMesityleneFluidSystem.hpp	A fluid system with water, gas and NAPL as phases and water, air and mesitylene (DNAPL) as components.
H2OAirXyleneFluidSystem.hpp	A fluid system with water, gas and NAPL as phases and water, air and NAPL (contaminant) as components.
H2ON2FluidSystem.hpp	A two-phase fluid system with water and nitrogen as components.
H2ON2LiquidPhaseFluidSystem.hpp	A liquid-phase-only fluid system with water and nitrogen as components.
HenryIapws.hpp	The IAPWS formulation of Henry coefficients in water
IdealGas.hpp	Relations valid for an ideal gas.
ImmiscibleFlash.hpp	Determines the pressures and saturations of all fluid phases given the total mass of all components.
ImmiscibleFluidState.hpp	Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium
LinearMaterial.hpp	Implements a linear saturation-capillary pressure relation.
LinearMaterialParams.hpp	Reference implementation of params for the linear M-phase material material.
LiquidPhase.hpp	Represents the liquid phase of a single (pseudo-) component.
LiveOilPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the oil phas with dissolved gas.
Lnapl.hpp	A simple implementation of a LNAPL, e.g. a kind of oil.
MaterialTraits.hpp	This file contains helper classes for the material laws
Math.hpp	A number of commonly used algebraic functions for the localized OPM automatic differentiation (AD) framework
MathToolbox.hpp	A traits class which provides basic mathematical functions for arbitrary scalar floating point values
Means.hpp	Implements some common averages
Mesitylene.hpp	Component for Mesitylene.
MiscibleMultiPhaseComposition.hpp	Computes the composition of all phases of a N-phase, N-component fluid system assuming that all N phases are present.
ModularFluidState.hpp	Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium.
N2.hpp	Properties of pure molecular nitrogen .
NcpFlash.hpp	Determines the phase compositions, pressures and saturations given the total mass of all components.
NonEquilibriumFluidState.hpp	Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system not assuming thermodynamic equilibrium
NullComponent.hpp	A component that only throws exceptions.
NullMaterial.hpp	Implements a dummy linear saturation-capillary pressure relation which just disables capillary pressure.
NullMaterialParams.hpp	Reference implementation of params for the linear M-phase material material.
NullParameterCache.hpp	A parameter cache which does nothing.
OilPvtMultiplexer.hpp	This class represents the Pressure-Volume-Temperature relations of the oil phase in the black-oil model.
OpmFinal.hpp	This file provides a wrapper around the "final" C++-2011 statement
ParameterCacheBase.hpp	The base class of the parameter caches of fluid systems.
ParkerLenhard.hpp	Implements the Parker-Lenhard twophase p_c-Sw hysteresis model. This class adheres to the twophase capillary pressure API.
ParkerLenhardParams.hpp	Default parameter class for the Parker-Lenhard hysteresis model.
PengRobinson.hpp	Implements the Peng-Robinson equation of state for liquids and gases.
PengRobinsonMixture.hpp	Implements the Peng-Robinson equation of state for a mixture.
PengRobinsonParams.hpp	Stores and provides access to the Peng-Robinson parameters.
PengRobinsonParamsMixture.hpp	The mixing rule for the oil and the gas phases of the SPE5 problem.
PiecewiseLinearTwoPhaseMaterial.hpp	Implementation of a tabulated, piecewise linear capillary pressure law.
PiecewiseLinearTwoPhaseMaterialParams.hpp	Specification of the material parameters for a two-phase material law which uses a table and piecewise constant interpolation.
PolynomialUtils.hpp	Provides free functions to invert polynomials of degree 1, 2 and 3
PressureOverlayFluidState.hpp	This is a fluid state which allows to set the fluid pressures and takes all other quantities from an other fluid state.
Region1.hpp	Implements the equations for region 1 of the IAPWS '97 formulation.
Region2.hpp	Implements the equations for region 2 of the IAPWS '97 formulation.
Region4.hpp	Implements the equations for region 4 of the IAPWS '97 formulation.
RegularizedBrooksCorey.hpp	Implementation of the regularized Brooks-Corey capillary pressure / relative permeability <-> saturation relation.
RegularizedBrooksCoreyParams.hpp	Parameters that are necessary for the regularization of the Brooks-Corey capillary pressure model.
RegularizedVanGenuchten.hpp	Implementation of the regularized van Genuchten's capillary pressure / relative permeability <-> saturation relation.
RegularizedVanGenuchtenParams.hpp	Parameters that are necessary for the regularization of VanGenuchten "material law".
SaturationOverlayFluidState.hpp	This is a fluid state which allows to set the fluid saturations and takes all other quantities from an other fluid state.
SimpleCO2.hpp	A simplistic class representing the fluid properties.
SimpleH2O.hpp	A simple version of pure water.
SimpleModularFluidState.hpp	Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium.
SinglePhaseFluidSystem.hpp	A fluid system for single phase models.
Somerton.hpp	Implements the Somerton law of heat conductivity in a porous medium.
SomertonParams.hpp	The default implementation of a parameter object for the Somerton heatconduction law.
Spe5FluidSystem.hpp	The fluid system for the oil, gas and water phases of the SPE5 problem.
Spe5ParameterCache.hpp	Specifies the parameter cache used by the SPE-5 fluid system.
Spline.hpp	Class implementing cubic splines.
SplineTwoPhaseMaterial.hpp	Implementation of a tabulated capillary pressure and relperm law which uses spline curves as interpolation functions.
SplineTwoPhaseMaterialParams.hpp	Specification of the material parameters for a two-phase material law which uses a table and spline-based interpolation.
Tabulated1DFunction.hpp	Implements a linearly interpolated scalar function that depends on one variable.
TabulatedComponent.hpp	A generic class which tabulates all thermodynamic properties of a given component.
TemperatureOverlayFluidState.hpp	This is a fluid state which allows to set the fluid temperatures and takes all other quantities from an other fluid state.
ThreePhaseParkerVanGenuchten.hpp	Implementation of three-phase capillary pressure and relative permeability relations proposed by Parker and van Genuchten.
ThreePhaseParkerVanGenuchtenParams.hpp	Specification of the material params for the three-phase van Genuchten capillary pressure model.
TridiagonalMatrix.hpp	Provides a tridiagonal matrix that also supports non-zero entries in the upper right and lower left.
TwoPhaseImmiscibleFluidSystem.hpp	A fluid system for two-phase models assuming immiscibility and thermodynamic equilibrium.
UniformTabulated2DFunction.hpp	Implements a scalar function that depends on two variables and which is sampled on an uniform X-Y grid.
UniformXTabulated2DFunction.hpp	Implements a scalar function that depends on two variables and which is sampled uniformly in the X direction, but non-uniformly on the Y axis-.
Unit.hpp	A component where all quantities are fixed at 1.0.
Unused.hpp	Provides the OPM_UNUSED macro
Valgrind.hpp	Some templates to wrap the valgrind client request macros
VanGenuchten.hpp	Implementation of the van Genuchten capillary pressure - saturation relation.
VanGenuchtenParams.hpp	Specification of the material parameters for the van Genuchten constitutive relations.
WaterPvtMultiplexer.hpp	This class represents the Pressure-Volume-Temperature relations of the water phase in the black-oil model.
WetGasPvt.hpp	This class represents the Pressure-Volume-Temperature relations of the gas phas with vaporized oil.
Xylene.hpp	Component for Xylene.