Classes
class	ConstantFluidProperty
	Constant fluid properties. More...

class	IdealGasLaw
	Fluid density by ideal gas law. More...

class	LinearConcentrationAndPressureDependentDensity

class	LinearConcentrationDependentDensity

class	LinearTemperatureDependentDensity
	Linear temperature dependent density model. More...

class	LiquidDensity

class	WaterDensityIAPWSIF97Region1

class	FluidProperties
	Base class of fluid properties. More...

class	FluidPropertiesWithDensityDependentModels

class	PrimaryVariableDependentFluidProperties

class	FluidProperty
	Base class of fluid properties. More...

struct	DimensionLessGibbsFreeEnergyRegion1

class	LinearPressureDependentViscosity

class	TemperatureDependentViscosity

class	VogelsLiquidDynamicViscosity

struct	VogelsViscosityConstantsWater

struct	VogelsViscosityConstantsCO2

struct	VogelsViscosityConstantsCH4

class	WaterViscosityIAPWS
	A class for viscosity model that is defined by The International Association for the Properties of Water and Steam IAPWS More...

class	WaterVaporProperties

Enumerations
enum class	FluidPropertyType { Density = 0 , Viscosity = 1 , HeatCapacity = 2 , ThermalConductivity = 3 , Concentration = 4 , number_of_property_types = 5 }
	Fluid property type. More...

enum class	PropertyVariableType { T = 0 , p = 1 , rho = p , C = 2 , number_of_variables = 3 }
	Variable that determine the property. More...

Functions
static std::unique_ptr< FluidProperty >	createLiquidDensity (BaseLib::ConfigTree const &config)

static std::unique_ptr< FluidProperty >	createLinearTemperatureDependentDensity (BaseLib::ConfigTree const &config)

static std::unique_ptr< FluidProperty >	createLinearConcentrationDependentDensity (BaseLib::ConfigTree const &config)

static std::unique_ptr< FluidProperty >	createLinearConcentrationAndPressureDependentDensity (BaseLib::ConfigTree const &config)

std::unique_ptr< FluidProperty >	createFluidDensityModel (BaseLib::ConfigTree const &config)

std::unique_ptr< FluidProperties >	createFluidProperties (BaseLib::ConfigTree const &config)

std::unique_ptr< FluidProperty >	createSpecificFluidHeatCapacityModel (BaseLib::ConfigTree const &config)

std::unique_ptr< FluidProperty >	createFluidThermalConductivityModel (BaseLib::ConfigTree const &config)

static std::unique_ptr< FluidProperty >	createLinearPressureDependentViscosity (BaseLib::ConfigTree const &config)

static std::unique_ptr< FluidProperty >	createTemperatureDependentViscosity (BaseLib::ConfigTree const &config)

std::unique_ptr< FluidProperty >	createViscosityModel (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)

Variables
const unsigned	FluidPropertyTypeNumber

static const double	ni [34]

static const double	li [34]

static const double	ji [34]

const unsigned	PropertyVariableNumber

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

static const double	Hij [6][7]

static const double	temperature_0 = 373.15

static const double	p_0 = 101325.0
	reference temperature in [K] More...

static const double	h_wg = 2258000.0
	reference pressure More...

Enumeration Type Documentation

◆ FluidPropertyType

enum MaterialLib::Fluid::FluidPropertyType

strong

Fluid property type.

Enumerator
Density
Viscosity
HeatCapacity
ThermalConductivity
Concentration
number_of_property_types	Number of property types.

Definition at line 26 of file FluidProperties.h.

 {
     Density = 0,
     Viscosity = 1,
     HeatCapacity = 2,
     ThermalConductivity = 3,
     Concentration = 4,
     number_of_property_types = 5  
 };

◆ PropertyVariableType

enum MaterialLib::Fluid::PropertyVariableType

strong

Variable that determine the property.

Enumerator
T	temperature.
p	pressure.
rho	density. For some models, rho substitutes p
C	concentration.
number_of_variables	Number of property variables.

Definition at line 20 of file PropertyVariableType.h.

 {
     T = 0,                   
     p = 1,                   
     rho = p,                 
     C = 2,                   
     number_of_variables = 3  
 };

Function Documentation

◆ computeBarMu0Factor()

double MaterialLib::Fluid::computeBarMu0Factor ( const double barT )

static

Definition at line 78 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 MaterialLib::Fluid::WaterViscosityIAPWS::getValue().

◆ computeBarMu1Factor()

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

static

Definition at line 115 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 MaterialLib::Fluid::WaterViscosityIAPWS::getValue().

◆ computedBarMu_dbarRho()

double MaterialLib::Fluid::computedBarMu_dbarRho	(	const double	barT,
		double	bar_rho
	)

static

Definition at line 173 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 MaterialLib::Fluid::WaterViscosityIAPWS::getdValue().

◆ computedBarMu_dbarT()

double MaterialLib::Fluid::computedBarMu_dbarT	(	const double	barT,
		double	bar_rho
	)

static

Definition at line 132 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 MaterialLib::Fluid::WaterViscosityIAPWS::getdValue().

◆ computeSeriesFactorRhoForMu1()

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

static

Definition at line 103 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 MaterialLib::Fluid::WaterViscosityIAPWS::getValue().

◆ computeSeriesFactorTForMu1()

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

static

Definition at line 90 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 MaterialLib::Fluid::WaterViscosityIAPWS::getValue().

◆ createFluidDensityModel()

std::unique_ptr< FluidProperty > MaterialLib::Fluid::createFluidDensityModel ( BaseLib::ConfigTree const & config )

Create a density model

Parameters

config ConfigTree object has a tag of <density>

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__Constant__value

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__IdealGasLaw__molar_mass

Definition at line 125 of file CreateFluidDensityModel.cpp.

 {
     auto const type = config.peekConfigParameter<std::string>("type");
  
     if (type == "Constant")
     {
         config.checkConfigParameter("type", "Constant");
         return std::make_unique<ConstantFluidProperty>(
             config.getConfigParameter<double>("value"));
     }
     if (type == "LiquidDensity")
     {
         return createLiquidDensity(config);
     }
     if (type == "TemperatureDependent")
     {
         return createLinearTemperatureDependentDensity(config);
     }
     if (type == "ConcentrationDependent")
     {
         return createLinearConcentrationDependentDensity(config);
     }
     if (type == "ConcentrationAndPressureDependent")
     {
         return createLinearConcentrationAndPressureDependentDensity(config);
     }
     if (type == "IdealGasLaw")
     {
         config.checkConfigParameter("type", "IdealGasLaw");
         return std::make_unique<IdealGasLaw>(
             config.getConfigParameter<double>("molar_mass"));
     }
     if (type == "WaterDensityIAPWSIF97Region1")
     {
         return std::make_unique<WaterDensityIAPWSIF97Region1>();
     }
  
     OGS_FATAL(
         "The density type {:s} is unavailable.\n"
         "The available types are: \n\tConstant, \n\tLiquidDensity, "
         "\n\tTemperatureDependent, \n\tIdealGasLaw."
         "\n\tWaterDensityIAPWSIF97Region1\n",
         type.data());
 }

References BaseLib::ConfigTree::checkConfigParameter(), createLinearConcentrationAndPressureDependentDensity(), createLinearConcentrationDependentDensity(), createLinearTemperatureDependentDensity(), createLiquidDensity(), BaseLib::ConfigTree::getConfigParameter(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

Referenced by createFluidProperties(), MaterialLib::TwoPhaseFlowWithPP::createTwoPhaseFlowMaterialProperties(), and ProcessLib::TwoPhaseFlowWithPrho::createTwoPhaseFlowPrhoMaterialProperties().

◆ createFluidProperties()

std::unique_ptr< FluidProperties > MaterialLib::Fluid::createFluidProperties ( BaseLib::ConfigTree const & config )

Create an instance of class FluidProperties

Parameters

config ConfigTree object has tags of <fluid>

Input File Parameter:: material__fluid__density

Input File Parameter:: material__fluid__viscosity

Input File Parameter:: material__fluid__specific_heat_capacity

Input File Parameter:: material__fluid__thermal_conductivity

Definition at line 29 of file CreateFluidProperties.cpp.

 {
     auto const& rho_conf = config.getConfigSubtree("density");
     auto liquid_density = MaterialLib::Fluid::createFluidDensityModel(rho_conf);
  
     auto const& mu_conf = config.getConfigSubtree("viscosity");
     auto viscosity = MaterialLib::Fluid::createViscosityModel(mu_conf);
     const bool is_mu_density_dependent =
         (viscosity->getName().find("density dependent") != std::string::npos);
  
     bool is_cp_density_dependent = false;
     std::unique_ptr<MaterialLib::Fluid::FluidProperty> specific_heat_capacity =
         nullptr;
     auto heat_capacity__opt_conf =
         config.getConfigSubtreeOptional("specific_heat_capacity");
     if (heat_capacity__opt_conf)
     {
         const auto& heat_capacity_conf = *heat_capacity__opt_conf;
         specific_heat_capacity =
             createSpecificFluidHeatCapacityModel(heat_capacity_conf);
         is_cp_density_dependent =
             (specific_heat_capacity->getName().find("density dependent") !=
              std::string::npos);
     }
  
     bool is_KT_density_dependent = false;
     std::unique_ptr<MaterialLib::Fluid::FluidProperty> thermal_conductivity =
         nullptr;
     auto const& thermal_conductivity_opt_conf =
         config.getConfigSubtreeOptional("thermal_conductivity");
     if (thermal_conductivity_opt_conf)
     {
         auto const& thermal_conductivity_conf = *thermal_conductivity_opt_conf;
         thermal_conductivity =
             MaterialLib::Fluid::createFluidThermalConductivityModel(
                 thermal_conductivity_conf);
         is_KT_density_dependent =
             (specific_heat_capacity->getName().find("density dependent") !=
              std::string::npos);
     }
  
     if (is_mu_density_dependent || is_cp_density_dependent ||
         is_KT_density_dependent)
     {
         return std::make_unique<
             MaterialLib::Fluid::FluidPropertiesWithDensityDependentModels>(
             std::move(liquid_density), std::move(viscosity),
             std::move(specific_heat_capacity), std::move(thermal_conductivity),
             is_mu_density_dependent, is_cp_density_dependent,
             is_KT_density_dependent);
     }
  
     return std::make_unique<
         MaterialLib::Fluid::PrimaryVariableDependentFluidProperties>(
         std::move(liquid_density), std::move(viscosity),
         std::move(specific_heat_capacity), std::move(thermal_conductivity));
 }

References createFluidDensityModel(), createFluidThermalConductivityModel(), createSpecificFluidHeatCapacityModel(), createViscosityModel(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeOptional(), MaterialPropertyLib::specific_heat_capacity, MaterialPropertyLib::thermal_conductivity, and MaterialPropertyLib::viscosity.

◆ createFluidThermalConductivityModel()

std::unique_ptr< FluidProperty > MaterialLib::Fluid::createFluidThermalConductivityModel ( BaseLib::ConfigTree const & config )

Create a thermal conductivity model

Parameters

config ConfigTree object has a tag of <thermal_conductivity>

Input File Parameter:: material__fluid__thermal_conductivity__type

Input File Parameter:: material__fluid__thermal_conductivity__Constant__value

Definition at line 24 of file CreateFluidThermalConductivityModel.cpp.

 {
     auto const type = config.getConfigParameter<std::string>("type");
  
     if (type == "Constant")
     {
         return std::make_unique<ConstantFluidProperty>(
             config.getConfigParameter<double>("value"));
     }
     // TODO: add more models
  
     OGS_FATAL(
         "The viscosity type {:s} is unavailable.\n"
         "The available type is \n\tConstant\n",
         type.data());
 }

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

Referenced by createFluidProperties(), and ProcessLib::ThermalTwoPhaseFlowWithPP::createThermalTwoPhaseFlowWithPPMaterialProperties().

◆ createLinearConcentrationAndPressureDependentDensity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createLinearConcentrationAndPressureDependentDensity ( BaseLib::ConfigTree const & config )

static

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__ConcentrationAndPressureDependent__reference_density

Input File Parameter:: material__fluid__density__ConcentrationAndPressureDependent__reference_concentration

Input File Parameter:: material__fluid__density__ConcentrationAndPressureDependent__fluid_density_concentration_difference_ratio

Input File Parameter:: material__fluid__density__ConcentrationAndPressureDependent__reference_pressure

Input File Parameter:: material__fluid__density__ConcentrationAndPressureDependent__fluid_density_pressure_difference_ratio

Definition at line 94 of file CreateFluidDensityModel.cpp.

 {
     config.checkConfigParameter("type", "ConcentrationAndPressureDependent");
  
     const auto reference_density =
         config.getConfigParameter<double>("reference_density");
     const auto reference_concentration =
         config.getConfigParameter<double>("reference_concentration");
     const auto fluid_density_concentration_difference_ratio =
         config.getConfigParameter<double>(
             "fluid_density_concentration_difference_ratio");
     const auto reference_pressure =
         config.getConfigParameter<double>("reference_pressure");
     const auto fluid_density_pressure_difference_ratio =
         config.getConfigParameter<double>(
             "fluid_density_pressure_difference_ratio");
     return std::make_unique<LinearConcentrationAndPressureDependentDensity>(
         reference_density,
         reference_concentration,
         fluid_density_concentration_difference_ratio,
         reference_pressure,
         fluid_density_pressure_difference_ratio);
 }

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigParameter(), MaterialPropertyLib::reference_density, and MaterialPropertyLib::reference_pressure.

Referenced by createFluidDensityModel().

◆ createLinearConcentrationDependentDensity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createLinearConcentrationDependentDensity ( BaseLib::ConfigTree const & config )

static

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__ConcentrationDependent__reference_density

Input File Parameter:: material__fluid__density__ConcentrationDependent__reference_concentration

Input File Parameter:: material__fluid__density__ConcentrationDependent__fluid_density_difference_ratio

Definition at line 73 of file CreateFluidDensityModel.cpp.

 {
     config.checkConfigParameter("type", "ConcentrationDependent");
  
     const auto reference_density =
         config.getConfigParameter<double>("reference_density");
     const auto reference_concentration =
         config.getConfigParameter<double>("reference_concentration");
     const auto fluid_density_difference_ratio =
         config.getConfigParameter<double>("fluid_density_difference_ratio");
     return std::make_unique<LinearConcentrationDependentDensity>(
         reference_density,
         reference_concentration,
         fluid_density_difference_ratio);
 }

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigParameter(), and MaterialPropertyLib::reference_density.

Referenced by createFluidDensityModel().

◆ createLinearPressureDependentViscosity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createLinearPressureDependentViscosity ( BaseLib::ConfigTree const & config )

static

Parameters

config ConfigTree object which contains the input data including <type>LinearPressure</type> and it has a tag of <viscosity>

Input File Parameter:: material__fluid__viscosity__type

Input File Parameter:: material__fluid__viscosity__LinearPressure__mu0

Input File Parameter:: material__fluid__viscosity__LinearPressure__p0

Input File Parameter:: material__fluid__viscosity__LinearPressure__gamma

Definition at line 31 of file CreateViscosityModel.cpp.

 {
     config.checkConfigParameter("type", "LinearPressure");
  
     const auto mu0 = config.getConfigParameter<double>("mu0");
  
     const auto p0 = config.getConfigParameter<double>("p0");
  
     const auto gamma = config.getConfigParameter<double>("gamma");
  
     return std::make_unique<LinearPressureDependentViscosity>(mu0, p0, gamma);
 }

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

Referenced by createViscosityModel().

◆ createLinearTemperatureDependentDensity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createLinearTemperatureDependentDensity ( BaseLib::ConfigTree const & config )

static

Parameters

config ConfigTree object which contains the input data <type>TemperatureDependent</type> and it has a tag of <density>

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__TemperatureDependent__rho0

Input File Parameter:: material__fluid__density__TemperatureDependent__temperature0

Input File Parameter:: material__fluid__density__TemperatureDependent__beta

Definition at line 58 of file CreateFluidDensityModel.cpp.

 {
     config.checkConfigParameter("type", "TemperatureDependent");
  
     const auto rho0 = config.getConfigParameter<double>("rho0");
     const auto T0 = config.getConfigParameter<double>("temperature0");
     const auto beta = config.getConfigParameter<double>("beta");
     return std::make_unique<LinearTemperatureDependentDensity>(rho0, T0, beta);
 }

References MaterialPropertyLib::beta, BaseLib::ConfigTree::checkConfigParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createFluidDensityModel().

◆ createLiquidDensity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createLiquidDensity ( BaseLib::ConfigTree const & config )

static

Parameters

config ConfigTree object which contains the input data including <type>LiquidDensity</type> and it has a tag of <density>

Input File Parameter:: material__fluid__density__type

Input File Parameter:: material__fluid__density__LiquidDensity__beta

Input File Parameter:: material__fluid__density__LiquidDensity__rho0

Input File Parameter:: material__fluid__density__LiquidDensity__temperature0

Input File Parameter:: material__fluid__density__LiquidDensity__p0

Input File Parameter:: material__fluid__density__LiquidDensity__bulk_modulus

Definition at line 34 of file CreateFluidDensityModel.cpp.

 {
     config.checkConfigParameter("type", "LiquidDensity");
  
     const auto beta = config.getConfigParameter<double>("beta");
     const auto rho0 = config.getConfigParameter<double>("rho0");
     const auto T0 = config.getConfigParameter<double>("temperature0");
     const auto p0 = config.getConfigParameter<double>("p0");
     const auto E = config.getConfigParameter<double>("bulk_modulus");
     return std::make_unique<LiquidDensity>(beta, rho0, T0, p0, E);
 }

References MaterialPropertyLib::beta, BaseLib::ConfigTree::checkConfigParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createFluidDensityModel().

◆ createSpecificFluidHeatCapacityModel()

std::unique_ptr< FluidProperty > MaterialLib::Fluid::createSpecificFluidHeatCapacityModel ( BaseLib::ConfigTree const & config )

Create a specific heat capacity model

Parameters

config ConfigTree object has a tag of <specific_heat_capacity>

Input File Parameter:: material__fluid__specific_heat_capacity__type

Input File Parameter:: material__fluid__specific_heat_capacity__Constant__value

Definition at line 24 of file CreateSpecificFluidHeatCapacityModel.cpp.

 {
     auto const type = config.getConfigParameter<std::string>("type");
  
     if (type == "Constant")
     {
         return std::make_unique<ConstantFluidProperty>(
             config.getConfigParameter<double>("value"));
     }
     // TODO: add more models
  
     OGS_FATAL(
         "The specific heat capacity type {:s} is unavailable.\n"
         "The available type is \n\tConstant\n",
         type.data());
 }

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

Referenced by createFluidProperties(), and ProcessLib::ThermalTwoPhaseFlowWithPP::createThermalTwoPhaseFlowWithPPMaterialProperties().

◆ createTemperatureDependentViscosity()

static std::unique_ptr<FluidProperty> MaterialLib::Fluid::createTemperatureDependentViscosity ( BaseLib::ConfigTree const & config )

static

Parameters

config ConfigTree object which contains the input data <type>TemperatureDependent</type> and it has a tag of <viscosity>

Input File Parameter:: material__fluid__viscosity__type

Input File Parameter:: material__fluid__viscosity__TemperatureDependent__mu0

Input File Parameter:: material__fluid__viscosity__TemperatureDependent__tc

Input File Parameter:: material__fluid__viscosity__TemperatureDependent__tv

Definition at line 54 of file CreateViscosityModel.cpp.

 {
     config.checkConfigParameter("type", "TemperatureDependent");
  
     const auto mu0 = config.getConfigParameter<double>("mu0");
  
     const auto Tc = config.getConfigParameter<double>("tc");
  
     const auto Tv = config.getConfigParameter<double>("tv");
  
     return std::make_unique<TemperatureDependentViscosity>(mu0, Tc, Tv);
 }

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

Referenced by createViscosityModel().

◆ createViscosityModel()

std::unique_ptr< FluidProperty > MaterialLib::Fluid::createViscosityModel ( BaseLib::ConfigTree const & config )

Create a viscosity model

Parameters

config ConfigTree object has a tag of <viscosity>

Input File Parameter:: material__fluid__viscosity__type

Input File Parameter:: material__fluid__viscosity__type

Input File Parameter:: material__fluid__viscosity__Constant__value

Input File Parameter:: material__fluid__viscosity__type

Input File Parameter:: material__fluid__viscosity__Vogels__liquid_type

Input File Parameter:: material__fluid__viscosity__Vogels__liquid_type

Input File Parameter:: material__fluid__viscosity__Vogels__liquid_type

Input File Parameter:: material__fluid__viscosity__Vogels__liquid_type

Input File Parameter:: material__fluid__viscosity__type

Definition at line 72 of file CreateViscosityModel.cpp.

 {
     auto const type = config.peekConfigParameter<std::string>("type");
  
     if (type == "Constant")
     {
         config.checkConfigParameter("type", "Constant");
         return std::make_unique<ConstantFluidProperty>(
             config.getConfigParameter<double>("value"));
     }
     if (type == "LinearPressure")
     {
         return createLinearPressureDependentViscosity(config);
     }
     if (type == "TemperatureDependent")
     {
         return createTemperatureDependentViscosity(config);
     }
     if (type == "Vogels")
     {
         config.checkConfigParameter("type", "Vogels");
  
         INFO("Using Vogels model, which gives viscosity in SI unit, Pa s");
         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<
                 VogelsLiquidDynamicViscosity<VogelsViscosityConstantsWater>>(
                 constants);
         }
         if (fluid_type == "CO2")
         {
             config.checkConfigParameter("liquid_type", "CO2");
             const VogelsViscosityConstantsCO2 constants;
             return std::make_unique<
                 VogelsLiquidDynamicViscosity<VogelsViscosityConstantsCO2>>(
                 constants);
         }
         if (fluid_type == "CH4")
         {
             config.checkConfigParameter("liquid_type", "CH4");
             const VogelsViscosityConstantsCH4 constants;
             return std::make_unique<
                 VogelsLiquidDynamicViscosity<VogelsViscosityConstantsCH4>>(
                 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());
     }
     if (type == "WaterViscosityIAPWS")
     {
         config.checkConfigParameter("type", "WaterViscosityIAPWS");
         return std::make_unique<WaterViscosityIAPWS>();
     }
  
     OGS_FATAL(
         "The viscosity type {:s} is unavailable.\n"
         "The available types are \n\tConstant, \n\tLinearPressure "
         "\n\tTemperatureDependent, \n\tVogels\n",
         type.data());
 }

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

Referenced by createFluidProperties(), MaterialLib::TwoPhaseFlowWithPP::createTwoPhaseFlowMaterialProperties(), and ProcessLib::TwoPhaseFlowWithPrho::createTwoPhaseFlowPrhoMaterialProperties().

Variable Documentation

◆ FluidPropertyTypeNumber

const unsigned MaterialLib::Fluid::FluidPropertyTypeNumber

Initial value:

=

static_cast<unsigned>(FluidPropertyType::number_of_property_types)

Definition at line 36 of file FluidProperties.h.

◆ h_wg

const double MaterialLib::Fluid::h_wg = 2258000.0

static

reference pressure

Definition at line 26 of file WaterVaporProperties.cpp.

Referenced by MaterialLib::Fluid::WaterVaporProperties::calculateDerivativedPsatdT(), MaterialLib::Fluid::WaterVaporProperties::calculateSaturatedVaporPressure(), and MaterialLib::Fluid::WaterVaporProperties::getWaterVaporEnthalpySimple().

◆ Hi

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

static

Definition at line 22 of file WaterViscosityIAPWS.cpp.

Referenced by computeBarMu0Factor(), and computedBarMu_dbarT().

◆ Hij

const double MaterialLib::Fluid::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 23 of file WaterViscosityIAPWS.cpp.

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

◆ ji

const double MaterialLib::Fluid::ji[34]

static

Initial value:

= {
    -2, -1, 0,  1, 2, 3,  4,  5,  -9, -7,  -1, 0,   1,   3,   -3,  0,   1,
    3,  17, -4, 0, 6, -5, -2, 10, -8, -11, -6, -29, -31, -38, -39, -40, -41}

Definition at line 41 of file DimensionLessGibbsFreeEnergyRegion1.cpp.

Referenced by MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dtau(), and MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_gamma().

◆ li

const double MaterialLib::Fluid::li[34]

static

Initial value:

= {0, 0, 0, 0, 0,  0,  0,  0,  1,  1, 1, 1,
                              1, 1, 2, 2, 2,  2,  2,  3,  3,  3, 4, 4,
                              4, 5, 8, 8, 21, 23, 29, 30, 31, 32}

Definition at line 37 of file DimensionLessGibbsFreeEnergyRegion1.cpp.

Referenced by MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dtau(), and MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_gamma().

◆ ni

const double MaterialLib::Fluid::ni[34]

static

Initial value:

= {
    1.4632971213167E-01,  -8.4548187169114E-01, -3.7563603672040E+00,
    3.3855169168385E+00,  -9.5791963387872E-01, 1.5772038513228E-01,
    -1.6616417199501E-02, 8.1214629983568E-04,  2.8319080123804E-04,
    -6.0706301565874E-04, -1.8990068218419E-02, -3.2529748770505E-02,
    -2.1841717175414E-02, -5.2838357969930E-05, -4.7184321073267E-04,
    -3.0001780793026E-04, 4.7661393906987E-05,  -4.4141845330846E-06,
    -7.2694996297594E-16, -3.1679644845054E-05, -2.8270797985312E-06,
    -8.5205128120103E-10, -2.2425281908000E-06, -6.5171222895601E-07,
    -1.4341729937924E-13, -4.0516996860117E-07, -1.2734301741641E-09,
    -1.7424871230634E-10, -6.8762131295531E-19, 1.4478307828521E-20,
    2.6335781662795E-23,  -1.1947622640071E-23, 1.8228094581404E-24,
    -9.35370872924580E-26}

Definition at line 23 of file DimensionLessGibbsFreeEnergyRegion1.cpp.

Referenced by MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dpi_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dpi(), MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_dgamma_dtau_dtau(), and MaterialLib::Fluid::DimensionLessGibbsFreeEnergyRegion1::get_gamma().

◆ p_0

const double MaterialLib::Fluid::p_0 = 101325.0

static

reference temperature in [K]

Definition at line 25 of file WaterVaporProperties.cpp.

Referenced by MaterialLib::Fluid::WaterVaporProperties::calculateDerivativedPsatdT(), and MaterialLib::Fluid::WaterVaporProperties::calculateSaturatedVaporPressure().

◆ PropertyVariableNumber

const unsigned MaterialLib::Fluid::PropertyVariableNumber

Initial value:

=

static_cast<unsigned>(PropertyVariableType::number_of_variables)

Definition at line 29 of file PropertyVariableType.h.

◆ temperature_0

const double MaterialLib::Fluid::temperature_0 = 373.15

static

Definition at line 24 of file WaterVaporProperties.cpp.

Referenced by MaterialLib::Fluid::WaterVaporProperties::calculateDerivativedPsatdT(), and MaterialLib::Fluid::WaterVaporProperties::calculateSaturatedVaporPressure().

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ FluidPropertyType

◆ PropertyVariableType

Function Documentation

◆ computeBarMu0Factor()

◆ computeBarMu1Factor()

◆ computedBarMu_dbarRho()

◆ computedBarMu_dbarT()

◆ computeSeriesFactorRhoForMu1()

◆ computeSeriesFactorTForMu1()

◆ createFluidDensityModel()

◆ createFluidProperties()

◆ createFluidThermalConductivityModel()

◆ createLinearConcentrationAndPressureDependentDensity()

◆ createLinearConcentrationDependentDensity()

◆ createLinearPressureDependentViscosity()

◆ createLinearTemperatureDependentDensity()

◆ createLiquidDensity()

◆ createSpecificFluidHeatCapacityModel()

◆ createTemperatureDependentViscosity()

◆ createViscosityModel()

Variable Documentation

◆ FluidPropertyTypeNumber

◆ h_wg

◆ Hi

◆ Hij

◆ ji

◆ li

◆ ni

◆ p_0

◆ PropertyVariableNumber

◆ temperature_0