File List
Here is a list of all documented files with brief descriptions:
[detail level 12345]
| ▼ opm | |
| ▼ material | |
| ► binarycoefficients | |
| Air_Mesitylene.hpp | Binary coefficients for water and mesitylene. |
| Air_Xylene.hpp | Binary coefficients for water and xylene. |
| Brine_CO2.hpp | Binary coefficients for brine and CO2. |
| FullerMethod.hpp | |
| 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. |
| HenryIapws.hpp | The IAPWS formulation of Henry coefficients in water |
| ► common | |
| ConditionalStorage.hpp | A simple class which only stores a given member attribute if a boolean condition is true. |
| EnsureFinalized.hpp | Default implementation for asserting finalization of parameter objects. |
| Exceptions.hpp | Provides the opm-material specific exception classes |
| FastSmallVector.hpp | An implementation of vector/array based on small object optimization |
| HasMemberGeneratorMacros.hpp | This macro generates a class HasMember_${MEMBER_NAME} which can be used for template specialization. |
| IntervalTabulated2DFunction.hpp | Implements a function that depends on two variables. |
| MathToolbox.hpp | A traits class which provides basic mathematical functions for arbitrary scalar floating point values |
| Means.hpp | Implements some common averages |
| OpmFinal.hpp | This file provides a wrapper around the "final" C++-2011 statement |
| PolynomialUtils.hpp | Provides free functions to invert polynomials of degree 1, 2 and 3 |
| quad.hpp | This file provides the infrastructure to use quad-precision floating point values in the numerical models |
| ResetLocale.hpp | Provides a free function to reset the localization settings |
| Spline.hpp | Class implementing cubic splines. |
| Tabulated1DFunction.hpp | Implements a linearly interpolated scalar function that depends on one variable. |
| TridiagonalMatrix.hpp | Provides a tridiagonal matrix that also supports non-zero entries in the upper right and lower left. |
| 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-. |
| Unused.hpp | Provides the OPM_UNUSED macro |
| Valgrind.hpp | Some templates to wrap the valgrind client request macros |
| ► components | |
| ► iapws | |
| Common.hpp | Implements relations which are common for all regions of the IAPWS '97 formulation. |
| 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. |
| Air.hpp | A simple class implementing the fluid properties of air. |
| Brine.hpp | A class for the brine fluid properties. |
| CO2.hpp | A class for the CO2 fluid properties. |
| Component.hpp | Abstract base class of a pure chemical species. |
| Dnapl.hpp | A simple implementation of a dense non-aqueous phase liquid (DNAPL). |
| H2O.hpp | Material properties of pure water  . |
| Lnapl.hpp | A simple implementation of a LNAPL, e.g. |
| Mesitylene.hpp | Component for Mesitylene. |
| N2.hpp | Properties of pure molecular nitrogen  . |
| NullComponent.hpp | A component that only throws exceptions. |
| SimpleCO2.hpp | A simplistic class representing the  fluid properties. |
| SimpleH2O.hpp | A simple version of pure water. |
| SimpleHuDuanH2O.hpp | A simple version of pure water with density from Hu et al. |
| TabulatedComponent.hpp | A generic class which tabulates all thermodynamic properties of a given component. |
| Unit.hpp | A component where all quantities are fixed at 1.0. |
| Xylene.hpp | Component for Xylene. |
| ► constraintsolvers | |
| 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. |
| ImmiscibleFlash.hpp | Determines the pressures and saturations of all fluid phases given the total mass of all components. |
| MiscibleMultiPhaseComposition.hpp | Computes the composition of all phases of a N-phase, N-component fluid system assuming that all N phases are present. |
| NcpFlash.hpp | Determines the phase compositions, pressures and saturations given the total mass of all components. |
| ► densead | |
| DynamicEvaluation.hpp | This file file provides a dense-AD Evaluation class where the number of derivatives is specified at runtime |
| Evaluation.hpp | Representation of an evaluation of a function and its derivatives w.r.t |
| Evaluation1.hpp | This file specializes the dense-AD Evaluation class for 1 derivatives |
| Evaluation10.hpp | This file specializes the dense-AD Evaluation class for 10 derivatives |
| Evaluation11.hpp | This file specializes the dense-AD Evaluation class for 11 derivatives |
| Evaluation12.hpp | This file specializes the dense-AD Evaluation class for 12 derivatives |
| Evaluation2.hpp | This file specializes the dense-AD Evaluation class for 2 derivatives |
| Evaluation3.hpp | This file specializes the dense-AD Evaluation class for 3 derivatives |
| Evaluation4.hpp | This file specializes the dense-AD Evaluation class for 4 derivatives |
| Evaluation5.hpp | This file specializes the dense-AD Evaluation class for 5 derivatives |
| Evaluation6.hpp | This file specializes the dense-AD Evaluation class for 6 derivatives |
| Evaluation7.hpp | This file specializes the dense-AD Evaluation class for 7 derivatives |
| Evaluation8.hpp | This file specializes the dense-AD Evaluation class for 8 derivatives |
| Evaluation9.hpp | This file specializes the dense-AD Evaluation class for 9 derivatives |
| EvaluationSpecializations.hpp | This file includes all specializations for the dense-AD Evaluation class |
| Math.hpp | A number of commonly used algebraic functions for the localized OPM automatic differentiation (AD) framework |
| ► eos | |
| 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. |
| ► fluidmatrixinteractions | |
| BrooksCorey.hpp | Implementation of the Brooks-Corey capillary pressure <-> saturation relation. |
| BrooksCoreyParams.hpp | Specification of the material parameters for the Brooks-Corey constitutive relations. |
| 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. |
| EclEpsGridProperties.hpp | |
| 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. |
| LinearMaterial.hpp | Implements a linear saturation-capillary pressure relation. |
| LinearMaterialParams.hpp | Reference implementation of params for the linear M-phase material material. |
| MaterialTraits.hpp | This file contains helper classes for the material laws |
| 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. |
| ParkerLenhard.hpp | Implements the Parker-Lenhard twophase p_c-Sw hysteresis model. |
| ParkerLenhardParams.hpp | Default parameter class for the Parker-Lenhard hysteresis model. |
| 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. |
| 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". |
| 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. |
| 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. |
| VanGenuchten.hpp | Implementation of the van Genuchten capillary pressure - saturation relation. |
| VanGenuchtenParams.hpp | Specification of the material parameters for the van Genuchten constitutive relations. |
| ► fluidstates | |
| BlackOilFluidState.hpp | Implements a "tailor-made" fluid state class for the black-oil model. |
| CompositionalFluidState.hpp | Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium |
| 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 |
| ImmiscibleFluidState.hpp | Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium |
| ModularFluidState.hpp | Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium. |
| NonEquilibriumFluidState.hpp | Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system not assuming thermodynamic equilibrium |
| PressureOverlayFluidState.hpp | This is a fluid state which allows to set the fluid pressures and takes all other quantities from an other fluid state. |
| SaturationOverlayFluidState.hpp | This is a fluid state which allows to set the fluid saturations and takes all other quantities from an other fluid state. |
| SimpleModularFluidState.hpp | Represents all relevant thermodynamic quantities of a multi-phase, multi-component fluid system assuming thermodynamic equilibrium. |
| TemperatureOverlayFluidState.hpp | This is a fluid state which allows to set the fluid temperatures and takes all other quantities from an other fluid state. |
| ► fluidsystems | |
| ► blackoilpvt | |
| BrineCo2Pvt.hpp | This class represents the Pressure-Volume-Temperature relations of the liquid phase for a CO2-Brine system. |
| Co2GasPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the gas phase for CO2. |
| ConstantCompressibilityBrinePvt.hpp | This class represents the Pressure-Volume-Temperature relations of the gas phase without vaporized oil. |
| 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. |
| DeadOilPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the oil phase without dissolved gas. |
| DryGasPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the gas phase without vaporized oil. |
| GasPvtMultiplexer.hpp | This class represents the Pressure-Volume-Temperature relations of the gas phase in the black-oil model. |
| GasPvtThermal.hpp | This class implements temperature dependence of the PVT properties of gas. |
| LiveOilPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the oil phas with dissolved gas. |
| OilPvtMultiplexer.hpp | This class represents the Pressure-Volume-Temperature relations of the oil phase in the black-oil model. |
| OilPvtThermal.hpp | This class implements temperature dependence of the PVT properties of oil. |
| SolventPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the "second" gas phase in the of ECL simulations with solvents. |
| WaterPvtMultiplexer.hpp | This class represents the Pressure-Volume-Temperature relations of the water phase in the black-oil model. |
| WaterPvtThermal.hpp | This class implements temperature dependence of the PVT properties of water. |
| WetGasPvt.hpp | This class represents the Pressure-Volume-Temperature relations of the gas phas with vaporized oil. |
| BaseFluidSystem.hpp | The base class for all fluid systems. |
| BlackOilDefaultIndexTraits.hpp | The class which specifies the default phase and component indices for the black-oil fluid system. |
| BlackOilFluidSystem.hpp | A fluid system which uses the black-oil model assumptions to calculate termodynamically meaningful quantities. |
| BrineCO2FluidSystem.hpp | A two-phase fluid system with water and CO2. |
| GasPhase.hpp | Represents the gas phase of a single (pseudo-) component. |
| 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. |
| LiquidPhase.hpp | Represents the liquid phase of a single (pseudo-) component. |
| NullParameterCache.hpp | A parameter cache which does nothing. |
| ParameterCacheBase.hpp | The base class of the parameter caches of fluid systems. |
| SinglePhaseFluidSystem.hpp | A fluid system for single phase models. |
| 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. |
| TwoPhaseImmiscibleFluidSystem.hpp | A fluid system for two-phase models assuming immiscibility and thermodynamic equilibrium. |
| ► thermal | |
| ConstantSolidHeatCapLaw.hpp | Implements a solid energy storage law which assumes constant heat capacity. |
| ConstantSolidHeatCapLawParams.hpp | The default implementation of a parameter object for the solid energy storage law which assumes constant heat capacity. |
| EclHeatcrLaw.hpp | Implements the volumetric interior energy relations of rock used by ECL. |
| EclHeatcrLawParams.hpp | The default implementation of a parameter object for the ECL thermal law. |
| EclSolidEnergyLawMultiplexer.hpp | Provides the energy storage relation of rock. |
| EclSolidEnergyLawMultiplexerParams.hpp | The default implementation of a parameter object for the ECL thermal law. |
| EclSpecrockLaw.hpp | Implements the volumetric interior energy relations of rock used by ECL. |
| EclSpecrockLawParams.hpp | The default implementation of a parameter object for the ECL thermal law based on SPECROCK. |
| EclThcLaw.hpp | Implements the total thermal conductivity and rock enthalpy relations used by ECL. |
| EclThcLawParams.hpp | The default implementation of a parameter object for the thermal conduction law based on the THC* keywords from ECL. |
| EclThconrLaw.hpp | Implements the total thermal conductivity relations specified by the ECL THCONR. |
| EclThconrLawParams.hpp | The default implementation of a parameter object for the thermal conduction law based on the THCONR keyword from ECL. |
| EclThermalConductionLawMultiplexer.hpp | Implements the total thermal conductivity and rock enthalpy relations used by ECL. |
| EclThermalConductionLawMultiplexerParams.hpp | The default implementation of a parameter object for the ECL thermal law. |
| EclThermalLawManager.hpp | Provides an simple way to create and manage the thermal law objects for a complete ECL deck. |
| FluidThermalConductionLaw.hpp | |
| FluidThermalConductionLawParams.hpp | |
| NullSolidEnergyLaw.hpp | Implements a solid energy storage law which just returns 0. |
| NullThermalConductionLaw.hpp | Implements a dummy law for thermal conduction to which isothermal models can fall back to. |
| SomertonThermalConductionLaw.hpp | Implements the Somerton law of thermal conductivity in a porous medium. |
| SomertonThermalConductionLawParams.hpp | The default implementation of a parameter object for the Somerton thermal conduction law. |
| checkFluidSystem.hpp | Checks whether a fluid system adheres to the specification. |
| Constants.hpp | A central place for various physical constants occuring in some equations. |
| IdealGas.hpp | Relations valid for an ideal gas. |
