MaterialPropertyLib Namespace Reference

Namespaces
namespace	IAPWSIF97Region4

Classes
class	AverageMolarMass
class	BishopsPowerLaw
	Bishop's power law for effective stress. More...
class	BishopsSaturationCutoff
class	CapillaryPressureRegularizedVanGenuchten
	This class handles the computation of the capillary pressure, \( p_c(S_l) \), with the capillary pressure regularization. More...
class	CapillaryPressureVanGenuchten
	The van Genuchten capillary pressure model. More...
class	ClausiusClapeyron
class	Component
	This class defines components (substances). More...
class	Constant
struct	CubicLawPermeability
class	Curve
class	DupuitPermeability
class	EffectiveThermalConductivityPorosityMixing
class	EmbeddedFracturePermeability
	Permeability model as proposed by Olivella&Alonso. More...
struct	ExponentData
class	Exponential
struct	FormEigenTensor
struct	FormEigenVector
struct	FormKelvinVector
class	Function
class	GasPressureDependentPermeability
	A gas pressure dependent intrinsic permeability model. More...
struct	GetSymmetricTensor
class	IdealGasLaw
	Density function for ideal gases. More...
class	IdealGasLawBinaryMixture
	Density function for binary ideal gases. More...
struct	IndependentVariable
class	KozenyCarmanModel
	Kozeny-Carman equation. More...
class	Linear
class	LinearSaturationSwellingStress
	This class defines a linear saturation rate dependent swelling stress model for the materials that swell strongly when water content increases. More...
class	LinearWaterVapourLatentHeat
	An empirical function for the latent heat of vaporization of liquid water, which is given by [35] p.786f. More...
class	LiquidViscosityVogels
class	MaterialSpatialDistributionMap
class	Medium
class	OrthotropicEmbeddedFracturePermeability
	Extended Permeability model based on Olivella&Alonso. More...
class	Parameter
class	PengRobinson
	Peng-Robinson equation of state. More...
class	PermeabilityMohrCoulombFailureIndexModel
	A failure index dependent permeability model [42]. More...
class	PermeabilityOrthotropicPowerLaw
class	Phase
class	PorosityFromMassBalance
class	Property
class	RelPermBrooksCorey
	Relative permeability function of the wetting phase proposed by Brooks&Corey. More...
class	RelPermBrooksCoreyNonwettingPhase
	Relative permeability function of the non-wetting phase proposed by Brooks&Corey. More...
class	RelPermGeneralizedPower
class	RelPermGeneralizedPowerNonwettingPhase
class	RelPermLiakopoulos
	Relative permeability function for the wetting phase of the Liakopoulos experiment. More...
class	RelPermNonWettingPhaseVanGenuchtenMualem
class	RelPermUdell
class	RelPermUdellNonwettingPhase
class	RelPermVanGenuchten
class	SaturationBrooksCorey
	A well known soil characteristics function. More...
class	SaturationDependentSwelling
class	SaturationExponential
	A simplistic soil characteristics function. More...
class	SaturationLiakopoulos
	A well known soil characteristics function. More...
class	SaturationVanGenuchten
	The van Genuchten capillary pressure model. More...
class	SaturationVanGenuchtenWithVolumetricStrain
	A strain dependent bimodal water retention model. More...
class	SaturationWeightedThermalConductivity
	Saturation dependent thermal conductivity model for soil. More...
class	SigmoidFunction
class	SpecificHeatCapacityWithLatentHeat
class	StrainDependentPermeability
	A strain dependent intrinsic permeability model. More...
class	TemperatureDependentDiffusion
class	TemperatureDependentFraction
class	TransportPorosityFromMassBalance
class	VapourDiffusionDeVries
	DeVries type Vapour diffusion. More...
class	VapourDiffusionFEBEX
	FEBEX type Vapour diffusion. More...
class	VapourDiffusionPMQ
	The Penman-Millington-Quirk (PMQ) Vapour diffusion model. More...
class	VariableArray
class	VermaPruessModel
	Verma-Pruess equation [41]. More...
struct	VogelsViscosityConstantsCH4
struct	VogelsViscosityConstantsCO2
struct	VogelsViscosityConstantsWater
class	VolumeFractionAverage
struct	Water
class	WaterDensityIAPWSIF97Region1
class	WaterEnthalpyIAPWSIF97Region1
struct	WaterLiquidDensityIAPWSIF97Region4
struct	WaterLiquidEnthalpyIAPWSIF97Region4
struct	WaterSaturationTemperatureIAPWSIF97Region4
class	WaterTemperatureIAPWSIF97Region1
class	WaterThermalConductivityIAPWS
	A class for thermal conductivity model that is defined by The International Association for the Properties of Water and Steam IAPWS (File accessed at 13.01.2023) - (Daucik and Dooley, 2011) More...
class	WaterVapourDensity
	A model for water vapour density in the unsaturated porous media. More...
class	WaterVapourDensityIAPWSIF97Region4
class	WaterVapourEnthalpyIAPWSIF97Region4
class	WaterVapourLatentHeatWithCriticalTemperature
	A latent heat model of vaporisation of water considering the critical temperature. More...
class	WaterViscosityIAPWS
	A class for viscosity model that is defined by The International Association for the Properties of Water and Steam IAPWS More...
struct	ZeroInitPropertyDataType

Typedefs
using	PropertyArray
using	PropertyDataType
template<int GlobalDim>
using	SymmetricTensor
template<int Dim>
using	Tensor = Eigen::Matrix<double, tensorSize(Dim), 1>
using	VariableType

Enumerations
enum class	MeanType { ARITHMETIC_LINEAR , ARITHMETIC_SQUAREROOT , GEOMETRIC }
enum	PropertyType : int {   acentric_factor , binary_interaction_coefficient , biot_coefficient , bishops_effective_stress ,   brooks_corey_exponent , bulk_modulus , capillary_pressure , critical_density ,   critical_pressure , critical_temperature , compressibility , concentration ,   decay_rate , density , diffusion , drhodT ,   effective_stress , enthalpy , entry_pressure , evaporation_enthalpy ,   fredlund_parameters , heat_capacity , henry_coefficient , longitudinal_dispersivity ,   molality , molar_mass , molar_volume , mole_fraction ,   molecular_diffusion , name , permeability , phase_change_expansivity ,   phase_velocity , pore_diffusion , poissons_ratio , porosity ,   reference_density , reference_temperature , reference_pressure , relative_permeability ,   relative_permeability_nonwetting_phase , residual_gas_saturation , residual_liquid_saturation , retardation_factor ,   saturation , saturation_density , saturation_enthalpy , saturation_micro ,   saturation_temperature , specific_heat_capacity , specific_latent_heat , storage ,   storage_contribution , swelling_stress_rate , temperature , thermal_conductivity ,   thermal_diffusion_enhancement_factor , thermal_expansivity , thermal_expansivity_contribution , thermal_longitudinal_dispersivity ,   thermal_osmosis_coefficient , thermal_transversal_dispersivity , tortuosity , transport_porosity ,   transversal_dispersivity , vapour_pressure , viscosity , volume_fraction ,   youngs_modulus , number_of_properties }
enum class	Variable : int {   capillary_pressure , concentration , deformation_gradient , density ,   effective_pore_pressure , enthalpy , enthalpy_of_evaporation , equivalent_plastic_strain ,   grain_compressibility , liquid_phase_pressure , liquid_saturation , mechanical_strain ,   molar_mass , molar_mass_derivative , molar_fraction , gas_phase_pressure ,   porosity , solid_grain_pressure , stress , temperature ,   total_strain , total_stress , transport_porosity , vapour_pressure ,   volumetric_strain , number_of_variables }

Functions
template<typename ContainerMedium , typename ContainerSolid , typename ContainerLiquid , typename ContainerGas >
void	checkMaterialSpatialDistributionMap (MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map, ContainerMedium const &required_properties_medium, ContainerSolid const &required_properties_solid_phase, ContainerLiquid const &required_properties_liquid_phase, ContainerGas const &required_properties_gas_phase)
void	checkRequiredProperties (Component const &c, std::span< PropertyType const > const required_properties)
std::unique_ptr< Component >	newComponent (std::string const &component_name, bool &isCustomComponent)
std::vector< std::unique_ptr< Component > >	createComponents (int const geometry_dimension, std::optional< BaseLib::ConfigTree > const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
MaterialSpatialDistributionMap	createMaterialSpatialDistributionMap (std::map< int, std::shared_ptr< Medium > > const &media, MeshLib::Mesh const &mesh)
std::unique_ptr< Medium >	createMedium (int const material_id, int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::vector< std::unique_ptr< Phase > >	createPhases (int const geometry_dimension, std::optional< BaseLib::ConfigTree > const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::unique_ptr< PropertyArray >	createProperties (int const geometry_dimension, std::optional< BaseLib::ConfigTree > const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
void	checkRequiredProperties (Medium const &medium, std::span< PropertyType const > const required_properties)
Phase const &	fluidPhase (Medium const &medium)
	Returns a gas or aqueous liquid phase of the given medium.
void	checkRequiredProperties (Phase const &phase, std::span< PropertyType const > const required_properties)
void	checkSaturationRange (const double Sl)
std::unique_ptr< Property >	createCapillaryPressureRegularizedVanGenuchten (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createCapillaryPressureVanGenuchten (BaseLib::ConfigTree const &config)
std::unique_ptr< SaturationBrooksCorey >	createSaturationBrooksCorey (BaseLib::ConfigTree const &config)
std::unique_ptr< SaturationExponential >	createSaturationExponential (BaseLib::ConfigTree const &config)
std::unique_ptr< SaturationLiakopoulos >	createSaturationLiakopoulos (BaseLib::ConfigTree const &config)
std::unique_ptr< SaturationVanGenuchten >	createSaturationVanGenuchten (BaseLib::ConfigTree const &config)
std::unique_ptr< SaturationVanGenuchtenWithVolumetricStrain >	createSaturationVanGenuchtenWithVolumetricStrain (BaseLib::ConfigTree const &config)
std::unique_ptr< AverageMolarMass >	createAverageMolarMass (BaseLib::ConfigTree const &config)
std::unique_ptr< BishopsPowerLaw >	createBishopsPowerLaw (BaseLib::ConfigTree const &config)
std::unique_ptr< BishopsSaturationCutoff >	createBishopsSaturationCutoff (BaseLib::ConfigTree const &config)
std::unique_ptr< ClausiusClapeyron >	createClausiusClapeyron (BaseLib::ConfigTree const &config)
std::unique_ptr< Constant >	createConstant (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createCubicLawPermeability (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Curve >	createCurve (BaseLib::ConfigTree const &config, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::unique_ptr< DupuitPermeability >	createDupuitPermeability (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Property >	createEffectiveThermalConductivityPorosityMixing (int const geometry_dimension, BaseLib::ConfigTree const &config, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< Property >	createEmbeddedFracturePermeability (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Exponential >	createExponential (BaseLib::ConfigTree const &config)
std::unique_ptr< Function >	createFunction (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createGasPressureDependentPermeability (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< IdealGasLaw >	createIdealGasLaw (BaseLib::ConfigTree const &config)
std::unique_ptr< IdealGasLawBinaryMixture >	createIdealGasLawBinaryMixture (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createKozenyCarmanModel (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Linear >	createLinear (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createOrthotropicEmbeddedFracturePermeability (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Parameter >	createParameterProperty (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Property >	createPengRobinson (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createPermeabilityMohrCoulombFailureIndexModel (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< Property >	createPermeabilityOrthotropicPowerLaw (BaseLib::ConfigTree const &config, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< PorosityFromMassBalance >	createPorosityFromMassBalance (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< SaturationDependentSwelling >	createSaturationDependentSwelling (BaseLib::ConfigTree const &config, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< Property >	createSaturationDependentThermalConductivity (BaseLib::ConfigTree const &config)
std::unique_ptr< SpecificHeatCapacityWithLatentHeat >	createSpecificHeatCapacityWithLatentHeat (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createStrainDependentPermeability (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system)
std::unique_ptr< Property >	createTemperatureDependentDiffusion (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< TemperatureDependentFraction >	createTemperatureDependentFraction (BaseLib::ConfigTree const &config)
std::unique_ptr< TransportPorosityFromMassBalance >	createTransportPorosityFromMassBalance (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Property >	createVermaPruessModel (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< VolumeFractionAverage >	createVolumeFractionAverage (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterSaturationTemperatureIAPWSIF97Region4 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterTemperatureIAPWSIF97Region1 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterDensityIAPWSIF97Region1 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterLiquidDensityIAPWSIF97Region4 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterVapourDensity (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterVapourDensityIAPWSIF97Region4 (BaseLib::ConfigTree const &config)
static double	saturatedVaporDensity (double const T)
	\(\rho_{vS}\)
static double	dsaturatedVaporDensitydT (double const T)
	\(\frac{\partial \rho_{vS}}{\partial T}\)
static double	humidity (double const T, double const p, double const water_density)
std::unique_ptr< Property >	createLinearWaterVapourLatentHeat (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterEnthalpyIAPWSIF97Region1 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterLiquidEnthalpyIAPWSIF97Region4 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterVapourEnthalpyIAPWSIF97Region4 (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterVapourLatentHeatWithCriticalTemperature (BaseLib::ConfigTree const &config)
template<typename T >
static std::vector< exprtk::expression< T > >	compileExpressions (exprtk::symbol_table< T > &symbol_table, std::vector< std::string > const &string_expressions)
static void	updateVariableArrayValues (std::vector< Variable > const &variables, VariableArray const &new_variable_array, VariableArray &variable_array)
static PropertyDataType	evaluateExpressions (std::vector< Variable > const &variables, VariableArray const &new_variable_array, std::vector< exprtk::expression< double > > const &expressions, VariableArray &variable_array, std::mutex &mutex)
static std::vector< std::string >	collectVariables (std::vector< std::string > const &value_string_expressions, std::vector< std::pair< std::string, std::vector< std::string > > > const &dvalue_string_expressions)
std::unique_ptr< RelPermBrooksCorey >	createRelPermBrooksCorey (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermBrooksCoreyNonwettingPhase >	createRelPermBrooksCoreyNonwettingPhase (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermGeneralizedPower >	createRelPermGeneralizedPower (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermGeneralizedPowerNonwettingPhase >	createRelPermGeneralizedPowerNonwettingPhase (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermLiakopoulos >	createRelPermLiakopoulos (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createRelPermNonWettingPhaseVanGenuchtenMualem (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermUdell >	createRelPermUdell (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermUdellNonwettingPhase >	createRelPermUdellNonwettingPhase (BaseLib::ConfigTree const &config)
std::unique_ptr< RelPermVanGenuchten >	createRelPermVanGenuchten (BaseLib::ConfigTree const &config)
double	computeVanGenuchtenMualemValue (const double S_L, const double S_L_r, const double S_L_max, const double m)
std::unique_ptr< Property >	createLinearSaturationSwellingStress (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createSaturationWeightedThermalConductivity (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< Property >	createSoilThermalConductivitySomerton (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterThermalConductivityIAPWS (BaseLib::ConfigTree const &config)
template<MeanType MeanType>
double	computeAverage (const double, double const, double const)=delete
template<MeanType MeanType>
double	computeDAverage (const double, double const, double const)=delete
template<>
double	computeAverage< MeanType::ARITHMETIC_LINEAR > (const double S, double const k_dry, double const k_wet)
template<>
double	computeDAverage< MeanType::ARITHMETIC_LINEAR > (const double, double const k_dry, double const k_wet)
template<>
double	computeAverage< MeanType::ARITHMETIC_SQUAREROOT > (const double S, double const k_dry, double const k_wet)
template<>
double	computeDAverage< MeanType::ARITHMETIC_SQUAREROOT > (const double S, double const k_dry, double const k_wet)
template<>
double	computeAverage< MeanType::GEOMETRIC > (const double S, double const k_dry, double const k_wet)
template<>
double	computeDAverage< MeanType::GEOMETRIC > (const double S, double const k_dry, double const k_wet)
static double	computeBarLambda0Factor (const double barT)
static std::array< double, 5 >	computeSeriesFactorTForLambda1 (const double barT)
static std::array< double, 6 >	computeSeriesFactorRhoForLambda1 (const double bar_rho)
static double	computeBarLambda1Factor (const std::array< double, 5 > &series_factorT, const std::array< double, 6 > &series_factorRho)
static double	computedBarLambda_dbarT (const double barT, double bar_rho)
static double	computedBarLambda_dbarRho (const double barT, double bar_rho)
std::unique_ptr< Property >	createVapourDiffusionDeVries (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createVapourDiffusionFEBEX (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createVapourDiffusionPMQ (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createLiquidViscosityVogels (BaseLib::ConfigTree const &config)
std::unique_ptr< Property >	createWaterViscosityIAPWS (BaseLib::ConfigTree const &config)
static double	computeBarMu0Factor (const double barT)
static std::array< double, 6 >	computeSeriesFactorTForMu1 (const double barT)
static std::array< double, 7 >	computeSeriesFactorRhoForMu1 (const double bar_rho)
static double	computeBarMu1Factor (const std::array< double, 6 > &series_factorT, const std::array< double, 7 > &series_factorRho)
static double	computedBarMu_dbarT (const double barT, double bar_rho)
static double	computedBarMu_dbarRho (const double barT, double bar_rho)
double	computeTemperature (double const pi, double const eta)
PropertyDataType	fromVector (std::vector< double > const &values)
void	overwriteExistingProperties (PropertyArray &properties, PropertyArray &new_properties, std::variant< Medium *, Phase *, Component * > scale_pointer)
void	updatePropertiesForAllPhases (PropertyArray &properties, std::vector< std::unique_ptr< Phase > > const &phases)
PropertyType	convertStringToProperty (std::string const &string)
void	checkMPLPhasesForSinglePhaseFlow (MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map)
void	checkVanGenuchtenExponentRange (const double m)
template<int GlobalDim>
Eigen::Matrix< double, GlobalDim, GlobalDim >	formEffectiveThermalConductivity (MaterialPropertyLib::PropertyDataType const &solid_thermal_conductivity, const double fluid_thermal_conductivity, const double porosity)
template Eigen::Matrix< double, 1, 1 >	formEffectiveThermalConductivity< 1 > (MaterialPropertyLib::PropertyDataType const &solid_thermal_conductivity, const double fluid_thermal_conductivity, const double porosity)
template Eigen::Matrix< double, 2, 2 >	formEffectiveThermalConductivity< 2 > (MaterialPropertyLib::PropertyDataType const &solid_thermal_conductivity, const double fluid_thermal_conductivity, const double porosity)
template Eigen::Matrix< double, 3, 3 >	formEffectiveThermalConductivity< 3 > (MaterialPropertyLib::PropertyDataType const &solid_thermal_conductivity, const double fluid_thermal_conductivity, const double porosity)
template<int GlobalDim>
Eigen::Matrix< double, GlobalDim, GlobalDim >	formEigenTensor (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 1, 1 >	formEigenTensor< 1 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 2, 2 >	formEigenTensor< 2 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 3, 3 >	formEigenTensor< 3 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 4, 4 >	formEigenTensor< 4 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 6, 6 >	formEigenTensor< 6 > (MaterialPropertyLib::PropertyDataType const &values)
template<int GlobalDim>
Eigen::Matrix< double, GlobalDim, 1 >	formEigenVector (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 1, 1 >	formEigenVector< 1 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 2, 1 >	formEigenVector< 2 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 3, 1 >	formEigenVector< 3 > (MaterialPropertyLib::PropertyDataType const &values)
template<int GlobalDim>
MathLib::KelvinVector::KelvinVectorType< GlobalDim >	formKelvinVector (MaterialPropertyLib::PropertyDataType const &values)
	A function to form a Kelvin vector from strain or stress alike property like thermal expansivity for thermal strain.
template MathLib::KelvinVector::KelvinVectorType< 2 >	formKelvinVector< 2 > (MaterialPropertyLib::PropertyDataType const &values)
template MathLib::KelvinVector::KelvinVectorType< 3 >	formKelvinVector< 3 > (MaterialPropertyLib::PropertyDataType const &values)
double	getLiquidThermalExpansivity (Phase const &phase, VariableArray const &vars, const double density, ParameterLib::SpatialPosition const &pos, double const t, double const dt)
template<int GlobalDim>
SymmetricTensor< GlobalDim >	getSymmetricTensor (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 4, 1 >	getSymmetricTensor< 2 > (MaterialPropertyLib::PropertyDataType const &values)
template Eigen::Matrix< double, 6, 1 >	getSymmetricTensor< 3 > (MaterialPropertyLib::PropertyDataType const &values)
constexpr int	tensorSize (int dim)
	See Tensor type for details.
Variable	convertStringToVariable (std::string const &string)
static VariableArray::VariablePointer	dropConst (VariableArray::VariablePointerConst const const_pointer)

Variables
const MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1	gibbs_free_energy_
static constexpr double	ref_T_ = 1386
	reference temperature in K.
static constexpr double	ref_p_ = 1.653e7
	reference pressure in Pa.
constexpr double	T_c
	Critical temperature.
constexpr double	alpha = 1. / 8.
constexpr double	beta = 1. / 3.
constexpr double	Delta = 0.79 - beta
constexpr std::array	c
static const double	Li [5]
static const double	Lij [5][6]
static const double	Hi [4] = {1.67752, 2.20462, 0.6366564, -0.241605}
static const double	Hij [6][7]
static constexpr std::array	n_T
static constexpr std::array	I_T
static constexpr std::array	J_T
static const std::array< std::string, PropertyType::number_of_properties >	property_enum_to_string
static constexpr const char	error_info []
template<int GlobalDim>
constexpr int	symmetric_tensor_size
static const std::array< std::string, static_cast< int >(Variable::number_of_variables)>	variable_enum_to_string
static const VariableArray	EmptyVariableArray {}

Typedef Documentation

PropertyArray

typedef std::array< std::unique_ptr< Property >, PropertyType::number_of_properties > MaterialPropertyLib::PropertyArray

Initial value:

 
    std::array<std::unique_ptr<Property>, PropertyType::number_of_properties>

This data type is based on a std::array. It can hold pointers to objects of class Property or its inheritors. The size of this array is determined by the number of entries of the PropertyType enumerator.

Definition at line 42 of file CreateProperty.h.

PropertyDataType

using MaterialPropertyLib::PropertyDataType

Initial value:

 
    std::variant<double, Eigen::Matrix<double, 2, 1>,
                 Eigen::Matrix<double, 3, 1>, Eigen::Matrix<double, 2, 2>,
                 Eigen::Matrix<double, 3, 3>, Eigen::Matrix<double, 4, 1>,
                 Eigen::Matrix<double, 6, 1>, Eigen::MatrixXd>

Definition at line 31 of file Property.h.

SymmetricTensor

template<int GlobalDim>

using MaterialPropertyLib::SymmetricTensor

Initial value:

 
    Eigen::Matrix<double, symmetric_tensor_size<GlobalDim>, 1>

Definition at line 26 of file GetSymmetricTensor.h.

Tensor

template<int Dim>

using MaterialPropertyLib::Tensor = Eigen::Matrix<double, tensorSize(Dim), 1>

The tensor's components in 3D case are ordered in the usual way: (1,1), (1,2), (1,3) (2,1), (2,2), (2,3) (3,1), (3,2), (3,3).

For the 2D case the 2x2 block is as usual and is followed by the (3,3) component: (1,1), (1,2), (2,1), (2,2), (3,3).

For the 1D case only the diagonal is stored: (1,1), (2,2), (3,3).

Definition at line 52 of file Tensor.h.

VariableType

using MaterialPropertyLib::VariableType

Initial value:

 std::variant<std::monostate,
                                  double,
                                  Eigen::Vector<double, 4>,
                                  Eigen::Vector<double, 5>,
                                  Eigen::Vector<double, 6>,
                                  Eigen::Vector<double, 9>>

Data type for primary variables, designed to contain both scalar and vector data.

Definition at line 89 of file VariableType.h.

Enumeration Type Documentation

MeanType

enum class MaterialPropertyLib::MeanType

strong

Enumerator
ARITHMETIC_LINEAR
ARITHMETIC_SQUAREROOT
GEOMETRIC

Definition at line 28 of file SaturationWeightedThermalConductivity.h.

{
    ARITHMETIC_LINEAR,
    ARITHMETIC_SQUAREROOT,
    GEOMETRIC
};

PropertyType

enum MaterialPropertyLib::PropertyType : int

PropertyType is an enumerator list of all known properties of a substance. This includes all properties on all scales (i.e. component, phase, and medium scales). It is used as an index for the PropertyArray of the materials. If a necessary property is not in the list, simply add a new one in alphabetical order (of course, except for the last entry). Please note that any of these entries must also appear in below convert functions.

Enumerator
acentric_factor
binary_interaction_coefficient
biot_coefficient
bishops_effective_stress
brooks_corey_exponent
bulk_modulus
capillary_pressure
critical_density
critical_pressure
critical_temperature
compressibility
concentration	used to specify decay rate of a substance.
decay_rate
density
diffusion
drhodT
effective_stress
enthalpy
entry_pressure
evaporation_enthalpy
fredlund_parameters
heat_capacity
henry_coefficient
longitudinal_dispersivity	used to compute the hydrodynamic dispersion tensor.
molality
molar_mass
molar_volume
mole_fraction
molecular_diffusion	ion diffusivity in free water.
name
permeability
phase_change_expansivity
phase_velocity
pore_diffusion	ion diffusivity in the porous medium with account of the effect of tortuosity and connectivity.
poissons_ratio
porosity
reference_density
reference_temperature
reference_pressure
relative_permeability
relative_permeability_nonwetting_phase
residual_gas_saturation
residual_liquid_saturation
retardation_factor	specify retardation factor used in component transport process.
saturation
saturation_density
saturation_enthalpy
saturation_micro	capillary pressure saturation relationship for microstructure.
saturation_temperature
specific_heat_capacity
specific_latent_heat
storage
storage_contribution
swelling_stress_rate
temperature
thermal_conductivity
thermal_diffusion_enhancement_factor	Thermal diffusion enhancement factor for water vapor flow.
thermal_expansivity	The thermal expansivity corresponds to the linear thermal expansion coefficient for a solid and to the volumetric thermal expansion coefficient for a fluid
thermal_expansivity_contribution
thermal_longitudinal_dispersivity
thermal_osmosis_coefficient
thermal_transversal_dispersivity
tortuosity
transport_porosity
transversal_dispersivity	used to compute the hydrodynamic dispersion tensor.
vapour_pressure
viscosity
volume_fraction
youngs_modulus
number_of_properties

Definition at line 32 of file PropertyType.h.

{
    acentric_factor,
    binary_interaction_coefficient,
    biot_coefficient,
    bishops_effective_stress,
    brooks_corey_exponent,
    bulk_modulus,
    capillary_pressure,
    critical_density,
    critical_pressure,
    critical_temperature,
    compressibility,
    concentration,
    decay_rate,
    density,
    diffusion,
    drhodT,
    effective_stress,
    enthalpy,
    entry_pressure,
    evaporation_enthalpy,
    fredlund_parameters,
    heat_capacity,
    henry_coefficient,
    longitudinal_dispersivity,
    molality,
    molar_mass,
    molar_volume,
    mole_fraction,
    molecular_diffusion,
    name,
    permeability,
    phase_change_expansivity,
    phase_velocity,
    pore_diffusion,
    poissons_ratio,
    porosity,
    reference_density,
    reference_temperature,
    reference_pressure,
    relative_permeability,
    relative_permeability_nonwetting_phase,
    residual_gas_saturation,
    residual_liquid_saturation,
    retardation_factor,
    saturation,
    saturation_density,
    saturation_enthalpy,
    saturation_micro,
    saturation_temperature,
    specific_heat_capacity,
    specific_latent_heat,
    storage,
    storage_contribution,
    swelling_stress_rate,
    temperature,
    thermal_conductivity,
    thermal_diffusion_enhancement_factor,
    thermal_expansivity,
    thermal_expansivity_contribution,
    thermal_longitudinal_dispersivity,
    thermal_osmosis_coefficient,
    thermal_transversal_dispersivity,
    tortuosity,
    transport_porosity,
    transversal_dispersivity,
    vapour_pressure,
    viscosity,
    volume_fraction,
    youngs_modulus,
    number_of_properties
};

Variable

enum class MaterialPropertyLib::Variable : int

strong

Enum Variable is simply a list of all commonly used variables. If the variable of your choice is missing, simply add it somewhere at the list, but above the last entry.

Enumerator
capillary_pressure
concentration
deformation_gradient
density
effective_pore_pressure
enthalpy
enthalpy_of_evaporation
equivalent_plastic_strain
grain_compressibility
liquid_phase_pressure
liquid_saturation
mechanical_strain
molar_mass
molar_mass_derivative
molar_fraction
gas_phase_pressure
porosity
solid_grain_pressure
stress
temperature
total_strain
total_stress
transport_porosity
vapour_pressure
volumetric_strain
number_of_variables

Definition at line 29 of file VariableType.h.

{
    capillary_pressure,
    concentration,
    deformation_gradient,
    density,
    effective_pore_pressure,
    enthalpy,
    enthalpy_of_evaporation,
    equivalent_plastic_strain,
    grain_compressibility,
    liquid_phase_pressure,
    liquid_saturation,
    mechanical_strain,
    molar_mass,
    molar_mass_derivative,
    molar_fraction,
    gas_phase_pressure,
    porosity,
    solid_grain_pressure,
    stress,
    temperature,
    total_strain,
    total_stress,
    transport_porosity,
    vapour_pressure,
    volumetric_strain,
    number_of_variables
};

Function Documentation

checkMaterialSpatialDistributionMap()

template<typename ContainerMedium , typename ContainerSolid , typename ContainerLiquid , typename ContainerGas >

void MaterialPropertyLib::checkMaterialSpatialDistributionMap	(	MeshLib::Mesh const &	mesh,
		MaterialPropertyLib::MaterialSpatialDistributionMap const &	media_map,
		ContainerMedium const &	required_properties_medium,
		ContainerSolid const &	required_properties_solid_phase,
		ContainerLiquid const &	required_properties_liquid_phase,
		ContainerGas const &	required_properties_gas_phase )

Definition at line 23 of file CheckMaterialSpatialDistributionMap.h.

{
    for (auto const element_id : mesh.getElements() | MeshLib::views::ids)
    {
        auto const& medium = *media_map.getMedium(element_id);
        if (!required_properties_medium.empty())
        {
            MaterialPropertyLib::checkRequiredProperties(
                medium, required_properties_medium);
        }
        if (!required_properties_liquid_phase.empty())
        {
            MaterialPropertyLib::checkRequiredProperties(
                medium.phase("AqueousLiquid"),
                required_properties_liquid_phase);
        }
        if (!required_properties_gas_phase.empty())
        {
            MaterialPropertyLib::checkRequiredProperties(
                medium.phase("Gas"), required_properties_gas_phase);
        }
        if (!required_properties_solid_phase.empty())
        {
            MaterialPropertyLib::checkRequiredProperties(
                medium.phase("Solid"), required_properties_solid_phase);
        }
    }
}

References checkRequiredProperties(), MeshLib::Mesh::getElements(), MaterialPropertyLib::MaterialSpatialDistributionMap::getMedium(), and MeshLib::views::ids.

Referenced by ProcessLib::HeatConduction::checkMPLProperties(), ProcessLib::HT::checkMPLProperties(), ProcessLib::RichardsFlow::checkMPLProperties(), ProcessLib::SteadyStateDiffusion::checkMPLProperties(), and ProcessLib::WellboreSimulator::checkMPLProperties().

checkMPLPhasesForSinglePhaseFlow()

void MaterialPropertyLib::checkMPLPhasesForSinglePhaseFlow	(	MeshLib::Mesh const &	mesh,
		MaterialPropertyLib::MaterialSpatialDistributionMap const &	media_map )

Definition at line 25 of file CheckMPLPhasesForSinglePhaseFlow.cpp.

{
    // Check all of the elements have a medium defined.
    ranges::for_each(mesh.getElements() | MeshLib::views::ids,
                     [&](auto const& element_id)
                     { media_map.checkElementHasMedium(element_id); });
 
    // Collect phases of all elements...
    auto all_phases =
        media_map.media() |
        ranges::views::transform([&](auto const& medium)
                                 { return &fluidPhase(*medium); }) |
        ranges::to_vector;
 
    assert(!all_phases.empty());
 
    // ... and check if any of the phases are different by name.
    if (ranges::any_of(all_phases,
                       [p0 = all_phases.front()](auto const* const p)
                       { return p->name != p0->name; }))
    {
        OGS_FATAL(
            "You are mixing liquid and gas phases in your model domain. OGS "
            "does not yet know how to handle this.");
    }
}

References fluidPhase(), MeshLib::Mesh::getElements(), MeshLib::views::ids, MaterialPropertyLib::MaterialSpatialDistributionMap::media(), and OGS_FATAL.

Referenced by ProcessLib::LiquidFlow::checkMPLProperties(), and ProcessLib::HydroMechanics::createHydroMechanicsProcess().

checkRequiredProperties() [1/3]

void MaterialPropertyLib::checkRequiredProperties	(	Component const &	c,
		std::span< PropertyType const > const	required_properties )

Definition at line 60 of file Component.cpp.

{
    for (auto const& p : required_properties)
    {
        if (!c.hasProperty(p))
        {
            OGS_FATAL("The property '{:s}' is missing in the component '{:s}'.",
                      property_enum_to_string[p], c.name);
        }
    }
}

References c, OGS_FATAL, and property_enum_to_string.

Referenced by checkMaterialSpatialDistributionMap().

checkRequiredProperties() [2/3]

void MaterialPropertyLib::checkRequiredProperties	(	Medium const &	medium,
		std::span< PropertyType const > const	required_properties )

Definition at line 85 of file Medium.cpp.

{
    for (auto const& p : required_properties)
    {
        if (!medium.hasProperty(p))
        {
            OGS_FATAL(
                "The property '{:s}' is missing in the medium definition.",
                property_enum_to_string[p]);
        }
    }
}

References MaterialPropertyLib::Medium::hasProperty(), OGS_FATAL, and property_enum_to_string.

checkRequiredProperties() [3/3]

void MaterialPropertyLib::checkRequiredProperties	(	Phase const &	phase,
		std::span< PropertyType const > const	required_properties )

Definition at line 84 of file Phase.cpp.

{
    for (auto const& p : required_properties)
    {
        if (!phase.hasProperty(p))
        {
            OGS_FATAL("The property '{:s}' is missing in the {:s} phase.",
                      property_enum_to_string[p], phase.name);
        }
    }
}

References MaterialPropertyLib::Phase::hasProperty(), MaterialPropertyLib::Phase::name, OGS_FATAL, and property_enum_to_string.

checkSaturationRange()

void MaterialPropertyLib::checkSaturationRange

(

const double

Sl

)

Definition at line 24 of file CapillaryPressureRegularizedVanGenuchten.cpp.

{
    if (Sl < 0 || Sl > 1)
    {
        OGS_FATAL("The saturation of {:e} is out of its range of [0, 1]", Sl);
    }
}

References OGS_FATAL.

Referenced by MaterialPropertyLib::CapillaryPressureRegularizedVanGenuchten::dValue(), and MaterialPropertyLib::CapillaryPressureRegularizedVanGenuchten::value().

checkVanGenuchtenExponentRange()

void MaterialPropertyLib::checkVanGenuchtenExponentRange

(

const double

m

)

Definition at line 18 of file CheckVanGenuchtenExponentRange.cpp.

{
    if (m <= 0 || m >= 1)
    {
        OGS_FATAL(
            "The exponent value m = {:e} of van Genuchten saturation model, is "
            "out of its range of(0, 1) ",
            m);
    }
}

References OGS_FATAL.

Referenced by MaterialPropertyLib::CapillaryPressureRegularizedVanGenuchten::CapillaryPressureRegularizedVanGenuchten(), and MaterialPropertyLib::RelPermNonWettingPhaseVanGenuchtenMualem::RelPermNonWettingPhaseVanGenuchtenMualem().

collectVariables()

static std::vector< std::string > MaterialPropertyLib::collectVariables ( std::vector< std::string > const & value_string_expressions, std::vector< std::pair< std::string, std::vector< std::string > > > const & dvalue_string_expressions )

static

Definition at line 293 of file Function.cpp.

{
    std::vector<std::string> variables;
 
    auto collect_variables = [&](auto string_expressions)
    {
        for (auto const& string_expression : string_expressions)
        {
            if (!exprtk::collect_variables(string_expression, variables))
            {
                OGS_FATAL(
                    "Collecting variables from expression '{}' didn't work.",
                    string_expression);
            }
        }
    };
 
    collect_variables(value_string_expressions);
    for (auto const& var_name_string_expression : dvalue_string_expressions)
    {
        collect_variables(var_name_string_expression.second);
    }
 
    BaseLib::makeVectorUnique(variables);
    return variables;
}

References BaseLib::makeVectorUnique(), and OGS_FATAL.

Referenced by MaterialPropertyLib::Function::Function().

compileExpressions()

template<typename T >

static std::vector< exprtk::expression< T > > MaterialPropertyLib::compileExpressions ( exprtk::symbol_table< T > & symbol_table, std::vector< std::string > const & string_expressions )

static

Definition at line 27 of file Function.cpp.

{
    exprtk::parser<T> parser;
 
    std::vector<exprtk::expression<T>> expressions(string_expressions.size());
    for (unsigned i = 0; i < string_expressions.size(); ++i)
    {
        expressions[i].register_symbol_table(symbol_table);
        if (!parser.compile(string_expressions[i], expressions[i]))
        {
            OGS_FATAL("Error: {:s}\tExpression: {:s}\n",
                      parser.error(),
                      string_expressions[i]);
        }
    }
    return expressions;
}

References OGS_FATAL.

Referenced by MaterialPropertyLib::Function::Implementation< D >::Implementation().

computeAverage()

template<MeanType MeanType>

double MaterialPropertyLib::computeAverage ( const double , double const , double const  )

delete

Referenced by MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >::value().

computeAverage< MeanType::ARITHMETIC_LINEAR >()

template<>

double MaterialPropertyLib::computeAverage< MeanType::ARITHMETIC_LINEAR >	(	const double	S,
		double const	k_dry,
		double const	k_wet )

Definition at line 38 of file SaturationWeightedThermalConductivity.cpp.

{
    return k_dry * (1.0 - S) + k_wet * S;
}

computeAverage< MeanType::ARITHMETIC_SQUAREROOT >()

template<>

double MaterialPropertyLib::computeAverage< MeanType::ARITHMETIC_SQUAREROOT >	(	const double	S,
		double const	k_dry,
		double const	k_wet )

Definition at line 54 of file SaturationWeightedThermalConductivity.cpp.

{
    return k_dry + std::sqrt(S) * (k_wet - k_dry);
}

computeAverage< MeanType::GEOMETRIC >()

template<>

double MaterialPropertyLib::computeAverage< MeanType::GEOMETRIC >	(	const double	S,
		double const	k_dry,
		double const	k_wet )

Definition at line 70 of file SaturationWeightedThermalConductivity.cpp.

{
    return k_dry * std::pow(k_wet / k_dry, S);
}

computeBarLambda0Factor()

double MaterialPropertyLib::computeBarLambda0Factor ( const double barT )

static

Definition at line 88 of file WaterThermalConductivityIAPWS.cpp.

{
    double sum_val = 0.;
    double barT_i = 1.;
    for (double value : Li)
    {
        sum_val += (value / barT_i);
        barT_i *= barT;
    }
    return sum_val;
}

References Li.

Referenced by computedBarLambda_dbarRho(), computedBarLambda_dbarT(), and MaterialPropertyLib::WaterThermalConductivityIAPWS::value().

computeBarLambda1Factor()

double MaterialPropertyLib::computeBarLambda1Factor ( const std::array< double, 5 > & series_factorT, const std::array< double, 6 > & series_factorRho )

static

Definition at line 125 of file WaterThermalConductivityIAPWS.cpp.

{
    double sum_val = 0.;
    for (int i = 0; i < 5; i++)
    {
        double sum_val_j = 0;
        for (int j = 0; j < 6; j++)
        {
            sum_val_j += Lij[i][j] * series_factorRho[j];
        }
        sum_val += series_factorT[i] * sum_val_j;
    }
 
    return sum_val;
}

References Lij.

Referenced by computedBarLambda_dbarRho(), computedBarLambda_dbarT(), and MaterialPropertyLib::WaterThermalConductivityIAPWS::value().

computeBarMu0Factor()

double MaterialPropertyLib::computeBarMu0Factor ( const double barT )

static

Definition at line 81 of file WaterViscosityIAPWS.cpp.

{
    double sum_val = 0.;
    double barT_i = 1.;
    for (double value : Hi)
    {
        sum_val += (value / barT_i);
        barT_i *= barT;
    }
    return sum_val;
}

References Hi.

Referenced by computedBarMu_dbarRho(), computedBarMu_dbarT(), and MaterialPropertyLib::WaterViscosityIAPWS::value().

computeBarMu1Factor()

double MaterialPropertyLib::computeBarMu1Factor ( const std::array< double, 6 > & series_factorT, const std::array< double, 7 > & series_factorRho )

static

Definition at line 118 of file WaterViscosityIAPWS.cpp.

{
    double sum_val = 0.;
    for (int i = 0; i < 6; i++)
    {
        double sum_val_j = 0;
        for (int j = 0; j < 7; j++)
        {
            sum_val_j += Hij[i][j] * series_factorRho[j];
        }
        sum_val += series_factorT[i] * sum_val_j;
    }
 
    return sum_val;
}

References Hij.

Referenced by computedBarMu_dbarRho(), computedBarMu_dbarT(), and MaterialPropertyLib::WaterViscosityIAPWS::value().

computeDAverage()

template<MeanType MeanType>

double MaterialPropertyLib::computeDAverage ( const double , double const , double const  )

delete

Referenced by MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >::dValue().

computeDAverage< MeanType::ARITHMETIC_LINEAR >()

template<>

double MaterialPropertyLib::computeDAverage< MeanType::ARITHMETIC_LINEAR >	(	const double	,
		double const	k_dry,
		double const	k_wet )

Definition at line 46 of file SaturationWeightedThermalConductivity.cpp.

{
    return k_wet - k_dry;
}

computeDAverage< MeanType::ARITHMETIC_SQUAREROOT >()

template<>

double MaterialPropertyLib::computeDAverage< MeanType::ARITHMETIC_SQUAREROOT >	(	const double	S,
		double const	k_dry,
		double const	k_wet )

Definition at line 62 of file SaturationWeightedThermalConductivity.cpp.

{
    return 0.5 * (k_wet - k_dry) / std::sqrt(S);
}

computeDAverage< MeanType::GEOMETRIC >()

template<>

double MaterialPropertyLib::computeDAverage< MeanType::GEOMETRIC >	(	const double	S,
		double const	k_dry,
		double const	k_wet )

Definition at line 77 of file SaturationWeightedThermalConductivity.cpp.

{
    return k_dry * std::pow(k_wet / k_dry, S) * std::log(k_wet / k_dry);
}

computedBarLambda_dbarRho()

double MaterialPropertyLib::computedBarLambda_dbarRho ( const double barT, double bar_rho )

static

Definition at line 184 of file WaterThermalConductivityIAPWS.cpp.

{
    const auto& series_factorT = computeSeriesFactorTForLambda1(barT);
    const auto& series_factorRho = computeSeriesFactorRhoForLambda1(bar_rho);
 
    double dlambda1_factor_dbar_rho = 0.0;
    for (int i = 0; i < 5; i++)
    {
        double sum_val_j = 0;
        for (int j = 1; j < 6; j++)
        {
            sum_val_j +=
                static_cast<double>(j) * Lij[i][j] * series_factorRho[j - 1];
        }
        dlambda1_factor_dbar_rho += series_factorT[i] * sum_val_j;
    }
 
    const double lambda0 = std::sqrt(barT) / computeBarLambda0Factor(barT);
 
    const double lambda1_factor =
        computeBarLambda1Factor(series_factorT, series_factorRho);
    return lambda0 * std::exp(bar_rho * lambda1_factor) *
           (lambda1_factor + bar_rho * dlambda1_factor_dbar_rho);
}

References computeBarLambda0Factor(), computeBarLambda1Factor(), computeSeriesFactorRhoForLambda1(), computeSeriesFactorTForLambda1(), and Lij.

Referenced by MaterialPropertyLib::WaterThermalConductivityIAPWS::dValue().

computedBarLambda_dbarT()

double MaterialPropertyLib::computedBarLambda_dbarT ( const double barT, double bar_rho )

static

Definition at line 142 of file WaterThermalConductivityIAPWS.cpp.

{
    const double lambda0_factor = computeBarLambda0Factor(barT);
    const double sqrt_barT = std::sqrt(barT);
 
    double dlambda0_factor_dbarT = 0.0;
    double barT_i = barT * barT;
    for (int i = 1; i < 5; i++)
    {
        dlambda0_factor_dbarT -= static_cast<double>(i) * (Li[i] / barT_i);
        barT_i *= barT;
    }
 
    const double dbar_lambda0_dbarT =
        0.5 / (lambda0_factor * sqrt_barT) -
        sqrt_barT * dlambda0_factor_dbarT / (lambda0_factor * lambda0_factor);
 
    const auto& series_factorT = computeSeriesFactorTForLambda1(barT);
    const auto& series_factorRho = computeSeriesFactorRhoForLambda1(bar_rho);
 
    double dlambda1_factor_dbarT = 0.0;
    for (int i = 1; i < 5; i++)
    {
        double sum_val_j = 0;
        for (int j = 0; j < 6; j++)
        {
            sum_val_j += Lij[i][j] * series_factorRho[j];
        }
        dlambda1_factor_dbarT -= static_cast<double>(i) *
                                 series_factorT[i - 1] * sum_val_j /
                                 (barT * barT);
    }
 
    const double lambda1_factor =
        computeBarLambda1Factor(series_factorT, series_factorRho);
    const double dbar_lambda1_dbarT =
        bar_rho * std::exp(bar_rho * lambda1_factor) * dlambda1_factor_dbarT;
 
    return dbar_lambda0_dbarT * std::exp(bar_rho * lambda1_factor) +
           dbar_lambda1_dbarT * sqrt_barT / lambda0_factor;
}

References computeBarLambda0Factor(), computeBarLambda1Factor(), computeSeriesFactorRhoForLambda1(), computeSeriesFactorTForLambda1(), Li, and Lij.

Referenced by MaterialPropertyLib::WaterThermalConductivityIAPWS::dValue().

computedBarMu_dbarRho()

double MaterialPropertyLib::computedBarMu_dbarRho ( const double barT, double bar_rho )

static

Definition at line 176 of file WaterViscosityIAPWS.cpp.

{
    const auto& series_factorT = computeSeriesFactorTForMu1(barT);
    const auto& series_factorRho = computeSeriesFactorRhoForMu1(bar_rho);
 
    double dmu1_factor_dbar_rho = 0.0;
    for (int i = 0; i < 6; i++)
    {
        double sum_val_j = 0;
        for (int j = 1; j < 7; j++)
        {
            sum_val_j +=
                static_cast<double>(j) * Hij[i][j] * series_factorRho[j - 1];
        }
        dmu1_factor_dbar_rho += series_factorT[i] * sum_val_j;
    }
 
    const double mu0 = 100. * std::sqrt(barT) / computeBarMu0Factor(barT);
 
    const double mu1_factor =
        computeBarMu1Factor(series_factorT, series_factorRho);
    return mu0 * std::exp(bar_rho * mu1_factor) *
           (mu1_factor + bar_rho * dmu1_factor_dbar_rho);
}

References computeBarMu0Factor(), computeBarMu1Factor(), computeSeriesFactorRhoForMu1(), computeSeriesFactorTForMu1(), and Hij.

Referenced by MaterialPropertyLib::WaterViscosityIAPWS::dValue().

computedBarMu_dbarT()

double MaterialPropertyLib::computedBarMu_dbarT ( const double barT, double bar_rho )

static

Definition at line 135 of file WaterViscosityIAPWS.cpp.

{
    const double mu0_factor = computeBarMu0Factor(barT);
    const double sqrt_barT = std::sqrt(barT);
 
    double dmu0_factor_dbarT = 0.0;
    double barT_i = barT * barT;
    for (int i = 1; i < 4; i++)
    {
        dmu0_factor_dbarT -= static_cast<double>(i) * (Hi[i] / barT_i);
        barT_i *= barT;
    }
 
    const double dbar_mu0_dbarT =
        50. / (mu0_factor * sqrt_barT) -
        100. * sqrt_barT * dmu0_factor_dbarT / (mu0_factor * mu0_factor);
 
    const auto& series_factorT = computeSeriesFactorTForMu1(barT);
    const auto& series_factorRho = computeSeriesFactorRhoForMu1(bar_rho);
 
    double dmu1_factor_dbarT = 0.0;
    for (int i = 1; i < 6; i++)
    {
        double sum_val_j = 0;
        for (int j = 0; j < 7; j++)
        {
            sum_val_j += Hij[i][j] * series_factorRho[j];
        }
        dmu1_factor_dbarT -= static_cast<double>(i) * series_factorT[i - 1] *
                             sum_val_j / (barT * barT);
    }
 
    const double mu1_factor =
        computeBarMu1Factor(series_factorT, series_factorRho);
    const double dbar_mu1_dbarT =
        bar_rho * std::exp(bar_rho * mu1_factor) * dmu1_factor_dbarT;
 
    return dbar_mu0_dbarT * std::exp(bar_rho * mu1_factor) +
           dbar_mu1_dbarT * 100. * sqrt_barT / mu0_factor;
}

References computeBarMu0Factor(), computeBarMu1Factor(), computeSeriesFactorRhoForMu1(), computeSeriesFactorTForMu1(), Hi, and Hij.

Referenced by MaterialPropertyLib::WaterViscosityIAPWS::dValue().

computeSeriesFactorRhoForLambda1()

std::array< double, 6 > MaterialPropertyLib::computeSeriesFactorRhoForLambda1 ( const double bar_rho )

static

Definition at line 113 of file WaterThermalConductivityIAPWS.cpp.

{
    std::array<double, 6> series_factorRho;
    series_factorRho[0] = 1.;
    for (int i = 1; i < 6; i++)
    {
        series_factorRho[i] = series_factorRho[i - 1] * (bar_rho - 1.0);
    }
 
    return series_factorRho;
}

Referenced by computedBarLambda_dbarRho(), computedBarLambda_dbarT(), and MaterialPropertyLib::WaterThermalConductivityIAPWS::value().

computeSeriesFactorRhoForMu1()

std::array< double, 7 > MaterialPropertyLib::computeSeriesFactorRhoForMu1 ( const double bar_rho )

static

Definition at line 106 of file WaterViscosityIAPWS.cpp.

{
    std::array<double, 7> series_factorRho;
    series_factorRho[0] = 1.;
    for (int i = 1; i < 7; i++)
    {
        series_factorRho[i] = series_factorRho[i - 1] * (bar_rho - 1.0);
    }
 
    return series_factorRho;
}

Referenced by computedBarMu_dbarRho(), computedBarMu_dbarT(), and MaterialPropertyLib::WaterViscosityIAPWS::value().

computeSeriesFactorTForLambda1()

std::array< double, 5 > MaterialPropertyLib::computeSeriesFactorTForLambda1 ( const double barT )

static

Definition at line 100 of file WaterThermalConductivityIAPWS.cpp.

{
    std::array<double, 5> series_factorT;
    series_factorT[0] = 1.;
    const double barT_fac = 1 / barT - 1.0;
    for (int i = 1; i < 5; i++)
    {
        series_factorT[i] = series_factorT[i - 1] * barT_fac;
    }
 
    return series_factorT;
}

Referenced by computedBarLambda_dbarRho(), computedBarLambda_dbarT(), and MaterialPropertyLib::WaterThermalConductivityIAPWS::value().

computeSeriesFactorTForMu1()

std::array< double, 6 > MaterialPropertyLib::computeSeriesFactorTForMu1 ( const double barT )

static

Definition at line 93 of file WaterViscosityIAPWS.cpp.

{
    std::array<double, 6> series_factorT;
    series_factorT[0] = 1.;
    const double barT_fac = 1 / barT - 1.0;
    for (int i = 1; i < 6; i++)
    {
        series_factorT[i] = series_factorT[i - 1] * barT_fac;
    }
 
    return series_factorT;
}

Referenced by computedBarMu_dbarRho(), computedBarMu_dbarT(), and MaterialPropertyLib::WaterViscosityIAPWS::value().

computeTemperature()

double MaterialPropertyLib::computeTemperature	(	double const	pi,
		double const	eta )

Definition at line 35 of file WaterTemperatureIAPWSIF97Region1.cpp.

{
    double val = 0.;
    for (int i = 0; i < 20; i++)
    {
        val += n_T[i] * std::pow(pi, I_T[i]) * std::pow(eta + 1, J_T[i]);
    }
 
    return val;
}

References I_T, J_T, and n_T.

Referenced by MaterialPropertyLib::WaterTemperatureIAPWSIF97Region1::value().

computeVanGenuchtenMualemValue()

double MaterialPropertyLib::computeVanGenuchtenMualemValue	(	const double	S_L,
		const double	S_L_r,
		const double	S_L_max,
		const double	m )

Definition at line 25 of file RelPermNonWettingPhaseVanGenuchtenMualem.cpp.

{
    const double Se = (S_L - S_L_r) / (S_L_max - S_L_r);
    return std::sqrt(1.0 - Se) * std::pow(1.0 - std::pow(Se, 1.0 / m), 2.0 * m);
}

Referenced by MaterialPropertyLib::RelPermNonWettingPhaseVanGenuchtenMualem::computeSaturationForMinimumRelativePermeability(), and MaterialPropertyLib::RelPermNonWettingPhaseVanGenuchtenMualem::value().

convertStringToProperty()

PropertyType MaterialPropertyLib::convertStringToProperty

(

std::string const &

string

)

This function converts a string (e.g. a string from the configuration-tree) into one of the entries of the PropertyType enumerator.

Definition at line 18 of file PropertyType.cpp.

{
    for (int i = 0; i < static_cast<int>(PropertyType::number_of_properties);
         ++i)
    {
        if (boost::iequals(string, property_enum_to_string[i]))
        {
            return static_cast<PropertyType>(i);
        }
    }
 
    OGS_FATAL(
        "The property name '{:s}' does not correspond to any known property",
        string);
}

References number_of_properties, OGS_FATAL, and property_enum_to_string.

Referenced by MaterialPropertyLib::VolumeFractionAverage::VolumeFractionAverage(), and createProperties().

convertStringToVariable()

Variable MaterialPropertyLib::convertStringToVariable

(

std::string const &

string

)

This function converts a string (e.g. a string from the configuration-tree) into one of the entries of the Variable enumerator.

Definition at line 27 of file VariableType.cpp.

{
    for (int i = 0; i < static_cast<int>(Variable::number_of_variables); ++i)
    {
        if (boost::iequals(string, variable_enum_to_string[i]))
        {
            return static_cast<Variable>(i);
        }
    }
 
    OGS_FATAL(
        "The variable name '{:s}' does not correspond to any known variable",
        string);
}

References number_of_variables, OGS_FATAL, and variable_enum_to_string.

Referenced by MaterialPropertyLib::Function::Function(), MaterialPropertyLib::Function::Implementation< D >::Implementation(), createCurve(), createExponential(), createLinear(), and MaterialPropertyLib::Function::Implementation< D >::createSymbolTable().

createAverageMolarMass()

std::unique_ptr< AverageMolarMass > MaterialPropertyLib::createAverageMolarMass

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__AverageMolarMass

Definition at line 18 of file CreateAverageMolarMass.cpp.

{
    config.checkConfigParameter("type", "AverageMolarMass");
 
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create AverageMolarMass medium property");
    return std::make_unique<AverageMolarMass>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createBishopsPowerLaw()

std::unique_ptr< BishopsPowerLaw > MaterialPropertyLib::createBishopsPowerLaw

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__BishopsPowerLaw__exponent

Definition at line 15 of file CreateBishopsPowerLaw.cpp.

{
    config.checkConfigParameter("type", "BishopsPowerLaw");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create BishopsPowerLaw property {:s}.", property_name);
 
    auto const exponent =
        config.getConfigParameter<double>("exponent");
 
    return std::make_unique<MaterialPropertyLib::BishopsPowerLaw>(
        std::move(property_name), exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createBishopsSaturationCutoff()

std::unique_ptr< BishopsSaturationCutoff > MaterialPropertyLib::createBishopsSaturationCutoff

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__BishopsSaturationCutoff__cutoff_value

Definition at line 15 of file CreateBishopsSaturationCutoff.cpp.

{
    config.checkConfigParameter("type", "BishopsSaturationCutoff");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create BishopsSaturationCutoff property {:s}.", property_name);
 
    auto const cutoff_value =
        config.getConfigParameter<double>("cutoff_value");
 
    return std::make_unique<MaterialPropertyLib::BishopsSaturationCutoff>(
        std::move(property_name), cutoff_value);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createCapillaryPressureRegularizedVanGenuchten()

std::unique_ptr< Property > MaterialPropertyLib::createCapillaryPressureRegularizedVanGenuchten

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__CapillaryPressureRegularizedVanGenuchten__residual_liquid_saturation

Input File Parameter

properties__property__CapillaryPressureRegularizedVanGenuchten__residual_gas_saturation

Input File Parameter

properties__property__CapillaryPressureRegularizedVanGenuchten__exponent

Input File Parameter

properties__property__CapillaryPressureRegularizedVanGenuchten__p_b

Definition at line 20 of file CreateCapillaryPressureRegularizedVanGenuchten.cpp.

{
    config.checkConfigParameter("type",
                                "CapillaryPressureRegularizedVanGenuchten");
 
    DBUG("Create CapillaryPressureRegularizedVanGenuchten medium property");
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const maximum_liquid_saturation =
        1.0 -
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const exponent =
        config.getConfigParameter<double>("exponent");
    auto const p_b =
        config.getConfigParameter<double>("p_b");
 
    return std::make_unique<CapillaryPressureRegularizedVanGenuchten>(
        residual_liquid_saturation, maximum_liquid_saturation, exponent, p_b);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and residual_liquid_saturation.

createCapillaryPressureVanGenuchten()

std::unique_ptr< Property > MaterialPropertyLib::createCapillaryPressureVanGenuchten

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__CapillaryPressureVanGenuchten__residual_liquid_saturation

Input File Parameter

properties__property__CapillaryPressureVanGenuchten__residual_gas_saturation

Input File Parameter

properties__property__CapillaryPressureVanGenuchten__exponent

Input File Parameter

properties__property__CapillaryPressureVanGenuchten__p_b

Input File Parameter

properties__property__CapillaryPressureVanGenuchten__maximum_capillary_pressure

Definition at line 20 of file CreateCapillaryPressureVanGenuchten.cpp.

{
    config.checkConfigParameter("type", "CapillaryPressureVanGenuchten");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create CapillaryPressureVanGenuchten medium property {:s}.",
         property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const exponent =
        config.getConfigParameter<double>("exponent");
    auto const p_b =
        config.getConfigParameter<double>("p_b");
    auto const maximum_capillary_pressure =
        config.getConfigParameter<double>("maximum_capillary_pressure");
 
    return std::make_unique<CapillaryPressureVanGenuchten>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, exponent, p_b, maximum_capillary_pressure);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createClausiusClapeyron()

std::unique_ptr< ClausiusClapeyron > MaterialPropertyLib::createClausiusClapeyron

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__ClausiusClapeyron__triple_temperature

Input File Parameter

properties__property__ClausiusClapeyron__triple_pressure

Input File Parameter

properties__property__ClausiusClapeyron__critical_temperature

Input File Parameter

properties__property__ClausiusClapeyron__critical_pressure

Input File Parameter

properties__property__ClausiusClapeyron__reference_temperature

Input File Parameter

properties__property__ClausiusClapeyron__reference_pressure

Input File Parameter

properties__property__ClausiusClapeyron

Definition at line 18 of file CreateClausiusClapeyron.cpp.

{
    config.checkConfigParameter("type", "ClausiusClapeyron");
 
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create ClausiusClapeyron property {:s}.", property_name);
 
    auto const triple_temperature =
        config.getConfigParameter<double>("triple_temperature");
 
    auto const triple_pressure =
        config.getConfigParameter<double>("triple_pressure");
 
    auto const critical_temperature =
        config.getConfigParameter<double>("critical_temperature");
 
    auto const critical_pressure =
        config.getConfigParameter<double>("critical_pressure");
 
    auto const ref_temperature =
        config.getConfigParameter<double>("reference_temperature");
 
    auto const ref_pressure =
        config.getConfigParameter<double>("reference_pressure");
 
    return std::make_unique<ClausiusClapeyron>(
        std::move(property_name), triple_temperature, triple_pressure,
        critical_temperature, critical_pressure, ref_temperature, ref_pressure);
}

References BaseLib::ConfigTree::checkConfigParameter(), critical_pressure, critical_temperature, DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createComponents()

std::vector< std::unique_ptr< Component > > MaterialPropertyLib::createComponents	(	int const	geometry_dimension,
		std::optional< BaseLib::ConfigTree > const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

The method creates components based on config subtree.

Just like a phase, a component can have a name. But, in this case, the name has an important task. If a name is given, a specific component class referring to that name with corresponding physical material properties is created. Assigning a name is optional; If no name is given, a custom component without predefined properties is created.

Input File Parameter

prj__media__medium__phases__phase__components__component

Definition at line 75 of file CreateComponent.cpp.

{
    if (!config)
    {
        return {};
    }
 
    std::vector<std::unique_ptr<Component>> components;
    for (
        auto const& component_config :
        config->getConfigSubtreeList("component"))
    {
        auto component =
            createComponent(geometry_dimension, component_config, parameters,
                            local_coordinate_system, curves);
 
        if (std::find_if(components.begin(),
                         components.end(),
                         [component_name = component->name](auto const& c) {
                             return c->name == component_name;
                         }) != components.end())
        {
            OGS_FATAL(
                "Found duplicates with the same component name tag '{:s}'.",
                component->name);
        }
 
        components.push_back(std::move(component));
    }
 
    return components;
}

References c, and OGS_FATAL.

createConstant()

std::unique_ptr< Constant > MaterialPropertyLib::createConstant

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Constant__value

Definition at line 18 of file CreateConstant.cpp.

{
    config.checkConfigParameter("type", "Constant");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Constant property {:s}.", property_name);
    std::vector<double> const values =
        config.getConfigParameter<std::vector<double>>("value");
 
    return std::make_unique<Constant>(std::move(property_name),
                                      fromVector(values));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), fromVector(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createCubicLawPermeability()

std::unique_ptr< Property > MaterialPropertyLib::createCubicLawPermeability	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__CubicLawPermeability__fracture_aperture

Definition at line 18 of file CreateCubicLawPermeability.cpp.

{
    config.checkConfigParameter("type", "CubicLawPermeability");
    DBUG("Create CubicLaw Permeability model");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    auto const& b = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("fracture_aperture"), parameters,
        0, nullptr);
 
    return std::make_unique<CubicLawPermeability>(std::move(property_name), b);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createCurve()

std::unique_ptr< Curve > MaterialPropertyLib::createCurve	(	BaseLib::ConfigTree const &	config,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Curve__curve

Input File Parameter

properties__property__Curve__independent_variable

Definition at line 21 of file CreateCurve.cpp.

{
    config.checkConfigParameter("type", "Curve");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Curve {:s}.", property_name);
 
    auto curve_name = config.getConfigParameter<std::string>("curve");
    DBUG("Using curve '{:s}'", curve_name);
 
    auto const& curve =
        *BaseLib::getOrError(curves, curve_name, "Could not find curve.");
 
    auto const independent_variable_string =
        config.getConfigParameter<std::string>("independent_variable");
    DBUG("Using independent_variable '{:s}'", independent_variable_string);
    auto const independent_variable =
        MaterialPropertyLib::convertStringToVariable(
            independent_variable_string);
 
    return std::make_unique<Curve>(
        std::move(property_name), independent_variable, curve);
}

References BaseLib::ConfigTree::checkConfigParameter(), convertStringToVariable(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::getOrError(), and BaseLib::ConfigTree::peekConfigParameter().

createDupuitPermeability()

std::unique_ptr< DupuitPermeability > MaterialPropertyLib::createDupuitPermeability	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Dupuit__parameter_name

Definition at line 19 of file CreateDupuitPermeability.cpp.

{
    config.checkConfigParameter("type", "Dupuit");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create DupuitPermeability property {:s}.", property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("parameter_name");
    auto const& parameter = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
    return std::make_unique<MaterialPropertyLib::DupuitPermeability>(
        std::move(property_name), parameter);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createEffectiveThermalConductivityPorosityMixing()

std::unique_ptr< Property > MaterialPropertyLib::createEffectiveThermalConductivityPorosityMixing	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__EffectiveThermalConductivityPorosityMixing

Definition at line 17 of file CreateEffectiveThermalConductivityPorosityMixing.cpp.

{
    config.checkConfigParameter("type",
                                "EffectiveThermalConductivityPorosityMixing");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG(
        "Create effective thermal_conductivity property from porosity mixing "
        "{:s}.",
        property_name);
 
    if (geometry_dimension == 1)
    {
        return std::make_unique<
            MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing<1>>(
            std::move(property_name), local_coordinate_system);
    }
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<
            MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing<2>>(
            std::move(property_name), local_coordinate_system);
    }
    return std::make_unique<
        MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing<3>>(
        std::move(property_name), local_coordinate_system);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createEmbeddedFracturePermeability()

std::unique_ptr< Property > MaterialPropertyLib::createEmbeddedFracturePermeability	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__EmbeddedFracturePermeability__intrinsic_permeability

Input File Parameter

properties__property__EmbeddedFracturePermeability__initial_aperture

Input File Parameter

properties__property__EmbeddedFracturePermeability__mean_frac_distance

Input File Parameter

properties__property__EmbeddedFracturePermeability__threshold_strain

Input File Parameter

properties__property__EmbeddedFracturePermeability__fracture_normal

Input File Parameter

properties__property__EmbeddedFracturePermeability__fracture_rotation_xy

Input File Parameter

properties__property__EmbeddedFracturePermeability__fracture_rotation_yz

Input File Parameter

properties__property__EmbeddedFracturePermeability__jacobian_factor

Definition at line 17 of file CreateEmbeddedFracturePermeability.cpp.

{
    if ((geometry_dimension != 2) && (geometry_dimension != 3))
    {
        OGS_FATAL(
            "The EmbeddedFracturePermeability is implemented only for 2D or 3D "
            "problems");
    }
 
    config.checkConfigParameter("type", "EmbeddedFracturePermeability");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create EmbeddedFracturePermeability medium property");
 
    auto const k =
        config.getConfigParameter<double>("intrinsic_permeability");
 
    auto const b0 =
        config.getConfigParameter<double>("initial_aperture");
 
    auto const a =
        config.getConfigParameter<double>("mean_frac_distance");
 
    auto const e0 =
        config.getConfigParameter<double>("threshold_strain");
 
    bool n_const = false;
    Eigen::Matrix<double, 3, 1> n;
    if (auto const n_ptr =
        config.getConfigParameterOptional<std::vector<double>>(
            "fracture_normal"))
    {
        if ((*n_ptr).size() != 3)
        {
            OGS_FATAL(
                "The size of the fracture normal vector must be 3, but is %d.",
                (*n_ptr).size());
        }
        DBUG("Using constant fracture normal vector.");
        std::copy_n((*n_ptr).data(), 3, n.data());
        n_const = true;
        n /= n.norm();
    }
    else
    {
        DBUG(
            "No constant fracture normal was given. By default it will be "
            "determined as the third principal stress vector.");
    }
 
    std::string const fracture_rotation_xy_param_name =
        config.getConfigParameter<std::string>("fracture_rotation_xy");
 
    auto const& phi_xy = ParameterLib::findParameter<double>(
        fracture_rotation_xy_param_name, parameters, 0, nullptr);
 
    std::string const fracture_rotation_yz_param_name =
        config.getConfigParameter<std::string>("fracture_rotation_yz");
 
    auto const& phi_yz = ParameterLib::findParameter<double>(
        fracture_rotation_yz_param_name, parameters, 0, nullptr);
 
    auto const jf =
        config.getConfigParameter<double>("jacobian_factor", 0.);
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<EmbeddedFracturePermeability<2>>(
            std::move(property_name), n, n_const, k, b0, a, e0, phi_xy, phi_yz,
            jf);
    }
    return std::make_unique<EmbeddedFracturePermeability<3>>(
        std::move(property_name), n, n_const, k, b0, a, e0, phi_xy, phi_yz, jf);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createExponential()

std::unique_ptr< Exponential > MaterialPropertyLib::createExponential

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Exponential__reference_value

Input File Parameter

properties__property__Exponential__exponent

Input File Parameter

properties__property__Exponential__exponent__variable_name

Input File Parameter

properties__property__Exponential__exponent__reference_condition

Input File Parameter

properties__property__Exponential__exponent__factor

Input File Parameter

properties__property__Exponential__offset

Definition at line 18 of file CreateExponential.cpp.

{
    config.checkConfigParameter("type", "Exponential");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Exponential property {:s}.", property_name);
    auto const reference_value =
        config.getConfigParameter<double>("reference_value");
 
    auto const& exponent_data_config =
        config.getConfigSubtree("exponent");
 
    auto const& variable_name =
        exponent_data_config.getConfigParameter<std::string>("variable_name");
    auto const reference_condition =
        exponent_data_config.getConfigParameter<double>("reference_condition");
    auto const factor =
        exponent_data_config.getConfigParameter<double>("factor");
 
    auto const offset =
        config.getConfigParameter<double>("offset");
 
    MaterialPropertyLib::Variable exp_data_type =
        MaterialPropertyLib::convertStringToVariable(variable_name);
 
    MaterialPropertyLib::ExponentData const exp_data{
        exp_data_type, reference_condition, factor};
 
    return std::make_unique<MaterialPropertyLib::Exponential>(
        std::move(property_name), offset, reference_value, exp_data);
}

References BaseLib::ConfigTree::checkConfigParameter(), convertStringToVariable(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), and BaseLib::ConfigTree::peekConfigParameter().

createFunction()

std::unique_ptr< Function > MaterialPropertyLib::createFunction

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Function__value

Input File Parameter

properties__property__Function__value__expression

Input File Parameter

properties__property__Function__dvalue

Input File Parameter

properties__property__Function__dvalue__variable_name

Input File Parameter

properties__property__Function__dvalue__expression

Definition at line 15 of file CreateFunction.cpp.

{
    config.checkConfigParameter("type", "Function");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Function property {:s}.", property_name);
 
    std::vector<std::string> value_expressions;
    auto const& value_config = config.getConfigSubtree("value");
 
    for (auto const& p : value_config.getConfigSubtreeList("expression"))
    {
        value_expressions.emplace_back(p.getValue<std::string>());
    }
 
    // For each derivative a name of the variable and the list of expressions.
    std::vector<std::pair<std::string, std::vector<std::string>>>
        dvalue_expressions;
    for (auto const& dvalue_config : config.getConfigSubtreeList("dvalue"))
    {
        auto variable_name =
            dvalue_config.getConfigParameter<std::string>("variable_name");
 
        std::vector<std::string> expressions;
        auto const& expression_configs =
            dvalue_config.getConfigSubtreeList("expression");
 
        expressions.reserve(expression_configs.size());
        std::transform(std::begin(expression_configs),
                       std::end(expression_configs),
                       std::back_inserter(expressions),
                       [](BaseLib::ConfigTree const& p)
                       { return p.getValue<std::string>(); });
 
        dvalue_expressions.emplace_back(std::move(variable_name),
                                        std::move(expressions));
    }
 
    return std::make_unique<MaterialPropertyLib::Function>(
        std::move(property_name), value_expressions, dvalue_expressions);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeList(), and BaseLib::ConfigTree::peekConfigParameter().

createGasPressureDependentPermeability()

std::unique_ptr< Property > MaterialPropertyLib::createGasPressureDependentPermeability	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__GasPressureDependentPermeability__initial_permeability

Input File Parameter

properties__property__GasPressureDependentPermeability__a1

Input File Parameter

properties__property__GasPressureDependentPermeability__a2

Input File Parameter

properties__property__GasPressureDependentPermeability__pressure_threshold

Input File Parameter

properties__property__GasPressureDependentPermeability__minimum_permeability

Input File Parameter

properties__property__GasPressureDependentPermeability__maximum_permeability

Definition at line 26 of file CreateGasPressureDependentPermeability.cpp.

{
    if ((geometry_dimension != 2) && (geometry_dimension != 3))
    {
        OGS_FATAL(
            "The GasPressureDependentPermeability is implemented only for 2D "
            "or 3D problems");
    }
 
    config.checkConfigParameter("type", "GasPressureDependentPermeability");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create GasPressureDependentPermeability property {:s}.",
         property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("initial_permeability");
    auto const& parameter_k0 = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
 
    auto const a1 =
        config.getConfigParameter<double>("a1");
    auto const a2 =
        config.getConfigParameter<double>("a2");
    auto const pressure_threshold =
        config.getConfigParameter<double>("pressure_threshold");
    auto const minimum_permeability =
        config.getConfigParameter<double>("minimum_permeability");
    auto const maximum_permeability =
        config.getConfigParameter<double>("maximum_permeability");
 
    if (minimum_permeability > maximum_permeability)
    {
        OGS_FATAL(
            "The value of minimum_permeability of {:e} is larger that the "
            "value of maximum_permeability of {:e} in "
            "GasPressureDependentPermeability",
            minimum_permeability, maximum_permeability);
    }
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<GasPressureDependentPermeability<2>>(
            std::move(property_name), parameter_k0, a1, a2, pressure_threshold,
            minimum_permeability, maximum_permeability,
            local_coordinate_system);
    }
 
    return std::make_unique<GasPressureDependentPermeability<3>>(
        std::move(property_name), parameter_k0, a1, a2, pressure_threshold,
        minimum_permeability, maximum_permeability, local_coordinate_system);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createIdealGasLaw()

std::unique_ptr< IdealGasLaw > MaterialPropertyLib::createIdealGasLaw

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__IdealGasLaw

Definition at line 18 of file CreateIdealGasLaw.cpp.

{
    config.checkConfigParameter("type", "IdealGasLaw");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create IdealGasLaw medium property {:s}.", property_name);
    return std::make_unique<IdealGasLaw>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createIdealGasLawBinaryMixture()

std::unique_ptr< IdealGasLawBinaryMixture > MaterialPropertyLib::createIdealGasLawBinaryMixture

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__IdealGasLawBinaryMixture

Definition at line 18 of file CreateIdealGasLawBinaryMixture.cpp.

{
    config.checkConfigParameter("type", "IdealGasLawBinaryMixture");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create IdealGasLawBinaryMixture medium property {:s}.",
         property_name);
 
    return std::make_unique<IdealGasLawBinaryMixture>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createKozenyCarmanModel()

std::unique_ptr< Property > MaterialPropertyLib::createKozenyCarmanModel	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__KozenyCarman__initial_permeability

Input File Parameter

properties__property__KozenyCarman__initial_porosity

Definition at line 18 of file CreateKozenyCarmanModel.cpp.

{
    config.checkConfigParameter("type", "KozenyCarman");
    DBUG("Create Kozeny-Carman model.");
 
    auto const& k0 = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("initial_permeability"),
        parameters, 0, nullptr);
 
    auto const& phi0 = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("initial_porosity"), parameters,
        1, nullptr);
 
    return std::make_unique<KozenyCarmanModel>(k0, phi0);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

createLinear()

std::unique_ptr< Linear > MaterialPropertyLib::createLinear

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Linear__reference_value

Input File Parameter

properties__property__Linear__independent_variable

Input File Parameter

properties__property__Linear__independent_variable__variable_name

Input File Parameter

properties__property__Linear__independent_variable__reference_condition

Input File Parameter

properties__property__Linear__independent_variable__slope

Definition at line 18 of file CreateLinear.cpp.

{
    config.checkConfigParameter("type", "Linear");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Linear property {:s}.", property_name);
    auto const reference_value =
        config.getConfigParameter<double>("reference_value");
 
    std::vector<MaterialPropertyLib::IndependentVariable> ivs;
    for (auto const& independent_variable_config :
         config.getConfigSubtreeList("independent_variable"))
    {
        auto const& variable_name =
            independent_variable_config.getConfigParameter<std::string>(
                "variable_name");
        auto const reference_condition =
            independent_variable_config.getConfigParameter<double>(
                "reference_condition");
        auto const slope =
            independent_variable_config.getConfigParameter<double>("slope");
 
        MaterialPropertyLib::Variable ivt =
            MaterialPropertyLib::convertStringToVariable(variable_name);
 
        MaterialPropertyLib::IndependentVariable iv{ivt, reference_condition,
                                                    slope};
 
        ivs.push_back(std::move(iv));
    }
 
    return std::make_unique<MaterialPropertyLib::Linear>(
        std::move(property_name), reference_value, ivs);
}

References BaseLib::ConfigTree::checkConfigParameter(), convertStringToVariable(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtreeList(), and BaseLib::ConfigTree::peekConfigParameter().

createLinearSaturationSwellingStress()

std::unique_ptr< Property > MaterialPropertyLib::createLinearSaturationSwellingStress

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__LinearSaturationSwellingStress__coefficient

Input File Parameter

properties__property__LinearSaturationSwellingStress__reference_saturation

Definition at line 20 of file CreateLinearSaturationSwellingStress.cpp.

{
    config.checkConfigParameter("type", "LinearSaturationSwellingStress");
 
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create LinearSaturationSwellingStress phase property {:s}.",
         property_name);
 
    auto const coefficient =
        config.getConfigParameter<double>("coefficient");
 
    auto const reference_saturation =
        config.getConfigParameter<double>("reference_saturation");
 
    return std::make_unique<LinearSaturationSwellingStress>(
        property_name, coefficient, reference_saturation);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createLinearWaterVapourLatentHeat()

std::unique_ptr< Property > MaterialPropertyLib::createLinearWaterVapourLatentHeat

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__LinearWaterVapourLatentHeat

Definition at line 20 of file CreateLinearWaterVapourLatentHeat.cpp.

{
    config.checkConfigParameter("type", "LinearWaterVapourLatentHeat");
    DBUG("Create LinearWaterVapourLatentHeat phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<LinearWaterVapourLatentHeat>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createLiquidViscosityVogels()

std::unique_ptr< Property > MaterialPropertyLib::createLiquidViscosityVogels

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__LiquidViscosityVogels__liquid_type

Input File Parameter

properties__property__LiquidViscosityVogels__liquid_type

Input File Parameter

properties__property__LiquidViscosityVogels__liquid_type

Input File Parameter

properties__property__LiquidViscosityVogels__liquid_type

Definition at line 20 of file CreateLiquidViscosityVogels.cpp.

{
    config.checkConfigParameter("type", "LiquidViscosityVogels");
    INFO("Using Vogels model, which gives viscosity in SI unit, Pa s");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    auto const fluid_type =
        config.peekConfigParameter<std::string>("liquid_type");
 
    if (fluid_type == "Water")
    {
        config.checkConfigParameter("liquid_type", "Water");
 
        const VogelsViscosityConstantsWater constants;
        return std::make_unique<
            LiquidViscosityVogels<VogelsViscosityConstantsWater>>(
            std::move(property_name), std::move(constants));
    }
    if (fluid_type == "CO2")
    {
        config.checkConfigParameter("liquid_type", "CO2");
        const VogelsViscosityConstantsCO2 constants;
        return std::make_unique<
            LiquidViscosityVogels<VogelsViscosityConstantsCO2>>(
            std::move(property_name), std::move(constants));
    }
    if (fluid_type == "CH4")
    {
        config.checkConfigParameter("liquid_type", "CH4");
        const VogelsViscosityConstantsCH4 constants;
        return std::make_unique<
            LiquidViscosityVogels<VogelsViscosityConstantsCH4>>(
            std::move(property_name), std::move(constants));
    }
    OGS_FATAL(
        "The fluid type {:s} for Vogels model is unavailable.\n"
        "The available fluid types are Water, CO2 and CH4\n",
        fluid_type.data());
}

References BaseLib::ConfigTree::checkConfigParameter(), INFO(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createMaterialSpatialDistributionMap()

MaterialSpatialDistributionMap MaterialPropertyLib::createMaterialSpatialDistributionMap	(	std::map< int, std::shared_ptr< Medium > > const &	media,
		MeshLib::Mesh const &	mesh )

Definition at line 18 of file CreateMaterialSpatialDistributionMap.cpp.

{
    auto const material_ids = materialIDs(mesh);
 
    int const max_material_id =
        !material_ids
            ? 0
            : *std::max_element(begin(*material_ids), end(*material_ids));
 
    if (!material_ids && media.size() > 1)
    {
        OGS_FATAL(
            "More than one porous medium definition (namely {}) is present in "
            "the project file, but no MaterialIDs are present in the bulk "
            "mesh.",
            media.size());
    }
 
    if (max_material_id > static_cast<int>(media.size() - 1))
    {
        WARN(
            "The maximum value of MaterialIDs in mesh is {:d}. As the given "
            "number of porous media definitions in the project file is {:d}, "
            "the maximum value of MaterialIDs in mesh must be {:d} (index "
            "starts with zero).",
            max_material_id, media.size(), max_material_id - 1);
    }
 
    if (max_material_id < static_cast<int>(media.size() - 1))
    {
        WARN(
            "There are {:d} porous medium definitions in the project file but "
            "only {:d} different values in the MaterialIDs vector/data_array "
            "in the mesh.",
            media.size(), max_material_id - 1);
    }
    return {media, material_ids};
}

References OGS_FATAL, and WARN().

Referenced by ProcessLib::ComponentTransport::createComponentTransportProcess(), ProcessLib::HeatConduction::createHeatConductionProcess(), ProcessLib::HeatTransportBHE::createHeatTransportBHEProcess(), ProcessLib::HT::createHTProcess(), ProcessLib::HydroMechanics::createHydroMechanicsProcess(), ProcessLib::LargeDeformation::createLargeDeformationProcess(), ProcessLib::LiquidFlow::createLiquidFlowProcess(), ProcessLib::RichardsComponentTransport::createRichardsComponentTransportProcess(), ProcessLib::RichardsFlow::createRichardsFlowProcess(), ProcessLib::RichardsMechanics::createRichardsMechanicsProcess(), ProcessLib::SmallDeformation::createSmallDeformationProcess(), ProcessLib::SteadyStateDiffusion::createSteadyStateDiffusion(), ProcessLib::StokesFlow::createStokesFlowProcess(), ProcessLib::TH2M::createTH2MProcess(), ProcessLib::ThermalTwoPhaseFlowWithPP::createThermalTwoPhaseFlowWithPPProcess(), ProcessLib::ThermoHydroMechanics::createThermoHydroMechanicsProcess(), ProcessLib::ThermoMechanics::createThermoMechanicsProcess(), ProcessLib::ThermoRichardsFlow::createThermoRichardsFlowProcess(), ProcessLib::ThermoRichardsMechanics::createThermoRichardsMechanicsProcessStage2(), ProcessLib::TwoPhaseFlowWithPP::createTwoPhaseFlowWithPPProcess(), ProcessLib::TwoPhaseFlowWithPrho::createTwoPhaseFlowWithPrhoProcess(), ProcessLib::createWellboreCompensateNeumannBoundaryCondition(), and ProcessLib::WellboreSimulator::createWellboreSimulatorProcess().

createMedium()

std::unique_ptr< Medium > MaterialPropertyLib::createMedium	(	int const	material_id,
		int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

This function parses the "phases" and "properties" subtrees of the config tree and calls create methods for the phase vector and the properties array. Medium properties are optional. If not defined, default properties are assigned.

Input File Parameter

prj__media__medium__phases

Input File Parameter

prj__media__medium__properties

Definition at line 24 of file CreateMedium.cpp.

{
    // Parsing the phases
    // Properties of phases may be not required in all the cases.
    auto&& phases = createPhases(geometry_dimension,
                                 config.getConfigSubtreeOptional("phases"),
                                 parameters, local_coordinate_system, curves);
 
    // Parsing medium properties, overwriting the defaults.
    auto&& properties =
        createProperties(geometry_dimension,
                         config.getConfigSubtreeOptional("properties"),
                         parameters, local_coordinate_system, curves);
 
    if (phases.empty() && !properties)
    {
        OGS_FATAL("Neither tag <phases> nor tag <properties> has been found.");
    }
 
    return std::make_unique<Medium>(material_id, std::move(phases),
                                    std::move(properties));
}

References createPhases(), createProperties(), BaseLib::ConfigTree::getConfigSubtreeOptional(), and OGS_FATAL.

Referenced by ProjectData::parseMedia().

createOrthotropicEmbeddedFracturePermeability()

std::unique_ptr< Property > MaterialPropertyLib::createOrthotropicEmbeddedFracturePermeability	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__mean_frac_distances

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__threshold_strains

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__fracture_normals

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__intrinsic_permeability

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__fracture_rotation_xy

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__fracture_rotation_yz

Input File Parameter

properties__property__OrthotropicEmbeddedFracturePermeability__jacobian_factor

Definition at line 19 of file CreateOrthotropicEmbeddedFracturePermeability.cpp.

{
    if ((geometry_dimension != 2) && (geometry_dimension != 3))
    {
        OGS_FATAL(
            "The OrthotropicEmbeddedFracturePermeability is implemented only "
            "for 2D or 3D problems");
    }
 
    config.checkConfigParameter("type",
                                "OrthotropicEmbeddedFracturePermeability");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create OrthotropicEmbeddedFracturePermeability medium property");
 
    auto const a_i =
        config.getConfigParameter<std::vector<double>>("mean_frac_distances");
    if (a_i.size() != 3)
    {
        OGS_FATAL(
            "The size of the mean fracture distances vector must be 3, but is "
            "{}.",
            a_i.size());
    }
 
    auto const e_i0 =
        config.getConfigParameter<std::vector<double>>("threshold_strains");
    if (e_i0.size() != 3)
    {
        OGS_FATAL(
            "The size of the mean threshold strains vector must be 3, but is "
            "{}.",
            e_i0.size());
    }
 
    auto const n =
        config.getConfigParameter<std::vector<double>>("fracture_normals");
    if (n.size() != 6)
    {
        OGS_FATAL(
            "The size of the fracture normals vector must be 6, but is {}.",
            n.size());
    }
    Eigen::Vector3d const n1 = Eigen::Vector3d({n[0], n[1], n[2]}).normalized();
    Eigen::Vector3d const n2 = Eigen::Vector3d({n[3], n[4], n[5]}).normalized();
 
    if (n1.dot(n2) > std::numeric_limits<double>::epsilon())
    {
        OGS_FATAL(
            "The given fracture normals are not orthogonal. Please provide two "
            "orthogonal fracture normals");
    }
 
    Eigen::Matrix3d const n_i =
        (Eigen::Matrix3d() << n1, n2, n1.cross(n2)).finished();
 
    std::string const intrinsic_permeability_param_name =
        config.getConfigParameter<std::string>("intrinsic_permeability");
 
    auto const& k = ParameterLib::findParameter<double>(
        intrinsic_permeability_param_name, parameters, 0, nullptr);
 
    std::string const fracture_rotation_xy_param_name =
        config.getConfigParameter<std::string>("fracture_rotation_xy");
 
    auto const& phi_xy = ParameterLib::findParameter<double>(
        fracture_rotation_xy_param_name, parameters, 0, nullptr);
 
    std::string const fracture_rotation_yz_param_name =
        config.getConfigParameter<std::string>("fracture_rotation_yz");
 
    auto const& phi_yz = ParameterLib::findParameter<double>(
        fracture_rotation_yz_param_name, parameters, 0, nullptr);
 
    auto const jf =
        config.getConfigParameter<double>("jacobian_factor", 0.);
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<OrthotropicEmbeddedFracturePermeability<2>>(
            std::move(property_name), a_i, e_i0, n_i, k, phi_xy, phi_yz, jf);
    }
    return std::make_unique<OrthotropicEmbeddedFracturePermeability<3>>(
        std::move(property_name), a_i, e_i0, n_i, k, phi_xy, phi_yz, jf);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createParameterProperty()

std::unique_ptr< Parameter > MaterialPropertyLib::createParameterProperty	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__Parameter__parameter_name

Definition at line 22 of file CreateParameter.cpp.

{
    config.checkConfigParameter("type", "Parameter");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create Parameter property {:s}.", property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("parameter_name");
    auto const& parameter = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
    return std::make_unique<MaterialPropertyLib::Parameter>(
        std::move(property_name), parameter);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createPengRobinson()

std::unique_ptr< Property > MaterialPropertyLib::createPengRobinson

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__PengRobinson__critical_temperature

Input File Parameter

properties__property__PengRobinson__critical_pressure

Input File Parameter

properties__property__PengRobinson__acentric_factor

Definition at line 18 of file CreatePengRobinson.cpp.

{
    config.checkConfigParameter("type", "PengRobinson");
    DBUG("Create PengRobinson EOS.");
 
    auto const Tc =
        config.getConfigParameter<double>("critical_temperature");
 
    auto const pc =
        config.getConfigParameter<double>("critical_pressure");
 
    auto const omega =
        config.getConfigParameter<double>("acentric_factor");
 
    return std::make_unique<PengRobinson>(Tc, pc, omega);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

createPermeabilityMohrCoulombFailureIndexModel()

std::unique_ptr< Property > MaterialPropertyLib::createPermeabilityMohrCoulombFailureIndexModel	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__initial_permeability

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__reference_permeability

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__fitting_factor

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__cohesion

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__friction_angle

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__maximum_permeability

Input File Parameter

properties__property__PermeabilityMohrCoulombFailureIndexModel__tensile_strength_parameter

Definition at line 25 of file CreatePermeabilityMohrCoulombFailureIndexModel.cpp.

{
    if ((geometry_dimension != 2) && (geometry_dimension != 3))
    {
        OGS_FATAL(
            "The PermeabilityMohrCoulombFailureIndexModel is implemented only "
            "for 2D or 3D problems");
    }
 
    config.checkConfigParameter("type",
                                "PermeabilityMohrCoulombFailureIndexModel");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create PermeabilityMohrCoulombFailureIndexModel property {:s}.",
         property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("initial_permeability");
    auto const& parameter_k0 = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
 
    auto const kr =
        config.getConfigParameter<double>("reference_permeability");
    auto const b =
        config.getConfigParameter<double>("fitting_factor");
    auto const c =
        config.getConfigParameter<double>("cohesion");
    auto const phi =
        config.getConfigParameter<double>("friction_angle");
    auto const max_k =
        config.getConfigParameter<double>("maximum_permeability");
    auto const t_sigma_max =
        config.getConfigParameter<double>("tensile_strength_parameter");
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<PermeabilityMohrCoulombFailureIndexModel<2>>(
            std::move(property_name), parameter_k0, kr, b, c, phi, max_k,
            t_sigma_max, local_coordinate_system);
    }
 
    return std::make_unique<PermeabilityMohrCoulombFailureIndexModel<3>>(
        std::move(property_name), parameter_k0, kr, b, c, phi, max_k,
        t_sigma_max, local_coordinate_system);
}

References c, BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createPermeabilityOrthotropicPowerLaw()

std::unique_ptr< Property > MaterialPropertyLib::createPermeabilityOrthotropicPowerLaw	(	BaseLib::ConfigTree const &	config,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__PermeabilityOrthotropicPowerLaw__intrinsic_permeabilities

Input File Parameter

properties__property__PermeabilityOrthotropicPowerLaw__exponents

Definition at line 16 of file CreatePermeabilityOrthotropicPowerLaw.cpp.

{
    config.checkConfigParameter("type", "PermeabilityOrthotropicPowerLaw");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create PermeabilityOrthotropicPowerLaw solid phase property {:s}.",
         property_name);
 
    auto const intrinsic_permeabilities =
        config.getConfigParameter<std::vector<double>>(
            "intrinsic_permeabilities");
 
    if (!((intrinsic_permeabilities.size() == 3) ||
          (intrinsic_permeabilities.size() == 2)))
    {
        OGS_FATAL(
            "The number of intrinsic permeabilities must be two or three, but "
            "{:d} were given.",
            intrinsic_permeabilities.size());
    }
 
    auto const exponents =
        config.getConfigParameter<std::vector<double>>("exponents");
 
    if (exponents.size() != 3 && exponents.size() != 2)
    {
        OGS_FATAL(
            "The number of exponents must be two or three, but {:d} were "
            "given.",
            exponents.size());
    }
 
    if (intrinsic_permeabilities.size() != exponents.size())
    {
        OGS_FATAL(
            "The number of intrinsic permeabilities and exponents must be "
            "equal, but they are {:d} and {:d}, respectively.",
            intrinsic_permeabilities.size(), exponents.size());
    }
 
    if (exponents.size() == 2)
    {
        return std::make_unique<PermeabilityOrthotropicPowerLaw<2>>(
            std::move(property_name),
            std::array<double, 2>{intrinsic_permeabilities[0],
                                  intrinsic_permeabilities[1]},
            std::array<double, 2>{exponents[0], exponents[1]},
            local_coordinate_system);
    }
    if (exponents.size() == 3)
    {
        return std::make_unique<PermeabilityOrthotropicPowerLaw<3>>(
            std::move(property_name),
            std::array<double, 3>{intrinsic_permeabilities[0],
                                  intrinsic_permeabilities[1],
                                  intrinsic_permeabilities[2]},
            std::array<double, 3>{exponents[0], exponents[1], exponents[2]},
            local_coordinate_system);
    }
    OGS_FATAL(
        "Could not create PermeabilityOrthotropicPowerLaw material model.");
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createPhases()

std::vector< std::unique_ptr< Phase > > MaterialPropertyLib::createPhases	(	int const	geometry_dimension,
		std::optional< BaseLib::ConfigTree > const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

A method that parses the phase details and stores them in the private phases_ member.

This method creates the phases of the medium. Unlike a medium, a phase may have a name. However, this is silly at the moment since this name still has no effect (except of some benefits in regard of readability). Phase components are required (a phase consists of at least one component). Phase properties are optional. If not given, default properties are assigned. These default properties average the component properties, weighted by mole fraction.

Input File Parameter

prj__media__medium__phases__phase

Definition at line 91 of file CreatePhase.cpp.

{
    if (!config)
    {
        return {};
    }
 
    std::vector<std::unique_ptr<Phase>> phases;
 
    for (auto phase_config :
         config->getConfigSubtreeList("phase"))
    {
        auto phase = createPhase(geometry_dimension, phase_config, parameters,
                                 local_coordinate_system, curves);
 
        if (std::find_if(phases.begin(),
                         phases.end(),
                         [phase_name = phase->name](auto const& p)
                         { return p->name == phase_name; }) != phases.end())
        {
            OGS_FATAL("Found duplicates with the same phase name tag '{:s}'.",
                      phase->name);
        }
 
        phases.push_back(std::move(phase));
    }
 
    return phases;
}

References OGS_FATAL.

Referenced by createMedium().

createPorosityFromMassBalance()

std::unique_ptr< PorosityFromMassBalance > MaterialPropertyLib::createPorosityFromMassBalance	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__PorosityFromMassBalance__initial_porosity

Input File Parameter

properties__property__PorosityFromMassBalance__minimal_porosity

Input File Parameter

properties__property__PorosityFromMassBalance__maximal_porosity

Definition at line 18 of file CreatePorosityFromMassBalance.cpp.

{
    config.checkConfigParameter("type", "PorosityFromMassBalance");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create PorosityFromMassBalance medium property {:s}.", property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("initial_porosity");
    auto const& initial_porosity = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
 
    auto const& phi_min = config.getConfigParameter<double>("minimal_porosity");
 
    auto const& phi_max = config.getConfigParameter<double>("maximal_porosity");
 
    return std::make_unique<PorosityFromMassBalance>(
        std::move(property_name), initial_porosity, phi_min, phi_max);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createProperties()

std::unique_ptr< PropertyArray > MaterialPropertyLib::createProperties	(	int const	geometry_dimension,
		std::optional< BaseLib::ConfigTree > const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

The method reads the 'properties' tag in the prj-file and creates component properties accordingly.

First, a new property iy created based on the specified property type. Then, the property name is evaluated and the property is copied into the properties array.

Input File Parameter

properties__property

Input File Parameter

properties__property__name

Definition at line 395 of file CreateProperty.cpp.

{
    if (!config)
    {
        return nullptr;
    }
 
    auto const& property_configs = config->getConfigSubtreeList("property");
    if (property_configs.empty())
    {
        return nullptr;
    }
 
    auto properties = std::make_unique<PropertyArray>();
 
    for (auto property_config : property_configs)
    {
        // Parsing the property name:
        auto const property_name =
            property_config.getConfigParameter<std::string>("name");
        // Create a new property based on the configuration subtree:
        auto property =
            createProperty(geometry_dimension, property_config, parameters,
                           local_coordinate_system, curves);
 
        // Insert the new property at the right position into the components
        // private PropertyArray:
        (*properties)[convertStringToProperty(property_name)] =
            std::move(property);
    }
    return properties;
}

References convertStringToProperty().

Referenced by createMedium().

createRelPermBrooksCorey()

std::unique_ptr< RelPermBrooksCorey > MaterialPropertyLib::createRelPermBrooksCorey

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelPermBrooksCorey__residual_liquid_saturation

Input File Parameter

properties__property__RelPermBrooksCorey__residual_gas_saturation

Input File Parameter

properties__property__RelPermBrooksCorey__min_relative_permeability

Input File Parameter

properties__property__RelPermBrooksCorey__lambda

Definition at line 16 of file CreateRelPermBrooksCorey.cpp.

{
    config.checkConfigParameter("type", "RelPermBrooksCorey");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermBrooksCorey medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
    auto const exponent =
        config.getConfigParameter<double>("lambda");
    if (exponent <= 0.)
    {
        OGS_FATAL("Exponent 'lambda' must be positive.");
    }
 
    return std::make_unique<RelPermBrooksCorey>(std::move(property_name),
                                                residual_liquid_saturation,
                                                residual_gas_saturation,
                                                min_relative_permeability,
                                                exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermBrooksCoreyNonwettingPhase()

std::unique_ptr< RelPermBrooksCoreyNonwettingPhase > MaterialPropertyLib::createRelPermBrooksCoreyNonwettingPhase

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelPermBrooksCoreyNonwettingPhase__residual_liquid_saturation

Input File Parameter

properties__property__RelPermBrooksCoreyNonwettingPhase__residual_gas_saturation

Input File Parameter

properties__property__RelPermBrooksCoreyNonwettingPhase__min_relative_permeability

Input File Parameter

properties__property__RelPermBrooksCoreyNonwettingPhase__lambda

Definition at line 20 of file CreateRelPermBrooksCoreyNonwettingPhase.cpp.

{
    config.checkConfigParameter("type", "RelPermBrooksCoreyNonwettingPhase");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermBrooksCoreyNonwettingPhase medium property {:s}.",
         property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
    auto const exponent =
        config.getConfigParameter<double>("lambda");
    if (exponent <= 0.)
    {
        OGS_FATAL("Exponent 'lambda' must be positive.");
    }
 
    return std::make_unique<RelPermBrooksCoreyNonwettingPhase>(
        std::move(property_name),
        residual_liquid_saturation,
        residual_gas_saturation,
        min_relative_permeability,
        exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermGeneralizedPower()

std::unique_ptr< RelPermGeneralizedPower > MaterialPropertyLib::createRelPermGeneralizedPower

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPower__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPower__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPower__min_relative_permeability

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPower__multiplier

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPower__exponent

Definition at line 17 of file CreateRelPermGeneralizedPower.cpp.

{
    config.checkConfigParameter("type", "RelativePermeabilityGeneralizedPower");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermGeneralizedPower medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
    double const a =
        config.getConfigParameter<double>("multiplier", 1);
    double const lambda =
        config.getConfigParameter<double>("exponent", 1);
 
    if (min_relative_permeability < 0)
    {
        OGS_FATAL("Minimal relative permeability must be non-negative.");
    }
 
    return std::make_unique<RelPermGeneralizedPower>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, min_relative_permeability, a, lambda);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermGeneralizedPowerNonwettingPhase()

std::unique_ptr< RelPermGeneralizedPowerNonwettingPhase > MaterialPropertyLib::createRelPermGeneralizedPowerNonwettingPhase

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPowerNonwettingPhase__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPowerNonwettingPhase__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPowerNonwettingPhase__min_relative_permeability

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPowerNonwettingPhase__multiplier

Input File Parameter

properties__property__RelativePermeabilityGeneralizedPowerNonwettingPhase__exponent

Definition at line 18 of file CreateRelPermGeneralizedPowerNonwettingPhase.cpp.

{
    config.checkConfigParameter(
        "type", "RelativePermeabilityGeneralizedPowerNonwettingPhase");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermGeneralizedPowerNonwettingPhase medium property {:s}.",
         property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
    double const a =
        config.getConfigParameter<double>("multiplier", 1000);
    double const lambda =
        config.getConfigParameter<double>("exponent", 0.8);
 
    if (min_relative_permeability < 0)
    {
        OGS_FATAL("Minimal relative permeability must be non-negative.");
    }
 
    return std::make_unique<RelPermGeneralizedPowerNonwettingPhase>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, min_relative_permeability, a, lambda);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermLiakopoulos()

std::unique_ptr< RelPermLiakopoulos > MaterialPropertyLib::createRelPermLiakopoulos

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelPermLiakopoulos

Definition at line 16 of file CreateRelPermLiakopoulos.cpp.

{
    config.checkConfigParameter("type", "RelPermLiakopoulos");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermLiakopoulos medium property {:s}.", property_name);
 
    return std::make_unique<RelPermLiakopoulos>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createRelPermNonWettingPhaseVanGenuchtenMualem()

std::unique_ptr< Property > MaterialPropertyLib::createRelPermNonWettingPhaseVanGenuchtenMualem

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityNonWettingPhaseVanGenuchtenMualem__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityNonWettingPhaseVanGenuchtenMualem__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityNonWettingPhaseVanGenuchtenMualem__exponent

Input File Parameter

properties__property__RelativePermeabilityNonWettingPhaseVanGenuchtenMualem__min_relative_permeability

Definition at line 20 of file CreateRelPermNonWettingPhaseVanGenuchtenMualem.cpp.

{
    config.checkConfigParameter(
        "type", "RelativePermeabilityNonWettingPhaseVanGenuchtenMualem");
    DBUG("Create RelPermNonWettingPhaseVanGenuchtenMualem medium property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
 
    auto const exponent =
        config.getConfigParameter<double>("exponent");
 
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
 
    if (min_relative_permeability <= 0.0 || min_relative_permeability > 1.0)
    {
        OGS_FATAL(
            "The value for min_relative_permeability of "
            "RelativePermeabilityNonWettingPhaseVanGenuchtenMualem is {:g}, "
            "which falls outside of the range of (0, 1]",
            min_relative_permeability);
    }
 
    return std::make_unique<RelPermNonWettingPhaseVanGenuchtenMualem>(
        property_name, residual_liquid_saturation, residual_gas_saturation,
        exponent, min_relative_permeability);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermUdell()

std::unique_ptr< RelPermUdell > MaterialPropertyLib::createRelPermUdell

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityUdell__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityUdell__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityUdell__min_relative_permeability

Definition at line 18 of file CreateRelPermUdell.cpp.

{
    config.checkConfigParameter("type", "RelativePermeabilityUdell");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermUdell medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
 
    if (min_relative_permeability < 0)
    {
        OGS_FATAL("Minimal relative permeability must be non-negative.");
    }
 
    return std::make_unique<RelPermUdell>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, min_relative_permeability);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermUdellNonwettingPhase()

std::unique_ptr< RelPermUdellNonwettingPhase > MaterialPropertyLib::createRelPermUdellNonwettingPhase

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityUdellNonwettingPhase__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityUdellNonwettingPhase__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityUdellNonwettingPhase__min_relative_permeability

Definition at line 17 of file CreateRelPermUdellNonwettingPhase.cpp.

{
    config.checkConfigParameter("type",
                                "RelativePermeabilityUdellNonwettingPhase");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelPermUdellNonwettingPhase medium property {:s}.",
         property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
 
    if (min_relative_permeability < 0)
    {
        OGS_FATAL("Minimal relative permeability must be non-negative.");
    }
 
    return std::make_unique<RelPermUdellNonwettingPhase>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, min_relative_permeability);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createRelPermVanGenuchten()

std::unique_ptr< RelPermVanGenuchten > MaterialPropertyLib::createRelPermVanGenuchten

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__RelativePermeabilityVanGenuchten__residual_liquid_saturation

Input File Parameter

properties__property__RelativePermeabilityVanGenuchten__residual_gas_saturation

Input File Parameter

properties__property__RelativePermeabilityVanGenuchten__minimum_relative_permeability_liquid

Input File Parameter

properties__property__RelativePermeabilityVanGenuchten__exponent

Definition at line 16 of file CreateRelPermVanGenuchten.cpp.

{
    config.checkConfigParameter("type", "RelativePermeabilityVanGenuchten");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create RelativePermeabilityVanGenuchten medium property {:s}.",
         property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const min_relative_permeability_liquid =
        config.getConfigParameter<double>(
            "minimum_relative_permeability_liquid");
    auto const exponent =
        config.getConfigParameter<double>("exponent");
    if (exponent <= 0. || exponent >= 1.)
    {
        OGS_FATAL("Exponent must be in the (0, 1) range.");
    }
 
    return std::make_unique<RelPermVanGenuchten>(
        std::move(property_name),
        residual_liquid_saturation,
        residual_gas_saturation,
        min_relative_permeability_liquid,
        exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createSaturationBrooksCorey()

std::unique_ptr< SaturationBrooksCorey > MaterialPropertyLib::createSaturationBrooksCorey

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationBrooksCorey__residual_liquid_saturation

Input File Parameter

properties__property__SaturationBrooksCorey__residual_gas_saturation

Input File Parameter

properties__property__SaturationBrooksCorey__lambda

Input File Parameter

properties__property__SaturationBrooksCorey__entry_pressure

Definition at line 16 of file CreateSaturationBrooksCorey.cpp.

{
    config.checkConfigParameter("type", "SaturationBrooksCorey");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationBrooksCorey medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const exponent =
        config.getConfigParameter<double>("lambda");
    auto const entry_pressure =
        config.getConfigParameter<double>("entry_pressure");
 
    return std::make_unique<SaturationBrooksCorey>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, exponent, entry_pressure);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), entry_pressure, BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createSaturationDependentSwelling()

std::unique_ptr< SaturationDependentSwelling > MaterialPropertyLib::createSaturationDependentSwelling	(	BaseLib::ConfigTree const &	config,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationDependentSwelling__swelling_pressures

Input File Parameter

properties__property__SaturationDependentSwelling__exponents

Input File Parameter

properties__property__SaturationDependentSwelling__lower_saturation_limit

Input File Parameter

properties__property__SaturationDependentSwelling__upper_saturation_limit

Definition at line 16 of file CreateSaturationDependentSwelling.cpp.

{
    config.checkConfigParameter("type", "SaturationDependentSwelling");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationDependentSwelling solid phase property {:s}.",
         property_name);
 
    auto const swelling_pressures =
        config.getConfigParameter<std::vector<double>>("swelling_pressures");
 
    if (swelling_pressures.size() != 3)
    {
        OGS_FATAL(
            "The number of swelling pressures must be three, but {:d} were "
            "given.",
            swelling_pressures.size());
    }
 
    auto const exponents =
        config.getConfigParameter<std::vector<double>>("exponents");
 
    if (exponents.size() != 3)
    {
        OGS_FATAL("The number of exponents must be three, but {:d} were given.",
                  exponents.size());
    }
 
    if (swelling_pressures.size() != exponents.size())
    {
        OGS_FATAL(
            "The number of swelling pressures and exponents must be equal, but "
            "they are {:d} and {:d}, respectively.",
            swelling_pressures.size(), exponents.size());
    }
 
    auto const lower_saturation_limit =
        config.getConfigParameter<double>("lower_saturation_limit");
 
    auto const upper_saturation_limit =
        config.getConfigParameter<double>("upper_saturation_limit");
 
    return std::make_unique<SaturationDependentSwelling>(
        std::move(property_name),
        std::array<double, 3>{swelling_pressures[0], swelling_pressures[1],
                              swelling_pressures[2]},
        std::array<double, 3>{exponents[0], exponents[1], exponents[2]},
        lower_saturation_limit, upper_saturation_limit,
        local_coordinate_system);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createSaturationDependentThermalConductivity()

std::unique_ptr< Property > MaterialPropertyLib::createSaturationDependentThermalConductivity

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Definition at line 14 of file CreateSaturationDependentThermalConductivity.cpp.

{
    config.checkConfigParameter("type",
                                "SaturationDependentThermalConductivity");
 
    OGS_FATAL(
        "The MPL property SaturationDependentThermalConductivity is "
        "deprecated. Please use SaturationWeightedThermalConductivity "
        "instead.");
}

References BaseLib::ConfigTree::checkConfigParameter(), and OGS_FATAL.

createSaturationExponential()

std::unique_ptr< SaturationExponential > MaterialPropertyLib::createSaturationExponential

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationExponential__residual_liquid_saturation

Input File Parameter

properties__property__SaturationExponential__residual_gas_saturation

Input File Parameter

properties__property__SaturationExponential__maximum_capillary_pressure

Input File Parameter

properties__property__SaturationExponential__exponent

Definition at line 16 of file CreateSaturationExponential.cpp.

{
    config.checkConfigParameter("type", "SaturationExponential");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationExponential medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const p_cap_max =
        config.getConfigParameter<double>("maximum_capillary_pressure");
    auto const exponent =
        config.getConfigParameter<double>("exponent");
 
    return std::make_unique<SaturationExponential>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, p_cap_max, exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createSaturationLiakopoulos()

std::unique_ptr< SaturationLiakopoulos > MaterialPropertyLib::createSaturationLiakopoulos

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationLiakopoulos

Definition at line 16 of file CreateSaturationLiakopoulos.cpp.

{
    config.checkConfigParameter("type", "SaturationLiakopoulos");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationLiakopoulos medium property {:s}.", property_name);
 
    return std::make_unique<SaturationLiakopoulos>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createSaturationVanGenuchten()

std::unique_ptr< SaturationVanGenuchten > MaterialPropertyLib::createSaturationVanGenuchten

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationVanGenuchten__residual_liquid_saturation

Input File Parameter

properties__property__SaturationVanGenuchten__residual_gas_saturation

Input File Parameter

properties__property__SaturationVanGenuchten__exponent

Input File Parameter

properties__property__SaturationVanGenuchten__pressure_exponent

Input File Parameter

properties__property__SaturationVanGenuchten__saturation_exponent

Input File Parameter

properties__property__SaturationVanGenuchten__p_b

Definition at line 16 of file CreateSaturationVanGenuchten.cpp.

{
    config.checkConfigParameter("type", "SaturationVanGenuchten");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationVanGenuchten medium property {:s}.", property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
 
    double pressure_exponent;
    double saturation_exponent;
    if (auto const optional_exponent =
        config.getConfigParameterOptional<double>("exponent"))
    {
        pressure_exponent = *optional_exponent;
        saturation_exponent = 1.0 / (1.0 - pressure_exponent);
    }
    else
    {
        pressure_exponent =
            config.getConfigParameter<double>("pressure_exponent");
        saturation_exponent =
            config.getConfigParameter<double>("saturation_exponent");
    }
 
    auto const p_b = config.getConfigParameter<double>("p_b");
 
    return std::make_unique<SaturationVanGenuchten>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, pressure_exponent, saturation_exponent, p_b);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createSaturationVanGenuchtenWithVolumetricStrain()

std::unique_ptr< SaturationVanGenuchtenWithVolumetricStrain > MaterialPropertyLib::createSaturationVanGenuchtenWithVolumetricStrain

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__residual_liquid_saturation

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__residual_gas_saturation

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__exponent

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__p_b

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__e_0

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__e_m

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__a

Input File Parameter

properties__property__SaturationVanGenuchtenWithVolumetricStrain__d_diff

Definition at line 16 of file CreateSaturationVanGenuchtenWithVolumetricStrain.cpp.

{
    config.checkConfigParameter("type",
                                "SaturationVanGenuchtenWithVolumetricStrain");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG(
        "Create SaturationVanGenuchtenWithVolumetricStrain medium property "
        "{:s}.",
        property_name);
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
    auto const exponent =
        config.getConfigParameter<double>("exponent");
    auto const p_b = config.getConfigParameter<double>("p_b");
    auto const e_0 =
        config.getConfigParameter<double>("e_0");
    auto const e_m =
        config.getConfigParameter<double>("e_m");
    auto const a =
        config.getConfigParameter<double>("a");
    auto const d_diff =
        config.getConfigParameter<double>("d_diff");
 
    return std::make_unique<SaturationVanGenuchtenWithVolumetricStrain>(
        std::move(property_name), residual_liquid_saturation,
        residual_gas_saturation, exponent, p_b, e_0, e_m, a, d_diff);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::peekConfigParameter(), residual_gas_saturation, and residual_liquid_saturation.

createSaturationWeightedThermalConductivity()

std::unique_ptr< Property > MaterialPropertyLib::createSaturationWeightedThermalConductivity	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SaturationWeightedThermalConductivity__dry_thermal_conductivity

Input File Parameter

properties__property__SaturationWeightedThermalConductivity__wet_thermal_conductivity

Input File Parameter

properties__property__SaturationWeightedThermalConductivity__mean_type

Definition at line 42 of file CreateSaturationWeightedThermalConductivity.cpp.

{
    config.checkConfigParameter("type",
                                "SaturationWeightedThermalConductivity");
 
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create SaturationWeightedThermalConductivity medium property");
 
    std::string const& dry_thermal_conductivity_parameter_name =
        config.getConfigParameter<std::string>("dry_thermal_conductivity");
    auto const& dry_thermal_conductivity = ParameterLib::findParameter<double>(
        dry_thermal_conductivity_parameter_name, parameters, 0, nullptr);
 
    std::string const& wet_thermal_conductivity_parameter_name =
        config.getConfigParameter<std::string>("wet_thermal_conductivity");
    auto const& wet_thermal_conductivity = ParameterLib::findParameter<double>(
        wet_thermal_conductivity_parameter_name, parameters, 0, nullptr);
 
    std::string const& mean_type_str =
        config.getConfigParameter<std::string>("mean_type");
 
    const std::map<std::string, MeanType> mean_type_map{
        {"arithmetic_linear", MeanType::ARITHMETIC_LINEAR},
        {"arithmetic_squareroot", MeanType::ARITHMETIC_SQUAREROOT},
        {"geometric", MeanType::GEOMETRIC}};
    MeanType const& mean_type = BaseLib::getOrError(
        mean_type_map, mean_type_str,
        "Specified mean type for the thermal conductivity could not be found.");
 
    std::map<
        std::pair<MeanType, int>,
        std::unique_ptr<Property> (*)(
            std::string /*name*/,
            ParameterLib::Parameter<double> const& /*dry_thermal_conductivity*/,
            ParameterLib::Parameter<
                double> const& /*wet_thermal_conductivity*/)>
        map_dim_and_mean_to_creator;
 
    // initialize the map
    {
        using namespace boost::mp11;
        using Dims = mp_list<mp_int<1>, mp_int<2>, mp_int<3>>;
        using Means = mp_list<
            std::integral_constant<MeanType, MeanType::ARITHMETIC_LINEAR>,
            std::integral_constant<MeanType, MeanType::ARITHMETIC_SQUAREROOT>,
            std::integral_constant<MeanType, MeanType::GEOMETRIC>>;
        using DimsAndMeanTypes =
            mp_product<mp_list, Dims,
                       Means>;  // Cartesian product of Dims and Means.
 
        mp_for_each<DimsAndMeanTypes>(
            [&map_dim_and_mean_to_creator]<typename Dim, typename Mean>(
                mp_list<Dim, Mean>)
            {
                map_dim_and_mean_to_creator.emplace(
                    std::pair{Mean::value, Dim::value},
                    &::createSaturationWeightedThermalConductivity<Mean::value,
                                                                   Dim::value>);
            });
    }
 
    auto const it = map_dim_and_mean_to_creator.find(
        std::pair{mean_type, geometry_dimension});
 
    if (it == map_dim_and_mean_to_creator.end())
    {
        OGS_FATAL(
            "Cannot create a SaturationWeightedThermalConductivity model for "
            "dimension {} and mean type {}",
            geometry_dimension, mean_type_str);
    }
 
    auto* creator = it->second;
    return creator(std::move(property_name),
                   dry_thermal_conductivity,
                   wet_thermal_conductivity);
}

References ARITHMETIC_LINEAR, ARITHMETIC_SQUAREROOT, BaseLib::ConfigTree::checkConfigParameter(), createSaturationWeightedThermalConductivity(), DBUG(), ParameterLib::findParameter(), GEOMETRIC, BaseLib::ConfigTree::getConfigParameter(), BaseLib::getOrError(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

Referenced by createSaturationWeightedThermalConductivity().

createSoilThermalConductivitySomerton()

std::unique_ptr< Property > MaterialPropertyLib::createSoilThermalConductivitySomerton

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Definition at line 19 of file CreateSoilThermalConductivitySomerton.cpp.

{
    config.checkConfigParameter("type", "SoilThermalConductivitySomerton");
 
    OGS_FATAL(
        "The MPL property SoilThermalConductivitySomerton is "
        "deprecated. Please use SaturationWeightedThermalConductivity "
        "instead.");
}

References BaseLib::ConfigTree::checkConfigParameter(), and OGS_FATAL.

createSpecificHeatCapacityWithLatentHeat()

std::unique_ptr< SpecificHeatCapacityWithLatentHeat > MaterialPropertyLib::createSpecificHeatCapacityWithLatentHeat

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__SpecificHeatCapacityWithLatentHeat__specific_latent_heat

Definition at line 19 of file CreateSpecificHeatCapacityWithLatentHeat.cpp.

{
    config.checkConfigParameter("type", "SpecificHeatCapacityWithLatentHeat");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create temperature dependent specific heat capacity {:s}.",
         property_name);
 
    auto const l =
        config.getConfigParameter<double>("specific_latent_heat");
 
    return std::make_unique<
        MaterialPropertyLib::SpecificHeatCapacityWithLatentHeat>(
        std::move(property_name), l);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createStrainDependentPermeability()

std::unique_ptr< Property > MaterialPropertyLib::createStrainDependentPermeability	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__StrainDependentPermeability__initial_permeability

Input File Parameter

properties__property__StrainDependentPermeability__b1

Input File Parameter

properties__property__StrainDependentPermeability__b2

Input File Parameter

properties__property__StrainDependentPermeability__b3

Input File Parameter

properties__property__StrainDependentPermeability__minimum_permeability

Input File Parameter

properties__property__StrainDependentPermeability__maximum_permeability

Definition at line 26 of file CreateStrainDependentPermeability.cpp.

{
    if ((geometry_dimension != 2) && (geometry_dimension != 3))
    {
        OGS_FATAL(
            "The StrainDependentPermeability is implemented only for 2D or 3D "
            "problems");
    }
 
    config.checkConfigParameter("type", "StrainDependentPermeability");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create StrainDependentPermeability property {:s}.", property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("initial_permeability");
    auto const& parameter_k0 = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
 
    auto const b1 =
        config.getConfigParameter<double>("b1");
    auto const b2 =
        config.getConfigParameter<double>("b2");
    auto const b3 =
        config.getConfigParameter<double>("b3");
    auto const minimum_permeability =
        config.getConfigParameter<double>("minimum_permeability");
    auto const maximum_permeability =
        config.getConfigParameter<double>("maximum_permeability");
 
    if (minimum_permeability > maximum_permeability)
    {
        OGS_FATAL(
            "The value of minimum_permeability of {:e} is larger that the "
            "value of maximum_permeability of {:e} in "
            "StrainDependentPermeability",
            minimum_permeability, maximum_permeability);
    }
 
    if (geometry_dimension == 2)
    {
        return std::make_unique<StrainDependentPermeability<2>>(
            std::move(property_name), parameter_k0, b1, b2, b3,
            minimum_permeability, maximum_permeability,
            local_coordinate_system);
    }
 
    return std::make_unique<StrainDependentPermeability<3>>(
        std::move(property_name), parameter_k0, b1, b2, b3,
        minimum_permeability, maximum_permeability, local_coordinate_system);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createTemperatureDependentDiffusion()

std::unique_ptr< Property > MaterialPropertyLib::createTemperatureDependentDiffusion	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__TemperatureDependentDiffusion__reference_diffusion

Input File Parameter

properties__property__TemperatureDependentDiffusion__activation_energy

Input File Parameter

properties__property__TemperatureDependentDiffusion__reference_temperature

Definition at line 16 of file CreateTemperatureDependentDiffusion.cpp.

{
    config.checkConfigParameter("type", "TemperatureDependentDiffusion");
 
    auto const& D0 = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("reference_diffusion"),
        parameters, 0, nullptr);
 
    auto const Ea =
        config.getConfigParameter<double>("activation_energy");
 
    auto const T0 =
        config.getConfigParameter<double>("reference_temperature");
 
    return std::make_unique<TemperatureDependentDiffusion>(D0, Ea, T0);
}

References BaseLib::ConfigTree::checkConfigParameter(), ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

createTemperatureDependentFraction()

std::unique_ptr< TemperatureDependentFraction > MaterialPropertyLib::createTemperatureDependentFraction

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__TemperatureDependentFraction__steepness

Input File Parameter

properties__property__TemperatureDependentFraction__characteristic_temperature

Definition at line 16 of file CreateTemperatureDependentFraction.cpp.

{
    config.checkConfigParameter("type", "TemperatureDependentFraction");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create temperature dependent fraction property {:s}.", property_name);
 
    auto const k =
        config.getConfigParameter<double>("steepness");
 
    auto const T_c =
        config.getConfigParameter<double>("characteristic_temperature");
 
    return std::make_unique<MaterialPropertyLib::TemperatureDependentFraction>(
        std::move(property_name), k, T_c);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::peekConfigParameter(), and T_c.

createTransportPorosityFromMassBalance()

std::unique_ptr< TransportPorosityFromMassBalance > MaterialPropertyLib::createTransportPorosityFromMassBalance	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__TransportPorosityFromMassBalance__initial_porosity

Input File Parameter

properties__property__TransportPorosityFromMassBalance__minimal_porosity

Input File Parameter

properties__property__TransportPorosityFromMassBalance__maximal_porosity

Definition at line 19 of file CreateTransportPorosityFromMassBalance.cpp.

{
    config.checkConfigParameter("type", "TransportPorosityFromMassBalance");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create TransportPorosityFromMassBalance medium property {:s}.",
         property_name);
 
    std::string const& parameter_name =
        config.getConfigParameter<std::string>("initial_porosity");
    auto const& initial_porosity = ParameterLib::findParameter<double>(
        parameter_name, parameters, 0, nullptr);
 
    auto const& phi_min = config.getConfigParameter<double>("minimal_porosity");
 
    auto const& phi_max = config.getConfigParameter<double>("maximal_porosity");
 
    return std::make_unique<TransportPorosityFromMassBalance>(
        std::move(property_name), initial_porosity, phi_min, phi_max);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createVapourDiffusionDeVries()

std::unique_ptr< Property > MaterialPropertyLib::createVapourDiffusionDeVries

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__VapourDiffusionDeVries__base_diffusion_coefficient

Input File Parameter

properties__property__VapourDiffusionDeVries__exponent

Definition at line 20 of file CreateVapourDiffusionDeVries.cpp.

{
    config.checkConfigParameter("type", "VapourDiffusionDeVries");
    DBUG("Create VapourDiffusionDeVries phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    double const base_diffusion_coefficient =
        config.getConfigParameter<double>("base_diffusion_coefficient", 5.9e-6);
 
    double const exponent =
        config.getConfigParameter<double>("exponent", 2.3);
 
    return std::make_unique<VapourDiffusionDeVries>(
        std::move(property_name), base_diffusion_coefficient, exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createVapourDiffusionFEBEX()

std::unique_ptr< Property > MaterialPropertyLib::createVapourDiffusionFEBEX

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__VapourDiffusionFEBEX__base_diffusion_coefficient

Input File Parameter

properties__property__VapourDiffusionFEBEX__exponent

Definition at line 20 of file CreateVapourDiffusionFEBEX.cpp.

{
    config.checkConfigParameter("type", "VapourDiffusionFEBEX");
    DBUG("Create VapourDiffusionFEBEX phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    double const base_diffusion_coefficient =
        config.getConfigParameter<double>("base_diffusion_coefficient",
                                          2.16e-5);
 
    double const exponent =
        config.getConfigParameter<double>("exponent", 1.8);
 
    return std::make_unique<VapourDiffusionFEBEX>(
        std::move(property_name), base_diffusion_coefficient, exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createVapourDiffusionPMQ()

std::unique_ptr< Property > MaterialPropertyLib::createVapourDiffusionPMQ

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__VapourDiffusionPMQ__base_diffusion_coefficient

Input File Parameter

properties__property__VapourDiffusionPMQ__exponent

Input File Parameter

properties__property__VapourDiffusionPMQ

Definition at line 20 of file CreateVapourDiffusionPMQ.cpp.

{
    config.checkConfigParameter("type", "VapourDiffusionPMQ");
    DBUG("Create VapourDiffusionPMQ phase property");
 
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    double const base_diffusion_coefficient =
        config.getConfigParameter<double>("base_diffusion_coefficient",
                                          2.16e-5);
 
    double const exponent =
        config.getConfigParameter<double>("exponent", 1.8);
 
    return std::make_unique<VapourDiffusionPMQ>(
        std::move(property_name), base_diffusion_coefficient, exponent);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

createVermaPruessModel()

std::unique_ptr< Property > MaterialPropertyLib::createVermaPruessModel	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

properties__property__type

Input File Parameter

properties__property__VermaPruessModel__initial_permeability

Input File Parameter

properties__property__VermaPruessModel__initial_porosity

Input File Parameter

properties__property__VermaPruessModel__critical_porosity

Input File Parameter

properties__property__VermaPruessModel__exponent

Definition at line 18 of file CreateVermaPruessModel.cpp.

{
    config.checkConfigParameter("type", "VermaPruess");
    DBUG("Create Verma-Pruess model.");
 
    auto const& k0 = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("initial_permeability"),
        parameters, 0, nullptr);
 
    auto const& phi0 = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("initial_porosity"), parameters,
        1, nullptr);
 
    auto const& phi_c = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("critical_porosity"), parameters,
        1, nullptr);
 
    auto const& n = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("exponent"), parameters, 1,
        nullptr);
 
    return std::make_unique<VermaPruessModel>(k0, phi0, phi_c, n);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

createVolumeFractionAverage()

std::unique_ptr< VolumeFractionAverage > MaterialPropertyLib::createVolumeFractionAverage

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__VolumeFractionAverage

Definition at line 15 of file CreateVolumeFractionAverage.cpp.

{
    config.checkConfigParameter("type", "VolumeFractionAverage");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    DBUG("Create volume fraction average {:s}.", property_name);
 
    // no input parameters required here (taken from phase properties)
 
    return std::make_unique<MaterialPropertyLib::VolumeFractionAverage>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterDensityIAPWSIF97Region1()

std::unique_ptr< Property > MaterialPropertyLib::createWaterDensityIAPWSIF97Region1

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterDensityIAPWSIF97Region1

Definition at line 20 of file CreateWaterDensityIAPWSIF97Region1.cpp.

{
    config.checkConfigParameter("type", "WaterDensityIAPWSIF97Region1");
    DBUG("Create WaterDensityIAPWSIF97Region1 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterDensityIAPWSIF97Region1>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterEnthalpyIAPWSIF97Region1()

std::unique_ptr< Property > MaterialPropertyLib::createWaterEnthalpyIAPWSIF97Region1

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterEnthalpyIAPWSIF97Region1

Definition at line 20 of file CreateWaterEnthalpyIAPWSIF97Region1.cpp.

{
    config.checkConfigParameter("type", "WaterEnthalpyIAPWSIF97Region1");
    DBUG("Create WaterEnthalpyIAPWSIF97Region1 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterEnthalpyIAPWSIF97Region1>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterLiquidDensityIAPWSIF97Region4()

std::unique_ptr< Property > MaterialPropertyLib::createWaterLiquidDensityIAPWSIF97Region4

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterLiquidDensityIAPWSIF97Region4

Definition at line 20 of file CreateWaterLiquidDensityIAPWSIF97Region4.cpp.

{
    config.checkConfigParameter("type", "WaterLiquidDensityIAPWSIF97Region4");
    DBUG("Create WaterLiquidDensityIAPWSIF97Region4 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterLiquidDensityIAPWSIF97Region4>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterLiquidEnthalpyIAPWSIF97Region4()

std::unique_ptr< Property > MaterialPropertyLib::createWaterLiquidEnthalpyIAPWSIF97Region4

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterLiquidEnthalpyIAPWSIF97Region4

Definition at line 20 of file CreateWaterLiquidEnthalpyIAPWSIF97Region4.cpp.

{
    config.checkConfigParameter("type", "WaterLiquidEnthalpyIAPWSIF97Region4");
    DBUG("Create WaterLiquidEnthalpyIAPWSIF97Region4 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterLiquidEnthalpyIAPWSIF97Region4>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterSaturationTemperatureIAPWSIF97Region4()

std::unique_ptr< Property > MaterialPropertyLib::createWaterSaturationTemperatureIAPWSIF97Region4

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterSaturationTemperatureIAPWSIF97Region4

Definition at line 20 of file CreateWaterSaturationTemperatureIAPWSIF97Region4.cpp.

{
    config.checkConfigParameter("type",
                                "WaterSaturationTemperatureIAPWSIF97Region4");
    DBUG("Create WaterSaturationTemperatureIAPWSIF97Region4 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterSaturationTemperatureIAPWSIF97Region4>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterTemperatureIAPWSIF97Region1()

std::unique_ptr< Property > MaterialPropertyLib::createWaterTemperatureIAPWSIF97Region1

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterTemperatureIAPWSIF97Region1

Definition at line 20 of file CreateWaterTemperatureIAPWSIF97Region1.cpp.

{
    config.checkConfigParameter("type", "WaterTemperatureIAPWSIF97Region1");
    DBUG("Create WaterTemperatureIAPWSIF97Region1 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterTemperatureIAPWSIF97Region1>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterThermalConductivityIAPWS()

std::unique_ptr< Property > MaterialPropertyLib::createWaterThermalConductivityIAPWS

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterThermalConductivityIAPWS

Definition at line 20 of file CreateWaterThermalConductivityIAPWS.cpp.

{
    config.checkConfigParameter("type", "WaterThermalConductivityIAPWS");
    DBUG("Create WaterThermalConductivityIAPWS phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterThermalConductivityIAPWS>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterVapourDensity()

std::unique_ptr< Property > MaterialPropertyLib::createWaterVapourDensity

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterVapourDensity

Definition at line 20 of file CreateWaterVapourDensity.cpp.

{
    config.checkConfigParameter("type", "WaterVapourDensity");
    DBUG("Create WaterVapourDensity phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterVapourDensity>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterVapourDensityIAPWSIF97Region4()

std::unique_ptr< Property > MaterialPropertyLib::createWaterVapourDensityIAPWSIF97Region4

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterVapourDensityIAPWSIF97Region4

Definition at line 20 of file CreateWaterVapourDensityIAPWSIF97Region4.cpp.

{
    config.checkConfigParameter("type", "WaterVapourDensityIAPWSIF97Region4");
    DBUG("Create WaterVapourDensityIAPWSIF97Region4 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterVapourDensityIAPWSIF97Region4>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterVapourEnthalpyIAPWSIF97Region4()

std::unique_ptr< Property > MaterialPropertyLib::createWaterVapourEnthalpyIAPWSIF97Region4

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterVapourEnthalpyIAPWSIF97Region4

Definition at line 20 of file CreateWaterVapourEnthalpyIAPWSIF97Region4.cpp.

{
    config.checkConfigParameter("type", "WaterVapourEnthalpyIAPWSIF97Region4");
    DBUG("Create WaterVapourEnthalpyIAPWSIF97Region4 phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterVapourEnthalpyIAPWSIF97Region4>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterVapourLatentHeatWithCriticalTemperature()

std::unique_ptr< Property > MaterialPropertyLib::createWaterVapourLatentHeatWithCriticalTemperature

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterVapourLatentHeatWithCriticalTemperature

Definition at line 20 of file CreateWaterVapourLatentHeatWithCriticalTemperature.cpp.

{
    config.checkConfigParameter("type",
                                "WaterVapourLatentHeatWithCriticalTemperature");
    DBUG("Create WaterVapourLatentHeatWithCriticalTemperature phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterVapourLatentHeatWithCriticalTemperature>(
        std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

createWaterViscosityIAPWS()

std::unique_ptr< Property > MaterialPropertyLib::createWaterViscosityIAPWS

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

properties__property__type

Input File Parameter

properties__property__name

Input File Parameter

properties__property__WaterViscosityIAPWS

Definition at line 20 of file CreateWaterViscosityIAPWS.cpp.

{
    config.checkConfigParameter("type", "WaterViscosityIAPWS");
    DBUG("Create WaterViscosityIAPWS phase property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    return std::make_unique<WaterViscosityIAPWS>(std::move(property_name));
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::peekConfigParameter().

dropConst()

static VariableArray::VariablePointer MaterialPropertyLib::dropConst ( VariableArray::VariablePointerConst const const_pointer )

static

Definition at line 105 of file VariableType.cpp.

{
    return std::visit(
        []<typename T>(T const* ptr) -> VariableArray::VariablePointer
        { return const_cast<T*>(ptr); },
        const_pointer);
}

Referenced by MaterialPropertyLib::VariableArray::address_of().

dsaturatedVaporDensitydT()

static double MaterialPropertyLib::dsaturatedVaporDensitydT ( double const T )

static

\(\frac{\partial \rho_{vS}}{\partial T}\)

Definition at line 29 of file WaterVapourDensity.cpp.

{
    return 4.9759 * std::exp(19.819 - 4975.9 / T) / (T * T);
}

Referenced by MaterialPropertyLib::WaterVapourDensity::dValue().

evaluateExpressions()

static PropertyDataType MaterialPropertyLib::evaluateExpressions ( std::vector< Variable > const & variables, VariableArray const & new_variable_array, std::vector< exprtk::expression< double > > const & expressions, VariableArray & variable_array, std::mutex & mutex )

static

Definition at line 242 of file Function.cpp.

{
    std::vector<double> result(expressions.size());
 
    {
        std::lock_guard lock_guard(mutex);
        updateVariableArrayValues(variables, new_variable_array,
                                  variable_array);
 
        std::transform(begin(expressions), end(expressions), begin(result),
                       [](auto const& e) { return e.value(); });
    }
 
    switch (result.size())
    {
        case 1:
        {
            return result[0];
        }
        case 2:
        {
            return Eigen::Vector2d{result[0], result[1]};
        }
        case 3:
        {
            return Eigen::Vector3d{result[0], result[1], result[2]};
        }
        case 4:
        {
            Eigen::Matrix<double, 2, 2> m;
            m = Eigen::Map<Eigen::Matrix<double, 2, 2> const>(result.data(), 2,
                                                              2);
            return m;
        }
        case 9:
        {
            Eigen::Matrix<double, 3, 3> m;
            m = Eigen::Map<Eigen::Matrix<double, 3, 3> const>(result.data(), 3,
                                                              3);
            return m;
        }
    }
    OGS_FATAL("Cannot convert a vector of size {} to a PropertyDataType",
              result.size());
}

References OGS_FATAL, and updateVariableArrayValues().

Referenced by MaterialPropertyLib::Function::dValue(), and MaterialPropertyLib::Function::value().

fluidPhase()

Phase const & MaterialPropertyLib::fluidPhase

(

Medium const &

medium

)

Returns a gas or aqueous liquid phase of the given medium.

Definition at line 100 of file Medium.cpp.

{
    if (medium.hasPhase("Gas"))
    {
        return medium.phase("Gas");
    }
    if (medium.hasPhase("AqueousLiquid"))
    {
        return medium.phase("AqueousLiquid");
    }
    OGS_FATAL(
        "Neither Gas nor AqueousLiquid phase is available for the medium, but "
        "a fluid phase was requested.");
}

References MaterialPropertyLib::Medium::hasPhase(), OGS_FATAL, and MaterialPropertyLib::Medium::phase().

Referenced by checkMPLPhasesForSinglePhaseFlow().

formEffectiveThermalConductivity()

template<int GlobalDim>

Eigen::Matrix< double, GlobalDim, GlobalDim > MaterialPropertyLib::formEffectiveThermalConductivity	(	MaterialPropertyLib::PropertyDataType const &	solid_thermal_conductivity,
		const double	fluid_thermal_conductivity,
		const double	porosity )

Definition at line 19 of file FormEffectiveThermalConductivity.cpp.

{
    return (1.0 - porosity) *
               formEigenTensor<GlobalDim>(solid_thermal_conductivity) +
           porosity * fluid_thermal_conductivity *
               Eigen::Matrix<double, GlobalDim, GlobalDim>::Identity();
}

References formEigenTensor(), and porosity.

Referenced by ProcessLib::ThermalTwoPhaseFlowWithPP::ThermalTwoPhaseFlowWithPPLocalAssembler< ShapeFunction, GlobalDim >::assemble().

formEffectiveThermalConductivity< 1 >()

template Eigen::Matrix< double, 1, 1 > MaterialPropertyLib::formEffectiveThermalConductivity< 1 >	(	MaterialPropertyLib::PropertyDataType const &	solid_thermal_conductivity,
		const double	fluid_thermal_conductivity,
		const double	porosity )

formEffectiveThermalConductivity< 2 >()

template Eigen::Matrix< double, 2, 2 > MaterialPropertyLib::formEffectiveThermalConductivity< 2 >	(	MaterialPropertyLib::PropertyDataType const &	solid_thermal_conductivity,
		const double	fluid_thermal_conductivity,
		const double	porosity )

formEffectiveThermalConductivity< 3 >()

template Eigen::Matrix< double, 3, 3 > MaterialPropertyLib::formEffectiveThermalConductivity< 3 >	(	MaterialPropertyLib::PropertyDataType const &	solid_thermal_conductivity,
		const double	fluid_thermal_conductivity,
		const double	porosity )

formEigenTensor()

template<int GlobalDim>

Eigen::Matrix< double, GlobalDim, GlobalDim > MaterialPropertyLib::formEigenTensor

(

MaterialPropertyLib::PropertyDataType const &

values

)

Definition at line 115 of file FormEigenTensor.cpp.

{
    return std::visit(FormEigenTensor<GlobalDim>(), values);
}

Referenced by ProcessLib::HeatConduction::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::HT::MonolithicHTFEM< ShapeFunction, GlobalDim >::assemble(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::RichardsComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::RichardsFlow::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assemble(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::StokesFlow::LocalAssemblerData< ShapeFunctionLiquidVelocity, ShapeFunctionPressure, GlobalDim >::assemble(), ProcessLib::ThermalTwoPhaseFlowWithPP::ThermalTwoPhaseFlowWithPPLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::TwoPhaseFlowWithPP::TwoPhaseFlowWithPPLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::TwoPhaseFlowWithPrho::TwoPhaseFlowWithPrhoLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleBlockMatrices(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleComponentTransportEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleHeatTransportEquation(), ProcessLib::HT::StaggeredHTFEM< ShapeFunction, GlobalDim >::assembleHeatTransportEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleHydraulicEquation(), ProcessLib::HT::StaggeredHTFEM< ShapeFunction, GlobalDim >::assembleHydraulicEquation(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::assembleMatrixAndVector(), ProcessLib::HeatConduction::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobian(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assembleWithJacobian(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobianComponentTransportEquation(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianEvalConstitutiveSetting(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianForHeatConductionEquations(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianForPressureEquations(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobianHydraulicEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::calculateIntPtDarcyVelocity(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::computeProjectedDarcyVelocity(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::computeSecondaryVariableConcrete(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::computeSecondaryVariableConcrete(), ProcessLib::TH2M::ConstitutiveRelations::ThermalConductivityModel< DisplacementDim >::dEval(), ProcessLib::TH2M::ConstitutiveRelations::PermeabilityModel< DisplacementDim >::eval(), ProcessLib::TH2M::ConstitutiveRelations::ThermalConductivityModel< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::PermeabilityModel< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::ThermoOsmosisModel< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::TRMHeatStorageAndFluxModel< DisplacementDim >::eval(), formEffectiveThermalConductivity(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtDarcyVelocity(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::RichardsComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::RichardsFlow::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::getIntPtDarcyVelocityLocal(), ProcessLib::HeatConduction::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtHeatFlux(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtMolarFlux(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getThermalConductivityDispersivity(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::getThermalConductivityDispersivity(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveRelations(), and MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::value().

formEigenTensor< 1 >()

template Eigen::Matrix< double, 1, 1 > MaterialPropertyLib::formEigenTensor< 1 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenTensor< 2 >()

template Eigen::Matrix< double, 2, 2 > MaterialPropertyLib::formEigenTensor< 2 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenTensor< 3 >()

template Eigen::Matrix< double, 3, 3 > MaterialPropertyLib::formEigenTensor< 3 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

Referenced by ProcessLib::HeatTransportBHE::HeatTransportBHELocalAssemblerSoil< ShapeFunction >::assemble(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assemble(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assembleWithJacobian(), MaterialPropertyLib::EmbeddedFracturePermeability< DisplacementDim >::dValue(), ProcessLib::TH2M::ConstitutiveRelations::SwellingModel< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::ConstitutiveStress_StrainTemperature::SwellingModel< DisplacementDim >::eval(), ProcessLib::RichardsMechanics::updateSwellingStressAndVolumetricStrain(), MaterialPropertyLib::EmbeddedFracturePermeability< DisplacementDim >::value(), and MaterialPropertyLib::PermeabilityMohrCoulombFailureIndexModel< DisplacementDim >::value().

formEigenTensor< 4 >()

template Eigen::Matrix< double, 4, 4 > MaterialPropertyLib::formEigenTensor< 4 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenTensor< 6 >()

template Eigen::Matrix< double, 6, 6 > MaterialPropertyLib::formEigenTensor< 6 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenVector()

template<int GlobalDim>

Eigen::Matrix< double, GlobalDim, 1 > MaterialPropertyLib::formEigenVector

(

MaterialPropertyLib::PropertyDataType const &

values

)

Definition at line 90 of file FormEigenVector.cpp.

{
    return std::visit(FormEigenVector<GlobalDim>(), values);
}

formEigenVector< 1 >()

template Eigen::Matrix< double, 1, 1 > MaterialPropertyLib::formEigenVector< 1 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenVector< 2 >()

template Eigen::Matrix< double, 2, 1 > MaterialPropertyLib::formEigenVector< 2 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formEigenVector< 3 >()

template Eigen::Matrix< double, 3, 1 > MaterialPropertyLib::formEigenVector< 3 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

Referenced by ProcessLib::ThermoRichardsFlow::SimplifiedElasticityModel::bulkCompressibilityFromYoungsModulus(), ProcessLib::ThermoRichardsFlow::UniaxialElasticityModel::storageContribution(), and ProcessLib::ThermoRichardsFlow::UniaxialElasticityModel::thermalExpansivityContribution().

formKelvinVector()

template<int GlobalDim>

MathLib::KelvinVector::KelvinVectorType< GlobalDim > MaterialPropertyLib::formKelvinVector

(

MaterialPropertyLib::PropertyDataType const &

values

)

A function to form a Kelvin vector from strain or stress alike property like thermal expansivity for thermal strain.

It takes either a scalar number for isotropic thermal expansion or a three element vector or a 3 x 3 matrix for anisotropic properties, to get a Kelvin vector for strain or stress.

Parameters

values

e.g., Thermal expansivity, which can be scalar number, a three element vector or a 3 x 3 matrix.

Returns

Kelvin vector type property.

Definition at line 82 of file FormKelvinVector.cpp.

{
    return std::visit(FormKelvinVector<GlobalDim>(), values);
}

Referenced by ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianForDeformationEquations(), ProcessLib::TH2M::ConstitutiveRelations::SolidThermalExpansionModel< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::SolidThermalExpansionModel< DisplacementDim >::eval(), and ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveRelations().

formKelvinVector< 2 >()

template MathLib::KelvinVector::KelvinVectorType< 2 > MaterialPropertyLib::formKelvinVector< 2 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

formKelvinVector< 3 >()

template MathLib::KelvinVector::KelvinVectorType< 3 > MaterialPropertyLib::formKelvinVector< 3 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

fromVector()

PropertyDataType MaterialPropertyLib::fromVector

(

std::vector< double > const &

values

)

Conversion of a vector to PropertyDataType for different sizes of the vector.

Attention

This method cannot distinguish between 2x2 matrix and 4x1 vector.

Note

If the values vector stores all elements of a 2x2 or 3x3 matrix (i.e. the general case for 2x2 and 3x3 matrices), it is assumed to be in row major storage order.

Definition at line 23 of file Property.cpp.

{
    switch (values.size())
    {
        case 1:
        {
            return values[0];
        }
        case 2:
        {
            return Eigen::Vector2d{values[0], values[1]};
        }
        case 3:
        {
            return Eigen::Vector3d{values[0], values[1], values[2]};
        }
        case 4:
        {
            using M = Eigen::Matrix2d;
            // the values vector is in row major order
            using MRM = Eigen::Matrix<double, 2, 2, Eigen::RowMajor>;
            return M{Eigen::Map<MRM const>{values.data(), 2, 2}};
        }
        case 6:
        {
            // Symmetric Tensor - xx, yy, zz, xy, xz, yz
            using M = Eigen::Matrix<double, 6, 1>;
            return M{Eigen::Map<M const>{values.data(), 6}};
        }
        case 9:
        {
            using M = Eigen::Matrix3d;
            // the values vector is in row major order
            using MRM = Eigen::Matrix<double, 3, 3, Eigen::RowMajor>;
            return M{Eigen::Map<MRM const>{values.data(), 3, 3}};
        }
        default:
        {
            OGS_FATAL(
                "Conversion of a {:d}-vector to PropertyDataType is not "
                "implemented.",
                values.size());
        }
    }
}

References OGS_FATAL.

Referenced by createConstant(), MaterialPropertyLib::OrthotropicEmbeddedFracturePermeability< DisplacementDim >::dValue(), MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >::dValue(), MaterialPropertyLib::PorosityFromMassBalance::initialValue(), MaterialPropertyLib::TransportPorosityFromMassBalance::initialValue(), MaterialPropertyLib::DupuitPermeability::value(), MaterialPropertyLib::GasPressureDependentPermeability< DisplacementDim >::value(), MaterialPropertyLib::KozenyCarmanModel::value(), MaterialPropertyLib::OrthotropicEmbeddedFracturePermeability< DisplacementDim >::value(), MaterialPropertyLib::Parameter::value(), MaterialPropertyLib::Parameter::value(), MaterialPropertyLib::PermeabilityMohrCoulombFailureIndexModel< DisplacementDim >::value(), MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >::value(), MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >::value(), MaterialPropertyLib::TemperatureDependentDiffusion::value(), and MaterialPropertyLib::VermaPruessModel::value().

getLiquidThermalExpansivity()

double MaterialPropertyLib::getLiquidThermalExpansivity	(	Phase const &	phase,
		VariableArray const &	vars,
		const double	density,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt )

It gets the thermal expansion coefficient.

If the the thermal expansion coefficient is given in the project file via the media property of thermal_expansivity, e.g

*     <property>
*       <name>thermal_expansivity</name>
*       <type>Constant</type>
*       <value>2.07e-4</value>
*     </property>
* 

it returns the value of the given property. Otherwise it returns the value computed from the density model by the following formula

\[ (\frac{\partial \rho}{\partial T})/\rho \]

where \(\rho\) is the density, \(T\) is the temperature.

Definition at line 21 of file GetLiquidThermalExpansivity.cpp.

{
    // The thermal expansivity is explicitly given in the project file.
    if (phase.hasProperty(
            MaterialPropertyLib::PropertyType::thermal_expansivity))
    {
        return phase
            .property(MaterialPropertyLib::PropertyType::thermal_expansivity)
            .template value<double>(vars, pos, t, dt);
    }
 
    // The thermal expansivity calculated by the density model directly.
    return (density == 0.0)
               ? 0.0
               : -phase.property(MaterialPropertyLib::PropertyType::density)
                         .template dValue<double>(
                             vars, MaterialPropertyLib::Variable::temperature,
                             pos, t, dt) /
                     density;
}

References density, MaterialPropertyLib::Phase::hasProperty(), MaterialPropertyLib::Phase::property(), temperature, and thermal_expansivity.

Referenced by ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::assembleWithJacobian(), ProcessLib::ThermoRichardsMechanics::FluidThermalExpansionModel< DisplacementDim >::eval(), and ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveRelations().

getSymmetricTensor()

template<int GlobalDim>

SymmetricTensor< GlobalDim > MaterialPropertyLib::getSymmetricTensor

(

MaterialPropertyLib::PropertyDataType const &

values

)

Definition at line 95 of file GetSymmetricTensor.cpp.

{
    return std::visit(GetSymmetricTensor<GlobalDim>(), values);
}

Referenced by ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::computeSecondaryVariableConcrete().

getSymmetricTensor< 2 >()

template Eigen::Matrix< double, 4, 1 > MaterialPropertyLib::getSymmetricTensor< 2 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

getSymmetricTensor< 3 >()

template Eigen::Matrix< double, 6, 1 > MaterialPropertyLib::getSymmetricTensor< 3 >

(

MaterialPropertyLib::PropertyDataType const &

values

)

humidity()

static double MaterialPropertyLib::humidity ( double const T, double const p, double const water_density )

static

Definition at line 34 of file WaterVapourDensity.cpp.

{
    return std::exp(
        p / (MaterialLib::PhysicalConstant::SpecificGasConstant::WaterVapour *
             T * water_density));
}

References MaterialLib::PhysicalConstant::SpecificGasConstant::WaterVapour.

Referenced by MaterialPropertyLib::WaterVapourDensity::dValue(), and MaterialPropertyLib::WaterVapourDensity::value().

newComponent()

std::unique_ptr< Component > MaterialPropertyLib::newComponent	(	std::string const &	component_name,
		bool &	isCustomComponent )

Method for creating a new component based on the specified component name.

This function creates a new component based on the (optional) component name that is given in the prj-file.

The method evaluates the string in the 'name'-object and calls the constructors of the derived component classes (if found) or that of the base class (if no name is specified).

overwriteExistingProperties()

void MaterialPropertyLib::overwriteExistingProperties ( PropertyArray & properties, PropertyArray & new_properties, std::variant< Medium *, Phase *, Component * > scale_pointer )

inline

Definition at line 322 of file Property.h.

{
    for (std::size_t i = 0; i < properties.size(); ++i)
    {
        if (new_properties[i] != nullptr)
        {
            properties[i] = std::move(new_properties[i]);
            properties[i]->setScale(scale_pointer);
        }
    }
}

Referenced by MaterialPropertyLib::Component::Component(), MaterialPropertyLib::Medium::Medium(), and MaterialPropertyLib::Phase::Phase().

saturatedVaporDensity()

static double MaterialPropertyLib::saturatedVaporDensity ( double const T )

static

\(\rho_{vS}\)

Definition at line 23 of file WaterVapourDensity.cpp.

{
    return 1.0e-3 * std::exp(19.819 - 4975.9 / T);
}

Referenced by MaterialPropertyLib::WaterVapourDensity::dValue(), and MaterialPropertyLib::WaterVapourDensity::value().

tensorSize()

int MaterialPropertyLib::tensorSize ( int dim )

constexpr

See Tensor type for details.

Definition at line 19 of file Tensor.h.

{
    if (dim == 1)
    {
        return 3;  // Diagonal entries.
    }
    if (dim == 2)
    {
        return 5;  // 2x2 matrix and the 3rd diagonal entry.
    }
    if (dim == 3)
    {
        return 9;  // Full 3x3 matrix.
    }
    OGS_FATAL("Tensor size for dimension {} is not defined.", dim);
}

References OGS_FATAL.

Referenced by ProcessLib::LargeDeformation::computeSigmaGeom(), MaterialLib::Solids::MFront::Variable< Derived >::rows(), and MaterialLib::Solids::MFront::OGSMFrontTangentOperatorBlocksView< DisplacementDim, ForcesGradsCombinations >::size().

updatePropertiesForAllPhases()

void MaterialPropertyLib::updatePropertiesForAllPhases ( PropertyArray & properties, std::vector< std::unique_ptr< Phase > > const & phases )

inline

Definition at line 338 of file Property.h.

{
    for (auto& p : properties)
    {
        if (p != nullptr)
        {
            p->setProperties(phases);
        }
    }
}

Referenced by MaterialPropertyLib::Medium::Medium().

updateVariableArrayValues()

static void MaterialPropertyLib::updateVariableArrayValues ( std::vector< Variable > const & variables, VariableArray const & new_variable_array, VariableArray & variable_array )

static

Definition at line 144 of file Function.cpp.

{
    for (auto const& variable : variables)
    {
        auto assign_scalar =
            [&variable, &new_variable_array](VariableArray::Scalar* address)
        {
            double const value = *std::get<VariableArray::Scalar const*>(
                new_variable_array.address_of(variable));
 
            if (std::isnan(value))
            {
                OGS_FATAL(
                    "Function property: Scalar variable '{:s}' is not "
                    "initialized.",
                    variable_enum_to_string[static_cast<int>(variable)]);
            }
 
            *address = value;
        };
        auto assign_kelvin_vector = [&variable, &new_variable_array](
                                        VariableArray::KelvinVector* address)
        {
            auto assign_value = [&destination = *address,
                                 &variable]<typename S>(S const& source)
            {
                if constexpr (std::is_same_v<S, std::monostate>)
                {
                    OGS_FATAL(
                        "Function property: Kelvin vector variable '{:s}' is "
                        "not initialized.",
                        variable_enum_to_string[static_cast<int>(variable)]);
                }
                else
                {
                    if (std::holds_alternative<S>(destination))
                    {
                        std::get<S>(destination) = MathLib::KelvinVector::
                            kelvinVectorToSymmetricTensor(source);
                    }
                    else
                    {
                        OGS_FATAL(
                            "Function property: Mismatch of Kelvin vector "
                            "sizes for variable {:s}.",
                            variable_enum_to_string[static_cast<int>(
                                variable)]);
                    }
                }
            };
            std::visit(assign_value,
                       *std::get<VariableArray::KelvinVector const*>(
                           new_variable_array.address_of(variable)));
        };
        auto assign_deformation_gradient =
            [&variable,
             &new_variable_array](VariableArray::DeformationGradient* address)
        {
            auto assign_value = [&destination = *address,
                                 &variable]<typename S>(S const& source)
            {
                if constexpr (std::is_same_v<S, std::monostate>)
                {
                    OGS_FATAL(
                        "Function property: Vectorized tensor variable '{:s}' "
                        "is not initialized.",
                        variable_enum_to_string[static_cast<int>(variable)]);
                }
                else
                {
                    if (std::holds_alternative<S>(destination))
                    {
                        std::get<S>(destination) = source;
                    }
                    else
                    {
                        OGS_FATAL(
                            "Function property: Mismatch of vectorized tensor "
                            "sizes for variable {:s}.",
                            variable_enum_to_string[static_cast<int>(
                                variable)]);
                    }
                }
            };
            std::visit(assign_value,
                       *std::get<VariableArray::DeformationGradient const*>(
                           new_variable_array.address_of(variable)));
        };
 
        variable_array.visitVariable(
            BaseLib::Overloaded{assign_scalar, assign_kelvin_vector,
                                assign_deformation_gradient},
            variable);
    }
}

References MaterialPropertyLib::VariableArray::address_of(), MathLib::KelvinVector::kelvinVectorToSymmetricTensor(), OGS_FATAL, variable_enum_to_string, and MaterialPropertyLib::VariableArray::visitVariable().

Referenced by evaluateExpressions().

Variable Documentation

alpha

double MaterialPropertyLib::alpha = 1. / 8.

constexpr

Definition at line 26 of file WaterVapourLatentHeatWithCriticalTemperature.cpp.

Referenced by MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::dValue(), MaterialPropertyLib::PengRobinson::value(), and MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::value().

beta

double MaterialPropertyLib::beta = 1. / 3.

constexpr

Definition at line 27 of file WaterVapourLatentHeatWithCriticalTemperature.cpp.

Referenced by MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::dValue(), MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::value(), and MaterialPropertyLib::IAPWSIF97Region4::waterSaturationTemperature().

c

std::array MaterialPropertyLib::c

constexpr

Initial value:

= {1989.41582,    11178.45586,  26923.68994,
                          -28989.28947,  -19797.03646, 28403.32283,
                          -30382.306422, 15210.380}

Definition at line 30 of file WaterVapourLatentHeatWithCriticalTemperature.cpp.

                       {1989.41582,    11178.45586,  26923.68994,
                          -28989.28947,  -19797.03646, 28403.32283,
                          -30382.306422, 15210.380};

Referenced by checkRequiredProperties(), createComponents(), createPermeabilityMohrCoulombFailureIndexModel(), MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::dValue(), MaterialPropertyLib::AverageMolarMass::value(), and MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::value().

Delta

double MaterialPropertyLib::Delta = 0.79 - beta

constexpr

Definition at line 28 of file WaterVapourLatentHeatWithCriticalTemperature.cpp.

Referenced by MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::dValue(), and MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::value().

EmptyVariableArray

const VariableArray MaterialPropertyLib::EmptyVariableArray {}

static

Definition at line 202 of file VariableType.h.

{};

Referenced by MaterialPropertyLib::Property::dValue(), MaterialPropertyLib::Property::initialValue(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postNonLinearSolverConcrete(), and MaterialPropertyLib::Property::value().

error_info

const char MaterialPropertyLib::error_info[]

staticconstexpr

Initial value:

=
    "The conversion to a Kelvin vector of correct dimensionality is ambiguous."
    "Please use a scalar number for isotropic properties, a three element "
    "array or a 3 x 3 matrix for anisotropic properties."

Definition at line 18 of file FormKelvinVector.cpp.

Referenced by MaterialPropertyLib::FormKelvinVector< GlobalDim >::operator()(), MaterialPropertyLib::FormKelvinVector< GlobalDim >::operator()(), MaterialPropertyLib::FormKelvinVector< GlobalDim >::operator()(), MaterialPropertyLib::FormKelvinVector< GlobalDim >::operator()(), and MaterialPropertyLib::FormKelvinVector< GlobalDim >::operator()().

gibbs_free_energy_

const MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1 MaterialPropertyLib::gibbs_free_energy_

Definition at line 24 of file WaterEnthalpyIAPWSIF97Region1.cpp.

Referenced by MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::dValue(), MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::value(), MaterialPropertyLib::WaterLiquidDensityIAPWSIF97Region4::value(), and MaterialPropertyLib::WaterLiquidEnthalpyIAPWSIF97Region4::value().

Hi

const double MaterialPropertyLib::Hi[4] = {1.67752, 2.20462, 0.6366564, -0.241605}

static

Definition at line 21 of file WaterViscosityIAPWS.cpp.

{1.67752, 2.20462, 0.6366564, -0.241605};

Referenced by computeBarMu0Factor(), and computedBarMu_dbarT().

Hij

const double MaterialPropertyLib::Hij[6][7]

static

Initial value:

= {
    {0.520094, 0.222531, -0.281378, 0.161913, -0.0325372, 0, 0},
    {0.0850895, 0.999115, -0.906851, 0.257399, 0, 0, 0},
    {-1.08374, 1.88797, -0.772479, 0, 0, 0, 0},
    {-0.289555, 1.26613, -0.489837, 0, 0.0698452, 0, -0.00435673},
    {0, 0, -0.25704, 0, 0, 0.00872102, 0},
    {0, 0.120573, 0, 0, 0, 0, -0.000593264}}

Definition at line 22 of file WaterViscosityIAPWS.cpp.

                                {
    {0.520094, 0.222531, -0.281378, 0.161913, -0.0325372, 0, 0},
    {0.0850895, 0.999115, -0.906851, 0.257399, 0, 0, 0},
    {-1.08374, 1.88797, -0.772479, 0, 0, 0, 0},
    {-0.289555, 1.26613, -0.489837, 0, 0.0698452, 0, -0.00435673},
    {0, 0, -0.25704, 0, 0, 0.00872102, 0},
    {0, 0.120573, 0, 0, 0, 0, -0.000593264}};

Referenced by computeBarMu1Factor(), computedBarMu_dbarRho(), and computedBarMu_dbarT().

I_T

std::array MaterialPropertyLib::I_T

staticconstexpr

Initial value:

= {0, 0, 0, 0, 0, 0, 1, 1, 1, 1,
                                   1, 1, 1, 2, 2, 3, 3, 4, 5, 6}

Definition at line 29 of file WaterTemperatureIAPWSIF97Region1.cpp.

                                {0, 0, 0, 0, 0, 0, 1, 1, 1, 1,
                                   1, 1, 1, 2, 2, 3, 3, 4, 5, 6};

Referenced by computeTemperature().

J_T

std::array MaterialPropertyLib::J_T

staticconstexpr

Initial value:

= {0, 1,  2,  6,  22, 32, 0,  1,  2,  3,
                                   4, 10, 32, 10, 32, 10, 32, 32, 32, 32}

Definition at line 32 of file WaterTemperatureIAPWSIF97Region1.cpp.

                                {0, 1,  2,  6,  22, 32, 0,  1,  2,  3,
                                   4, 10, 32, 10, 32, 10, 32, 32, 32, 32};

Referenced by computeTemperature().

Li

const double MaterialPropertyLib::Li[5]

static

Initial value:

= {2.443221e-3, 1.323095e-2, 6.770357e-3,
                             -3.454586e-3, 4.096266e-4}

Definition at line 22 of file WaterThermalConductivityIAPWS.cpp.

                            {2.443221e-3, 1.323095e-2, 6.770357e-3,
                             -3.454586e-3, 4.096266e-4};

Referenced by computeBarLambda0Factor(), and computedBarLambda_dbarT().

Lij

const double MaterialPropertyLib::Lij[5][6]

static

Initial value:

= {
    {1.60397357, -0.646013523, 0.111443906, 0.102997357, -0.0504123634,
     0.00609859258},
    {2.33771842, -2.78843778, 1.53616167, -0.463045512, 0.0832827019,
     -0.00719201245},
    {2.19650529, -4.54580785, 3.55777244, -1.40944978, 0.275418278,
     -0.0205938816},
    {-1.21051378, 1.60812989, -0.621178141, 0.0716373224, 0, 0},
    {-2.7203370, 4.57586331, -3.18369245, 1.1168348, -0.19268305, 0.012913842}}

Definition at line 24 of file WaterThermalConductivityIAPWS.cpp.

                                {
    {1.60397357, -0.646013523, 0.111443906, 0.102997357, -0.0504123634,
     0.00609859258},
    {2.33771842, -2.78843778, 1.53616167, -0.463045512, 0.0832827019,
     -0.00719201245},
    {2.19650529, -4.54580785, 3.55777244, -1.40944978, 0.275418278,
     -0.0205938816},
    {-1.21051378, 1.60812989, -0.621178141, 0.0716373224, 0, 0},
    {-2.7203370, 4.57586331, -3.18369245, 1.1168348, -0.19268305, 0.012913842}};

Referenced by computeBarLambda1Factor(), computedBarLambda_dbarRho(), and computedBarLambda_dbarT().

n_T

std::array MaterialPropertyLib::n_T

staticconstexpr

Initial value:

= {
    -0.23872489924521e3,  0.40421188637945e3,   0.11349746881718e3,
    -0.58457616048039e1,  -0.15285482413140e-3, -0.10866707695377e-5,
    -0.13391744872602e2,  0.43211039183559e2,   -0.54010067170506e2,
    0.30535892203916e2,   -0.65964749423638e1,  0.93965400878363e-2,
    0.11573647505340e-6,  -0.25858641282073e-4, -0.40644363084799e-8,
    0.66456186191635e-7,  0.80670734103027e-10, -0.93477771213947e-12,
    0.58265442020601e-14, -0.15020185953503e-16}

Definition at line 20 of file WaterTemperatureIAPWSIF97Region1.cpp.

                                {
    -0.23872489924521e3,  0.40421188637945e3,   0.11349746881718e3,
    -0.58457616048039e1,  -0.15285482413140e-3, -0.10866707695377e-5,
    -0.13391744872602e2,  0.43211039183559e2,   -0.54010067170506e2,
    0.30535892203916e2,   -0.65964749423638e1,  0.93965400878363e-2,
    0.11573647505340e-6,  -0.25858641282073e-4, -0.40644363084799e-8,
    0.66456186191635e-7,  0.80670734103027e-10, -0.93477771213947e-12,
    0.58265442020601e-14, -0.15020185953503e-16};

Referenced by computeTemperature().

property_enum_to_string

const std::array<std::string, PropertyType::number_of_properties> MaterialPropertyLib::property_enum_to_string

static

Definition at line 119 of file PropertyType.h.

                           {{"acentric_factor",
                             "binary_interaction_coefficient",
                             "biot_coefficient",
                             "bishops_effective_stress",
                             "brooks_corey_exponent",
                             "bulk_modulus",
                             "capillary_pressure",
                             "critical_density",
                             "critical_pressure",
                             "critical_temperature",
                             "compressibility",
                             "concentration",
                             "decay_rate",
                             "density",
                             "diffusion",
                             "drhodT",
                             "effective_stress",
                             "enthalpy",
                             "entry_pressure",
                             "evaporation_enthalpy",
                             "fredlund_parameters",
                             "heat_capacity",
                             "henry_coefficient",
                             "longitudinal_dispersivity",
                             "molality",
                             "molar_mass",
                             "molar_volume",
                             "mole_fraction",
                             "molecular_diffusion",
                             "name",
                             "permeability",
                             "phase_change_expansivity",
                             "phase_velocity",
                             "pore_diffusion",
                             "poissons_ratio",
                             "porosity",
                             "reference_density",
                             "reference_temperature",
                             "reference_pressure",
                             "relative_permeability",
                             "relative_permeability_nonwetting_phase",
                             "residual_gas_saturation",
                             "residual_liquid_saturation",
                             "retardation_factor",
                             "saturation",
                             "saturation_density",
                             "saturation_enthalpy",
                             "saturation_micro",
                             "saturation_temperature",
                             "specific_heat_capacity",
                             "specific_latent_heat",
                             "storage",
                             "storage_contribution",
                             "swelling_stress_rate",
                             "temperature",
                             "thermal_conductivity",
                             "thermal_diffusion_enhancement_factor",
                             "thermal_expansivity",
                             "thermal_expansivity_contribution",
                             "thermal_longitudinal_dispersivity",
                             "thermal_osmosis_coefficient",
                             "thermal_transversal_dispersivity",
                             "tortuosity",
                             "transport_porosity",
                             "transversal_dispersivity",
                             "vapour_pressure",
                             "viscosity",
                             "volume_fraction",
                             "youngs_modulus"}};

Referenced by checkRequiredProperties(), checkRequiredProperties(), checkRequiredProperties(), convertStringToProperty(), anonymous_namespace{PhaseTransition.cpp}::findComponentIndex(), MaterialPropertyLib::Component::property(), MaterialPropertyLib::Medium::property(), MaterialPropertyLib::Phase::property(), and MaterialPropertyLib::VolumeFractionAverage::setProperties().

ref_p_

double MaterialPropertyLib::ref_p_ = 1.653e7

staticconstexpr

reference pressure in Pa.

Definition at line 27 of file WaterEnthalpyIAPWSIF97Region1.cpp.

Referenced by MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::dValue(), MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::value(), MaterialPropertyLib::WaterLiquidDensityIAPWSIF97Region4::value(), MaterialPropertyLib::WaterLiquidEnthalpyIAPWSIF97Region4::value(), MaterialPropertyLib::WaterTemperatureIAPWSIF97Region1::value(), MaterialPropertyLib::WaterVapourDensityIAPWSIF97Region4::value(), and MaterialPropertyLib::WaterVapourEnthalpyIAPWSIF97Region4::value().

ref_T_

double MaterialPropertyLib::ref_T_ = 1386

staticconstexpr

reference temperature in K.

Definition at line 26 of file WaterEnthalpyIAPWSIF97Region1.cpp.

Referenced by MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::dValue(), MaterialPropertyLib::WaterEnthalpyIAPWSIF97Region1::value(), MaterialPropertyLib::WaterLiquidDensityIAPWSIF97Region4::value(), MaterialPropertyLib::WaterLiquidEnthalpyIAPWSIF97Region4::value(), MaterialPropertyLib::WaterVapourDensityIAPWSIF97Region4::value(), and MaterialPropertyLib::WaterVapourEnthalpyIAPWSIF97Region4::value().

symmetric_tensor_size

template<int GlobalDim>

int MaterialPropertyLib::symmetric_tensor_size

constexpr

Initial value:

=
    MathLib::KelvinVector::kelvin_vector_dimensions(GlobalDim)

Definition at line 22 of file GetSymmetricTensor.h.

T_c

double MaterialPropertyLib::T_c

constexpr

Initial value:

=
    373.92 + MaterialLib::PhysicalConstant::CelsiusZeroInKelvin

Critical temperature.

Definition at line 24 of file WaterVapourLatentHeatWithCriticalTemperature.cpp.

Referenced by createTemperatureDependentFraction(), MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::dValue(), and MaterialPropertyLib::WaterVapourLatentHeatWithCriticalTemperature::value().

variable_enum_to_string

const std::array<std::string, static_cast<int>(Variable::number_of_variables)> MaterialPropertyLib::variable_enum_to_string

static

Initial value:

{{"capillary_pressure",
                             "concentration",
                             "deformation_gradient",
                             "density",
                             "effective_pore_pressure",
                             "enthalpy",
                             "enthalpy_of_evaporation",
                             "equivalent_plastic_strain",
                             "grain_compressibility",
                             "liquid_phase_pressure",
                             "liquid_saturation",
                             "mechanical_strain",
                             "molar_mass",
                             "molar_mass_derivative",
                             "molar_fraction",
                             "gas_phase_pressure",
                             "porosity",
                             "solid_grain_pressure",
                             "stress",
                             "temperature",
                             "total_strain",
                             "total_stress",
                             "transport_porosity",
                             "vapour_pressure",
                             "volumetric_strain"}}

Definition at line 61 of file VariableType.h.

                           {{"capillary_pressure",
                             "concentration",
                             "deformation_gradient",
                             "density",
                             "effective_pore_pressure",
                             "enthalpy",
                             "enthalpy_of_evaporation",
                             "equivalent_plastic_strain",
                             "grain_compressibility",
                             "liquid_phase_pressure",
                             "liquid_saturation",
                             "mechanical_strain",
                             "molar_mass",
                             "molar_mass_derivative",
                             "molar_fraction",
                             "gas_phase_pressure",
                             "porosity",
                             "solid_grain_pressure",
                             "stress",
                             "temperature",
                             "total_strain",
                             "total_stress",
                             "transport_porosity",
                             "vapour_pressure",
                             "volumetric_strain"}};

Referenced by convertStringToVariable(), MaterialPropertyLib::Function::dValue(), and updateVariableArrayValues().