Class for fluid properties read from a file. More...

#include <TabulatedBicubicFluidProperties.h>

Inheritance diagram for TabulatedBicubicFluidProperties:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	TabulatedBicubicFluidProperties (const InputParameters &parameters)

virtual void	constructInterpolation () override

virtual void	initialSetup () override

virtual std::string	fluidName () const override
	Fluid name. More...

virtual Real	molarMass () const override
	Molar mass [kg/mol]. More...

virtual Real	rho_from_p_T (Real pressure, Real temperature) const override

virtual ADReal	rho_from_p_T (const ADReal &pressure, const ADReal &temperature) const override

virtual void	rho_from_p_T (Real pressure, Real temperature, Real &rho, Real &drho_dp, Real &drho_dT) const override

virtual void	rho_from_p_T (const ADReal &pressure, const ADReal &temperature, ADReal &rho, ADReal &drho_dp, ADReal &drho_dT) const override

virtual Real	rho_from_p_s (Real p, Real s) const override

virtual void	rho_from_p_s (Real p, Real s, Real &rho, Real &drho_dp, Real &drho_ds) const override

virtual Real	v_from_p_T (Real pressure, Real temperature) const override

virtual ADReal	v_from_p_T (const ADReal &pressure, const ADReal &temperature) const override

virtual void	v_from_p_T (Real pressure, Real temperature, Real &v, Real &dv_dp, Real &dv_dT) const override

virtual Real	e_from_p_T (Real pressure, Real temperature) const override

virtual ADReal	e_from_p_T (const ADReal &pressure, const ADReal &temperature) const override

virtual void	e_from_p_T (Real pressure, Real temperature, Real &e, Real &de_dp, Real &de_dT) const override

virtual Real	e_from_p_rho (Real pressure, Real rho) const override

virtual ADReal	e_from_p_rho (const ADReal &pressure, const ADReal &rho) const override

virtual void	e_from_p_rho (Real pressure, Real rho, Real &e, Real &de_dp, Real &de_drho) const override

virtual Real	T_from_p_rho (Real pressure, Real rho) const

virtual ADReal	T_from_p_rho (const ADReal &pressure, const ADReal &rho) const

virtual void	T_from_p_rho (Real pressure, Real rho, Real &T, Real &dT_dp, Real &dT_drho) const

virtual Real	h_from_p_T (Real p, Real T) const override

virtual ADReal	h_from_p_T (const ADReal &pressure, const ADReal &temperature) const override

virtual void	h_from_p_T (Real pressure, Real temperature, Real &h, Real &dh_dp, Real &dh_dT) const override

virtual Real	mu_from_p_T (Real pressure, Real temperature) const override

virtual void	mu_from_p_T (Real pressure, Real temperature, Real &mu, Real &dmu_dp, Real &dmu_dT) const override

virtual Real	cp_from_p_T (Real pressure, Real temperature) const override

virtual void	cp_from_p_T (Real pressure, Real temperature, Real &cp, Real &dcp_dp, Real &dcp_dT) const override

virtual Real	cv_from_p_T (Real pressure, Real temperature) const override

virtual void	cv_from_p_T (Real pressure, Real temperature, Real &cv, Real &dcv_dp, Real &dcv_dT) const override

virtual Real	c_from_p_T (Real pressure, Real temperature) const override

virtual void	c_from_p_T (Real pressure, Real temperature, Real &c, Real &dc_dp, Real &dc_dT) const override

virtual Real	k_from_p_T (Real pressure, Real temperature) const override

virtual void	k_from_p_T (Real pressure, Real temperature, Real &k, Real &dk_dp, Real &dk_dT) const override

virtual Real	s_from_p_T (Real pressure, Real temperature) const override

virtual void	s_from_p_T (Real p, Real T, Real &s, Real &ds_dp, Real &ds_dT) const override

virtual std::vector< Real >	henryCoefficients () const override
	The following routines are simply forwarded to the 'fp' companion FluidProperties as they are not included in the tabulations presently. More...

virtual Real	vaporPressure (Real temperature) const override
	Vapor pressure. More...

virtual void	vaporPressure (Real temperature, Real &psat, Real &dpsat_dT) const override

virtual ADReal	vaporPressure (const ADReal &T) const

virtual Real	vaporTemperature (Real pressure) const override
	Vapor temperature. More...

virtual void	vaporTemperature (Real pressure, Real &Tsat, Real &dTsat_dp) const override

virtual ADReal	vaporTemperature (const ADReal &p) const

virtual Real	T_from_p_h (Real pressure, Real enthalpy) const override

virtual ADReal	T_from_p_h (const ADReal &pressure, const ADReal &enthalpy) const override

virtual Real	triplePointPressure () const override
	Triple point pressure. More...

virtual Real	triplePointTemperature () const override
	Triple point temperature. More...

virtual Real	criticalPressure () const override
	Critical pressure. More...

virtual Real	criticalTemperature () const override
	Critical temperature. More...

virtual Real	criticalDensity () const override
	Critical density. More...

virtual Real	p_from_v_e (Real v, Real e) const override
	Derivatives like dc_dv & dc_de are computed using the chain rule dy/dx(p,T) = dy/dp * dp/dx + dy/dT * dT/dx where y = c, cp, cv... More...

virtual void	p_from_v_e (Real v, Real e, Real &p, Real &dp_dv, Real &dp_de) const override

virtual void	p_from_v_e (const ADReal &v, const ADReal &e, ADReal &p, ADReal &dp_dv, ADReal &dp_de) const override

virtual Real	T_from_v_e (Real v, Real e) const override

virtual void	T_from_v_e (Real v, Real e, Real &T, Real &dT_dv, Real &dT_de) const override

virtual void	T_from_v_e (const ADReal &v, const ADReal &e, ADReal &p, ADReal &dp_dv, ADReal &dp_de) const override

virtual Real	c_from_v_e (Real v, Real e) const override

virtual void	c_from_v_e (Real v, Real e, Real &c, Real &dc_dv, Real &dc_de) const override

virtual Real	cp_from_v_e (Real v, Real e) const override

virtual void	cp_from_v_e (Real v, Real e, Real &cp, Real &dcp_dv, Real &dcp_de) const override

virtual Real	cv_from_v_e (Real v, Real e) const override

virtual void	cv_from_v_e (Real v, Real e, Real &cv, Real &dcv_dv, Real &dcv_de) const override

virtual Real	mu_from_v_e (Real v, Real e) const override

virtual void	mu_from_v_e (Real v, Real e, Real &mu, Real &dmu_dv, Real &dmu_de) const override

virtual Real	k_from_v_e (Real v, Real e) const override

virtual void	k_from_v_e (Real v, Real e, Real &k, Real &dk_dv, Real &dk_de) const override

virtual Real	g_from_v_e (Real v, Real e) const override

virtual Real	e_from_v_h (Real v, Real h) const override

virtual void	e_from_v_h (Real v, Real h, Real &e, Real &de_dv, Real &de_dh) const override

virtual Real	T_from_h_s (Real h, Real s) const

virtual Real	T_from_p_s (Real p, Real s) const

virtual void	T_from_p_s (Real p, Real s, Real &T, Real &dT_dp, Real &dT_ds) const

virtual Real	s_from_v_e (Real v, Real e) const override

virtual void	s_from_v_e (Real v, Real e, Real &s, Real &ds_dv, Real &ds_de) const override

virtual Real	s_from_h_p (Real h, Real pressure) const override

virtual void	s_from_h_p (Real h, Real pressure, Real &s, Real &ds_dh, Real &ds_dp) const override

virtual Real	criticalInternalEnergy () const
	Critical specific internal energy. More...

virtual Real	e_spndl_from_v (Real v) const
	Specific internal energy from temperature and specific volume. More...

virtual void	v_e_spndl_from_T (Real T, Real &v, Real &e) const
	Specific internal energy from temperature and specific volume. More...

template<typename CppType >
void	v_e_from_p_T (const CppType &p, const CppType &T, CppType &v, CppType &e) const

template<typename CppType >
void	v_e_from_p_T (const CppType &p, const CppType &T, CppType &v, CppType &dv_dp, CppType &dv_dT, CppType &e, CppType &de_dp, CppType &de_dT) const

virtual void	rho_mu_from_p_T (Real p, Real T, Real &rho, Real &mu) const
	Combined methods. More...

virtual void	rho_mu_from_p_T (Real p, Real T, Real &rho, Real &drho_dp, Real &drho_dT, Real &mu, Real &dmu_dp, Real &dmu_dT) const

virtual void	rho_mu_from_p_T (const ADReal &p, const ADReal &T, ADReal &rho, ADReal &mu) const

virtual void	rho_e_from_p_T (Real p, Real T, Real &rho, Real &drho_dp, Real &drho_dT, Real &e, Real &de_dp, Real &de_dT) const

template<typename CppType >
void	p_T_from_v_e (const CppType &v, const CppType &e, Real p0, Real T0, CppType &p, CppType &T, bool &conversion_succeeded) const
	Determines (p,T) from (v,e) using Newton Solve in 2D Useful for conversion between different sets of state variables. More...

template<typename T >
void	p_T_from_v_h (const T &v, const T &h, Real p0, Real T0, T &pressure, T &temperature, bool &conversion_succeeded) const
	Determines (p,T) from (v,h) using Newton Solve in 2D Useful for conversion between different sets of state variables. More...

template<typename T >
void	p_T_from_h_s (const T &h, const T &s, Real p0, Real T0, T &pressure, T &temperature, bool &conversion_succeeded) const
	Determines (p,T) from (h,s) using Newton Solve in 2D Useful for conversion between different sets of state variables. More...

template<>
std::pair< Real, Real >	makeZeroAndOne (const Real &)

virtual void	execute () final

virtual void	initialize () final

virtual void	finalize () final

virtual void	threadJoin (const UserObject &) final

virtual void	subdomainSetup () final

bool	needThreadedCopy () const override final

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

std::set< UserObjectName >	getDependObjects () const

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

unsigned int	systemNumber () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	haveParameter (const std::string &name) const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

const std::vector< MooseVariableScalar *> &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

virtual bool	getMaterialPropertyCalled () const

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

bool	isImplicit ()

Moose::StateArg	determineState () const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

const T &	getKokkosFunction (const std::string &name) const

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

bool	hasKokkosFunction (const std::string &param_name) const

bool	hasKokkosFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

virtual void	meshDisplaced ()

PerfGraph &	perfGraph ()

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const Real	_R = 8.3144598
	Universal gas constant (J/mol/K) More...

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Types
enum	OOBBehavior { Ignore, Throw, DeclareInvalid, WarnInvalid, SetToClosestBound }
	Enum specifying all the behavior on out of bounds data options. More...

Protected Member Functions
void	reshapeData2D (unsigned int nrow, unsigned int ncol, const std::vector< Real > &vec, std::vector< std::vector< Real >> &mat)
	Forms a 2D matrix from a single std::vector. More...

void	checkNaNs (Real min_1, Real max_1, Real min_2, Real max_2, unsigned int i, Real &variable_1, Real &variable_2, unsigned int &num_nans_1, unsigned int &num_nans_2)
	If Newton Method jacobian produces NaNs, set variable to min or max depending on situation. More...

void	checkOutofBounds (Real min, Real max, Real &variable, unsigned int &num_out_bounds)
	If values go out of user defined range during Newton Method inversion, set variable to min or max depending on situation. More...

void	outputWarnings (unsigned int num_nans_p, unsigned int num_nans_T, unsigned int num_out_bounds_p, unsigned int num_out_bounds_T, unsigned int convergence_failures, unsigned int number_points, std::string variable_set)

void	writeTabulatedData (std::string file_name)
	Writes tabulated data to a file. More...

template<typename T >
void	checkInputVariables (T &pressure, T &temperature) const
	Checks that the inputs are within the range of the tabulated data, and throws an error if they are not. More...

template<typename T >
void	checkInputVariablesVE (T &v, T &e) const
	Checks that the inputs are within the range of the tabulated data, and throws an error if they are not. More...

virtual void	checkInitialGuess (bool post_reading_tabulation) const
	Checks initial guess for Newton Method. More...

void	readFileTabulationData (bool use_pT)
	Read tabulation data from file. More...

void	checkFileTabulationGrids (std::vector< Real > &v1, std::vector< Real > &v2, const std::string &file_name, const std::string &v1_name, const std::string &v2_name)
	Check that the tabulation grids in the file are correct (no repeats etc) More...

virtual void	generateTabulatedData ()
	Generates a table of fluid properties by looping over pressure and temperature and calculating properties using the FluidProperties UserObject _fp. More...

virtual void	generateVETabulatedData ()
	Generates a table of fluid properties by looping over specific volume and internal energy and calculating properties using the FluidProperties UserObject _fp. More...

void	computePropertyIndicesInInterpolationVectors ()
	Retrieves the index for each property in the vector of interpolations. More...

void	createVGridVector ()
	Create (or reset) the grid vectors for the specific volume and internal energy interpolations The order of priority for determining the range boundaries in v and e: More...

void	createVEGridVectors ()

void	createVHGridVectors ()
	Create (or reset) the grid vectors for the specific volume and enthalpy interpolation The order of priority for determining the range boundaries in v and h: More...

void	missingVEInterpolationError (const std::string &function_name) const
	Standardized error message for missing interpolation. More...

void	TabulationNotImplementedError (const std::string &desired_routine) const
	Utility to forward errors related to fluid properties methods not implemented. More...

void	NeedTabulationOrFPError (const std::string &desired_routine, const std::string &needed_property) const
	Utility to forward errors related to fluid properties needing more data for their computation This should generally be used as an 'else' condition to if (_interpolate_property) / else if (_fp) More...

void	NeedTabulationError (const std::string &needed_property) const
	Utility to forward errors related to properties being requested for tabulation, but no tabulation is present This should generally be used as an 'else' condition to if (_interpolate_needed_property) More...

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObjectBase &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

Static Protected Member Functions
template<typename T , typename Functor >
static void	xyDerivatives (const T x, const T &y, T &z, T &dz_dx, T &dz_dy, const Functor &z_from_x_y)
	Computes the dependent variable z and its derivatives with respect to the independent variables x and y using the simple two parameter `z_from_x_y` functor. More...

template<typename T >
static std::pair< T, T >	makeZeroAndOne (const T &)
	Given a type example, this method returns zero and unity representations of that type (first and second members of returned pair respectively) More...

static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
FileName	_file_name_in
	File name of input tabulated data file. More...

FileName	_file_name_ve_in
	File name of input (v,e) tabulated data file. More...

FileName	_file_name_out
	File name of output tabulated data file. More...

FileName	_file_name_ve_out
	File name of output (v,e) tabulated data file. More...

const bool	_save_file
	Whether to save a generated fluid properties file to disk. More...

std::vector< Real >	_pressure
	Pressure vector. More...

std::vector< Real >	_temperature
	Temperature vector. More...

std::vector< Real >	_specific_volume
	Specific volume vector. More...

std::vector< Real >	_internal_energy
	Specific internal energy vector. More...

std::vector< Real >	_enthalpy
	Specific enthalpy vector. More...

const bool	_create_direct_pT_interpolations
	Whether the object has direct (p,T) interpolations (whether created from file or from _fp) More...

const bool	_create_direct_ve_interpolations
	Whether the object has direct (v,e) interpolations (whether created from file or from _fp) More...

std::vector< std::vector< Real > >	_properties
	Tabulated fluid properties (read from file OR computed from _fp) More...

std::vector< std::vector< Real > >	_properties_ve
	Tabulated fluid properties in (v,e) (read from file OR computed from _fp) More...

std::vector< std::unique_ptr< BidimensionalInterpolation > >	_property_ipol
	Vector of bi-dimensional interpolation of fluid properties. More...

std::vector< std::unique_ptr< BidimensionalInterpolation > >	_property_ve_ipol
	Vector of bi-dimensional interpolation of fluid properties directly in (v,e) More...

Real	_temperature_min
	Minimum temperature in tabulated data. More...

Real	_temperature_max
	Maximum temperature in tabulated data. More...

Real	_pressure_min
	Minimum pressure in tabulated data. More...

Real	_pressure_max
	Maximum pressure in tabulated data. More...

unsigned int	_num_T
	Number of temperature points in the tabulated data. More...

unsigned int	_num_p
	Number of pressure points in the tabulated data. More...

const SinglePhaseFluidProperties *const	_fp
	SinglePhaseFluidPropertiesPT UserObject. More...

const bool	_allow_fp_and_tabulation
	Whether to allow a fp object when a tabulation is in use. More...

MultiMooseEnum	_interpolated_properties_enum
	Properties to be interpolated entered in the input file. More...

std::vector< std::string >	_interpolated_properties
	List of properties to be interpolated. More...

bool	_interpolate_density
	Set of flags to note whether a property is to be interpolated. More...

bool	_interpolate_enthalpy

bool	_interpolate_internal_energy

bool	_interpolate_viscosity

bool	_interpolate_k

bool	_interpolate_c

bool	_interpolate_cp

bool	_interpolate_cv

bool	_interpolate_entropy

bool	_interpolate_pressure

bool	_interpolate_temperature

unsigned int	_density_idx
	Index of each property. More...

unsigned int	_enthalpy_idx

unsigned int	_internal_energy_idx

unsigned int	_viscosity_idx

unsigned int	_k_idx

unsigned int	_c_idx

unsigned int	_cp_idx

unsigned int	_cv_idx

unsigned int	_entropy_idx

unsigned int	_p_idx

unsigned int	_T_idx

MooseUtils::DelimitedFileReader	_csv_reader
	The MOOSE delimited file reader. More...

bool	_construct_pT_from_ve
	if the lookup table p(v, e) and T(v, e) should be constructed More...

bool	_construct_pT_from_vh
	if the lookup table p(v, h) and T(v, h) should be constructed More...

bool	_initial_setup_done
	keeps track of whether initialSetup has been performed More...

unsigned int	_num_v
	Number of specific volume points in the tabulated data. More...

unsigned int	_num_e
	Number of internal energy points in tabulated data. More...

bool	_log_space_v
	log-space the specific volume interpolation grid axis instead of linear More...

bool	_log_space_e
	log-space the internal energy interpolation grid axis instead of linear More...

bool	_log_space_h
	log-space the enthalpy interpolation grid axis instead of linear More...

MooseEnum	_OOBBehavior
	User-selected out-of-bounds behavior. More...

std::unique_ptr< BidimensionalInterpolation >	_T_from_v_e_ipol
	Bi-dimensional interpolation of temperature from (v,e) More...

std::unique_ptr< BidimensionalInterpolation >	_p_from_v_e_ipol
	Bi-dimensional interpolation of pressure from (v,e) More...

std::unique_ptr< BidimensionalInterpolation >	_T_from_v_h_ipol
	Bi-dimensional interpolation of temperature from (v,h) More...

std::unique_ptr< BidimensionalInterpolation >	_p_from_v_h_ipol
	Bidimensional interpolation of pressure from (v,h) More...

bool	_e_bounds_specified
	Whether the specific internal energy bounds were set by the user. More...

bool	_v_bounds_specified
	Whether the specific volume bounds were set by the user. More...

Real	_e_min
	Minimum internal energy in tabulated data (can be user-specified) More...

Real	_e_max
	Maximum internal energy in tabulated data (can be user-specified) More...

Real	_v_min
	Minimum specific volume in tabulated data (can be user-specified) More...

Real	_v_max
	Maximum specific volume in tabulated data (can be user-specified) More...

Real	_h_min
	Minimum specific enthalpy in tabulated data. More...

Real	_h_max
	Maximum specific enthalpy in tabulated data. More...

const Real	_tolerance
	Newton's method may be used to convert between variable sets. More...

const Real	_T_initial_guess
	Initial guess for temperature (or temperature used to compute the initial guess) More...

const Real	_p_initial_guess
	Initial guess for pressure (or pressure used to compute the initial guess) More...

const unsigned int	_max_newton_its
	Maximum number of iterations for the variable conversion newton solves. More...

const bool	_verbose_newton
	Whether to output information about newton solves to console. More...

const Real	_T_c2k
	Conversion of temperature from Celsius to Kelvin. More...

const bool	_allow_imperfect_jacobians
	Flag to set unimplemented Jacobian entries to zero. More...

const Moose::CoordinateSystemType &	_coord_sys

const THREAD_ID	_tid

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

Assembly &	_assembly

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const bool	_is_kokkos_object

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

	propfunc (p, v, e) propfunc(T
	Compute a fluid property given for the state defined by two given properties. More...

e	propfunc (c, v, e) propfunc(cp

e e	propfunc (cv, v, e) propfunc(mu

e e e	propfunc (k, v, e) propfuncWithDefault(s

e e e e	propfunc (s, h, p) propfunc(rho

e e e e s	propfunc (e, v, h) propfuncWithDefault(s

e e e e s T	propfunc (pp_sat, p, T) propfunc(mu

e e e e s T T	propfunc (k, rho, T) propfuncWithDefault(c

e e e e s T T T T T	propfunc (rho, p, T) propfunc(e

e e e e s T T T T T rho	propfunc (e, T, v) propfunc(p

e e e e s T T T T T rho v	propfunc (h, T, v) propfunc(s

e e e e s T T T T T rho v v	propfunc (cv, T, v) propfunc(h

e e e e s T T T	propfuncWithDefault (cp, p, T) propfuncWithDefault(cv

e e e e s T T T T	propfuncWithDefault (mu, p, T) propfuncWithDefault(k

e e e e s T T T T T rho v v T	propfuncWithDefault (h, v, e) propfunc(g

e e e e s T T T T T rho v v T e	propfuncWithDefault (p, h, s) propfunc(T

e e e e s T T T T T rho v v T e p	propfuncWithDefault (T, p, h) propfuncWithDefault(beta

e e e e s T T T T T rho v v T e p T	propfuncWithDefault (v, p, T) propfuncWithDefault(e

e e e e s T T T T T rho v v T e p T T	propfuncWithDefault (gamma, v, e) propfuncWithDefault(gamma

	v

e	v

e e	v

e e e	v

e e e e s T T T T T rho v v T	v

e e e e	p

e e e e s	p

e e e e s T T	p

e e e e s T T T	p

e e e e s T T T T	p

e e e e s T T T T T	p

e e e e s T T T T T rho v v	p

e e e e s T T T T T rho v v T e p	p

e e e e s T T T T T rho v v T e p T	p

e e e e s T T T T T rho v v T e p T T	p

e e e e s T	rho

e e e e s T T T T T rho	T

e e e e s T T T T T rho v	T

e e e e s T T T T T rho v v T e	h

Detailed Description

Class for fluid properties read from a file.

Property values are read from a CSV file containing property data. Monotonically increasing values of pressure and temperature must be included in the data file, specifying the phase space where tabulated fluid properties will be defined. An error is thrown if either temperature or pressure data is not included or not monotonic, and an error is also thrown if this UserObject is requested to provide a fluid property outside this phase space.

This class is intended to be used when complicated formulations for fluid properties (for example, density or enthalpy) are required, which can be computationally expensive. This is particularly the case where the fluid equation of state is based on a Helmholtz free energy that is a function of density and temperature, like that used in CO2FluidProperties. In this case, density must be solved iteratively using pressure and temperature, which increases the computational burden.

Using interpolation to calculate these fluid properties can significantly reduce the computational time for these cases.

The expected file format for the tabulated fluid properties is now described. The first line must be the header containing the required column names "pressure" and "temperature", and the names of the fluid properties to be read. Available fluid property names are: "density", "enthalpy", "internal_energy", "viscosity", "k" (thermal conductivity), "cp" (isobaric specific heat capacity), "cv" (isochoric specific heat capacity), and "entropy". Note: the order is not important, although having pressure and temperature first makes the data easier for a human to read).

The data in the pressure and temperature columns must be monotonically increasing. This file format does require duplication of the pressure and temperature data - each pressure value must be included num_T times, while each temperature value is repeated num_p times, where num_T and num_p are the number of temperature and pressure points, respectively. This class will check that the required number of data points have been entered (num_T * num_p).

An example of a valid fluid properties file is provided below:

pressure, temperature, density, enthalpy, internal_energy 200000, 275, 3.90056, -21487, -72761.7 200000, 277, 3.86573, -19495.4, -71232.0 200000, 280, 3.83155, -17499.1, -69697.3 300000, 275, 6.07273, -22728.3, -73626.5 300000, 277, 6.01721, -20711.5, -72079.3 300000, 280, 5.96277, -18691.0, -70527.7

and so on.

If no tabulated fluid property data file exists, then data for the fluid supplied by the required FluidProperties UserObject will be generated using the pressure and temperature ranges specified in the input file at the beginning of the simulation. The properties to be tabulated are provided in the "interpolated_properties" input parameter (the properties that can be tabulated are listed above).

This tabulated data will be written to file in the correct format, enabling suitable data files to be created for future use. There is an upfront computational expense required for this initial data generation, depending on the required number of pressure and temperature points. However, provided that the number of data points required to generate the tabulated data is smaller than the number of times the property members in the FluidProperties UserObject are used, the initial time to generate the data and the subsequent interpolation time can be much less than using the original FluidProperties UserObject.

Properties specified in the data file or listed in the input file (and their derivatives wrt pressure and temperature) will be calculated using bicubic interpolation, while all remaining fluid properties are calculated using the supplied FluidProperties UserObject.

Definition at line 87 of file TabulatedBicubicFluidProperties.h.

Member Enumeration Documentation

◆ OOBBehavior

enum TabulatedFluidProperties::OOBBehavior

protectedinherited

Enum specifying all the behavior on out of bounds data options.

Enumerator
Ignore
Throw
DeclareInvalid
WarnInvalid
SetToClosestBound

Definition at line 383 of file TabulatedFluidProperties.h.

   {
     Ignore,
     Throw,
     DeclareInvalid,
     WarnInvalid,
     SetToClosestBound
   };

Constructor & Destructor Documentation

◆ TabulatedBicubicFluidProperties()

TabulatedBicubicFluidProperties::TabulatedBicubicFluidProperties ( const InputParameters & parameters )

Definition at line 35 of file TabulatedBicubicFluidProperties.C.

   : TabulatedFluidProperties(parameters)
 {
 }

Member Function Documentation

◆ c_from_p_T() [1/2]

Real TabulatedFluidProperties::c_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 1022 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::c_from_v_e().

 {
   if (_interpolate_c && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_c_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->c_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("c_from_p_T", "c");
   }
 }

◆ c_from_p_T() [2/2]

void TabulatedFluidProperties::c_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	c,
		Real &	dc_dp,
		Real &	dc_dT
	)		const

overridevirtualinherited

Definition at line 1039 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_c && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_c_idx]->sampleValueAndDerivatives(pressure, temperature, c, dc_dp, dc_dT);
   }
   else
   {
     if (_fp)
       _fp->c_from_p_T(pressure, temperature, c, dc_dp, dc_dT);
     else
       NeedTabulationOrFPError("c_from_p_T with derivatives", "c");
   }
 }

◆ c_from_v_e() [1/2]

Real TabulatedFluidProperties::c_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1481 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_c && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_c)
     return _property_ve_ipol[_c_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real p = _p_from_v_e_ipol->sample(v, e);
     Real T = _T_from_v_e_ipol->sample(v, e);
     return c_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->c_from_v_e(v, e);
   else
     NeedTabulationOrFPError("c_from_v_e", "c");
 }

◆ c_from_v_e() [2/2]

void TabulatedFluidProperties::c_from_v_e	(	Real	v,
		Real	e,
		Real &	c,
		Real &	dc_dv,
		Real &	dc_de
	)		const

overridevirtualinherited

Definition at line 1502 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_c && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_c)
     _property_ve_ipol[_c_idx]->sampleValueAndDerivatives(v, e, c, dc_dv, dc_de);
   else if (_construct_pT_from_ve)
   {
     Real p, dp_dv, dp_de;
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real T, dT_dv, dT_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     Real dc_dp, dc_dT;
     c_from_p_T(p, T, c, dc_dp, dc_dT);
     dc_dv = dc_dp * dp_dv + dc_dT * dT_dv;
     dc_de = dc_dp * dp_de + dc_dT * dT_de;
   }
   else if (_fp)
     _fp->c_from_v_e(v, e, c, dc_dv, dc_de);
   else
     NeedTabulationOrFPError("c_from_v_e with derivatives", "c");
 }

◆ checkFileTabulationGrids()

void TabulatedFluidProperties::checkFileTabulationGrids	(	std::vector< Real > &	v1,
		std::vector< Real > &	v2,
		const std::string &	file_name,
		const std::string &	v1_name,
		const std::string &	v2_name
	)

protectedinherited

Check that the tabulation grids in the file are correct (no repeats etc)

Parameters

v1	the first grid axis (pressure for pT grid)
v2	the second grid axis (temperature for pT grid)
file_name	the name of the tabulation file

Definition at line 2499 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::readFileTabulationData().

 {
   // NOTE: We kept the comments in terms of pressure & temperature for clarity
   // Pressure (v1) and temperature (v2) data contains duplicates due to the csv format.
   // First, check that pressure (v1) is monotonically increasing
   if (!std::is_sorted(v1.begin(), v1.end()))
     mooseError("The column data for ", v1_name, " is not monotonically increasing in ", file_name);
 
   // The first pressure (v1) value is repeated for each temperature (v2) value. Counting the
   // number of repeats provides the number of temperature (v2) values
   auto num_v2 = std::count(v1.begin(), v1.end(), v1.front());
 
   // Now remove the duplicates in the pressure (v1) vector
   auto last_unique = std::unique(v1.begin(), v1.end());
   v1.erase(last_unique, v1.end());
 
   // Check that the number of rows in the csv file is equal to _num_v1 * _num_v2
   // v2 is currently the same size as the column_data (will get trimmed at the end)
   if (v2.size() != v1.size() * libMesh::cast_int<unsigned int>(num_v2))
     mooseError("The number of rows in ",
                file_name,
                " is not equal to the number of unique ",
                v1_name,
                " values ",
                v1.size(),
                " multiplied by the number of unique ",
                v2_name,
                " values ",
                num_v2);
 
   // Need to make sure that the temperature (v2) values are provided in ascending order
   std::vector<Real> base_v2(v2.begin(), v2.begin() + num_v2);
   if (!std::is_sorted(base_v2.begin(), base_v2.end()))
     mooseError("The column data for ", v2_name, " is not monotonically increasing in ", file_name);
 
   // Need to make sure that the temperature (v2) are repeated for each pressure (v1) grid point
   auto it_v2 = v2.begin() + num_v2;
   for (const auto i : make_range(v1.size() - 1))
   {
     std::vector<Real> repeated_v2(it_v2, it_v2 + num_v2);
     if (repeated_v2 != base_v2)
       mooseError(v2_name,
                  " values for ",
                  v1_name,
                  " ",
                  v1[i + 1],
                  " are not identical to values for ",
                  v1[0]);
 
     std::advance(it_v2, num_v2);
   }
 
   // At this point, all temperature (v2) data has been provided in ascending order
   // identically for each pressure (v1) value, so we can just keep the first range
   v2.erase(v2.begin() + num_v2, v2.end());
 }

◆ checkInitialGuess()

void TabulatedFluidProperties::checkInitialGuess ( bool post_reading_tabulation ) const

protectedvirtualinherited

Checks initial guess for Newton Method.

Parameters

post_reading_tabulation whether the check is performed at construction (false) or after reading a file tabulation (true)

Definition at line 2308 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

 {
   // First condition applies when generating a tabulation
   // Second condition applies when using a pre-generated loaded tabulation
   if ((!post_reading_tabulation && _fp && (_construct_pT_from_ve || _construct_pT_from_vh)) ||
       (post_reading_tabulation && (_file_name_in != "" || _file_name_ve_in != "") &&
        (_create_direct_ve_interpolations || isParamSetByUser("T_initial_guess") ||
         isParamSetByUser("p_initial_guess"))))
   {
     if (_p_initial_guess < _pressure_min || _p_initial_guess > _pressure_max)
       mooseWarning("Pressure initial guess for (p,T), (v,e) conversions " +
                    Moose::stringify(_p_initial_guess) +
                    " is outside the range of tabulated "
                    "pressure (" +
                    Moose::stringify(_pressure_min) + ", " + Moose::stringify(_pressure_max) + ").");
 
     if (_T_initial_guess < _temperature_min || _T_initial_guess > _temperature_max)
       mooseWarning("Temperature initial guess for (p,T), (v,e) conversions " +
                    Moose::stringify(_T_initial_guess) +
                    " is outside the range of tabulated "
                    "temperature (" +
                    Moose::stringify(_temperature_min) + ", " + Moose::stringify(_temperature_max) +
                    ").");
   }
 }

◆ checkInputVariables()

template<typename T >

template void TabulatedFluidProperties::checkInputVariables	(	T &	pressure,
		T &	temperature
	)		const

protectedinherited

Checks that the inputs are within the range of the tabulated data, and throws an error if they are not.

Parameters

pressure	input pressure (Pa)
temperature	input temperature (K)

Definition at line 2222 of file TabulatedFluidProperties.C.

 {
   using std::max, std::min;
 
   if (_OOBBehavior == Ignore)
     return;
   else if (MooseUtils::absoluteFuzzyGreaterThan(_pressure_min, pressure, libMesh::TOLERANCE) ||
            MooseUtils::absoluteFuzzyGreaterThan(pressure, _pressure_max, libMesh::TOLERANCE))
   {
     if (_OOBBehavior == Throw)
       throw MooseException("Pressure " + Moose::stringify(pressure) +
                            " is outside the range of tabulated pressure (" +
                            Moose::stringify(_pressure_min) + ", " +
                            Moose::stringify(_pressure_max) + ").");
 
     else
     {
       pressure = max(_pressure_min, min(pressure, _pressure_max));
       if (_OOBBehavior == DeclareInvalid)
         flagInvalidSolution("Pressure out of bounds");
       else if (_OOBBehavior == WarnInvalid)
         flagSolutionWarning("Pressure out of bounds");
     }
   }
 
   if (MooseUtils::absoluteFuzzyGreaterThan(_temperature_min, temperature, libMesh::TOLERANCE) ||
       MooseUtils::absoluteFuzzyGreaterThan(temperature, _temperature_max, libMesh::TOLERANCE))
   {
     if (_OOBBehavior == Throw)
       throw MooseException("Temperature " + Moose::stringify(temperature) +
                            " is outside the range of tabulated temperature (" +
                            Moose::stringify(_temperature_min) + ", " +
                            Moose::stringify(_temperature_max) + ").");
     else
     {
       temperature = max(T(_temperature_min), min(temperature, T(_temperature_max)));
       if (_OOBBehavior == DeclareInvalid)
         flagInvalidSolution("Temperature out of bounds");
       else if (_OOBBehavior == WarnInvalid)
         flagSolutionWarning("Temperature out of bounds");
     }
   }
 }

◆ checkInputVariablesVE()

template<typename T >

template void TabulatedFluidProperties::checkInputVariablesVE	(	T &	v,
		T &	e
	)		const

protectedinherited

Checks that the inputs are within the range of the tabulated data, and throws an error if they are not.

Parameters

v	specific volume (m3/kg)
e	specific internal energy (J/kg)

Definition at line 2268 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::c_from_v_e(), TabulatedFluidProperties::cp_from_v_e(), TabulatedFluidProperties::cv_from_v_e(), TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::k_from_v_e(), TabulatedFluidProperties::mu_from_v_e(), TabulatedFluidProperties::p_from_v_e(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::T_from_v_e().

 {
   using std::max, std::min;
 
   if (_OOBBehavior == Ignore)
     return;
   else if (e < _e_min || e > _e_max)
   {
     if (_OOBBehavior == Throw)
       throw MooseException("Specific internal energy " + Moose::stringify(e) +
                            " is outside the range of tabulated specific internal energies (" +
                            Moose::stringify(_e_min) + ", " + Moose::stringify(_e_max) + ").");
     else
     {
       e = max(_e_min, min(e, _e_max));
       if (_OOBBehavior == DeclareInvalid)
         flagInvalidSolution("Specific internal energy out of bounds");
       else if (_OOBBehavior == WarnInvalid)
         flagSolutionWarning("Specific internal energy out of bounds");
     }
   }
 
   if (v < _v_min || v > _v_max)
   {
     if (_OOBBehavior == Throw)
       throw MooseException("Specific volume " + Moose::stringify(v) +
                            " is outside the range of tabulated specific volumes (" +
                            Moose::stringify(_v_min) + ", " + Moose::stringify(_v_max) + ").");
     else
     {
       v = max(T(_v_min), min(v, T(_v_max)));
       if (_OOBBehavior == DeclareInvalid)
         flagInvalidSolution("Specific volume out of bounds");
       else if (_OOBBehavior == WarnInvalid)
         flagSolutionWarning("Specific volume out of bounds");
     }
   }
 }

◆ checkNaNs()

void TabulatedBicubicFluidProperties::checkNaNs	(	Real	min_1,
		Real	max_1,
		Real	min_2,
		Real	max_2,
		unsigned int	i,
		Real &	variable_1,
		Real &	variable_2,
		unsigned int &	num_nans_1,
		unsigned int &	num_nans_2
	)

protected

If Newton Method jacobian produces NaNs, set variable to min or max depending on situation.

Parameters

min_1	minimum value of pressure
max_1	maximum value of pressure
min_2	minimum value of temperature
max_2	maximum value of temperature
i	track iteration to get correct data point
variable_1	pressure value
variable_2	temperature value
num_nans_1	track number of nans produced for pressure
num_nans_2	track number of nans produced for temperature

Definition at line 272 of file TabulatedBicubicFluidProperties.C.

Referenced by constructInterpolation().

 {
   // replace nan values with pmax or pmin
   if (std::isnan(variable_1))
   {
     if (_specific_volume[i] > ((_v_min + _v_max) / 2))
       variable_1 = min_1;
     else if (_specific_volume[i] < ((_v_min + _v_max) / 2))
       variable_1 = max_1;
     num_nans_1++;
   }
   // replace nan values with Tmax or Tmin
   if (std::isnan(variable_2))
   {
     if (_specific_volume[i] > ((_v_min + _v_max) / 2))
       variable_2 = max_2;
     else if (_specific_volume[i] < ((_v_min + _v_max) / 2))
       variable_2 = min_2;
     num_nans_2++;
   }
 }

◆ checkOutofBounds()

void TabulatedBicubicFluidProperties::checkOutofBounds	(	Real	min,
		Real	max,
		Real &	variable,
		unsigned int &	num_out_bounds
	)

protected

If values go out of user defined range during Newton Method inversion, set variable to min or max depending on situation.

Parameters

min	minimum value of variable
max	maximum value of variable
variable	variable of interest (pressure or temperature)
num_out_bounds	track number of values out of user defined bounds

Definition at line 303 of file TabulatedBicubicFluidProperties.C.

Referenced by constructInterpolation().

 {
   if (variable < min)
   {
     variable = min;
     num_out_bounds++;
   }
   else if (variable > max)
   {
     variable = max;
     num_out_bounds++;
   }
 }

◆ computePropertyIndicesInInterpolationVectors()

void TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors ( )

protectedinherited

Retrieves the index for each property in the vector of interpolations.

Definition at line 2561 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::initialSetup().

 {
   // At this point, all properties read or generated are able to be used by
   // TabulatedFluidProperties. Now set flags and indexes for each property in
   //_interpolated_properties to use in property calculations
   for (std::size_t i = 0; i < _interpolated_properties.size(); ++i)
   {
     if (_interpolated_properties[i] == "density")
     {
       _interpolate_density = true;
       _density_idx = i;
     }
     else if (_interpolated_properties[i] == "enthalpy")
     {
       _interpolate_enthalpy = true;
       _enthalpy_idx = i;
     }
     else if (_interpolated_properties[i] == "internal_energy")
     {
       _interpolate_internal_energy = true;
       _internal_energy_idx = i;
     }
     else if (_interpolated_properties[i] == "viscosity")
     {
       _interpolate_viscosity = true;
       _viscosity_idx = i;
     }
     else if (_interpolated_properties[i] == "k")
     {
       _interpolate_k = true;
       _k_idx = i;
     }
     else if (_interpolated_properties[i] == "c")
     {
       _interpolate_c = true;
       _c_idx = i;
     }
     else if (_interpolated_properties[i] == "cp")
     {
       _interpolate_cp = true;
       _cp_idx = i;
     }
     else if (_interpolated_properties[i] == "cv")
     {
       _interpolate_cv = true;
       _cv_idx = i;
     }
     else if (_interpolated_properties[i] == "entropy")
     {
       _interpolate_entropy = true;
       _entropy_idx = i;
     }
     else if (_interpolated_properties[i] == "pressure")
     {
       _interpolate_pressure = true;
       _p_idx = i;
     }
     else if (_interpolated_properties[i] == "temperature")
     {
       _interpolate_temperature = true;
       _T_idx = i;
     }
     else
       mooseError("Specified property '" + _interpolated_properties[i] +
                  "' is present in the tabulation but is not currently leveraged by the code in the "
                  "TabulatedFluidProperties. If it is spelled correctly, then please contact a "
                  "MOOSE or fluid properties module developer.");
   }
 }

◆ constructInterpolation()

void TabulatedBicubicFluidProperties::constructInterpolation ( )

overridevirtual

Implements TabulatedFluidProperties.

Definition at line 41 of file TabulatedBicubicFluidProperties.C.

 {
   // Construct bicubic interpolants from tabulated data
   std::vector<std::vector<Real>> data_matrix;
 
   if (_create_direct_pT_interpolations)
   {
     _property_ipol.resize(_properties.size());
     for (const auto i : index_range(_property_ipol))
     {
       reshapeData2D(_num_p, _num_T, _properties[i], data_matrix);
       _property_ipol[i] =
           std::make_unique<BicubicInterpolation>(_pressure, _temperature, data_matrix);
     }
   }
 
   if (_create_direct_ve_interpolations)
   {
     _property_ve_ipol.resize(_properties_ve.size());
 
     for (const auto i : index_range(_property_ve_ipol))
     {
       reshapeData2D(_num_v, _num_e, _properties_ve[i], data_matrix);
       _property_ve_ipol[i] =
           std::make_unique<BicubicInterpolation>(_specific_volume, _internal_energy, data_matrix);
     }
   }
 
   bool conversion_succeeded = true;
   unsigned int fail_counter_ve = 0;
   unsigned int fail_counter_vh = 0;
   // Create interpolations of (p,T) from (v,e)
   if (_construct_pT_from_ve)
   {
     // Grids in specific volume and internal energy can be either linear or logarithmic
     // NOTE: this could have been called already when generating tabulated data
     createVEGridVectors();
 
     // initialize vectors for interpolation
     std::vector<std::vector<Real>> p_from_v_e(_num_v);
     std::vector<std::vector<Real>> T_from_v_e(_num_v);
 
     unsigned int num_p_nans_ve = 0, num_T_nans_ve = 0, num_p_out_bounds_ve = 0,
                  num_T_out_bounds_ve = 0;
 
     for (unsigned int i = 0; i < _num_v; ++i)
     {
       Real p_guess = _p_initial_guess;
       Real T_guess = _T_initial_guess;
       p_from_v_e[i].resize(_num_e);
       T_from_v_e[i].resize(_num_e);
       for (unsigned int j = 0; j < _num_e; ++j)
       {
         Real p_ve, T_ve;
         // Using an input fluid property instead of the tabulation will get more exact inversions
         if (_fp)
           _fp->p_T_from_v_e(_specific_volume[i],
                             _internal_energy[j],
                             _p_initial_guess,
                             _T_initial_guess,
                             p_ve,
                             T_ve,
                             conversion_succeeded);
         else
         {
           // The inversion may step outside of the domain of definition of the interpolations,
           // which are restricted to the range of the input CSV file
           const auto old_error_behavior = _OOBBehavior;
           _OOBBehavior = SetToClosestBound;
           p_T_from_v_e(_specific_volume[i],
                        _internal_energy[j],
                        p_guess,
                        T_guess,
                        p_ve,
                        T_ve,
                        conversion_succeeded);
           _OOBBehavior = old_error_behavior;
           // track number of times convergence failed
           if (!conversion_succeeded)
             ++fail_counter_ve;
         }
 
         // check for NaNs in Newton Method
         checkNaNs(_pressure_min,
                   _pressure_max,
                   _temperature_min,
                   _temperature_max,
                   i,
                   p_ve,
                   T_ve,
                   num_p_nans_ve,
                   num_T_nans_ve);
 
         // replace out of bounds pressure values with pmax or pmin
         checkOutofBounds(_pressure_min, _pressure_max, p_ve, num_p_out_bounds_ve);
         // replace out of bounds temperature values with Tmax or Tmin
         checkOutofBounds(_temperature_min, _temperature_max, T_ve, num_T_out_bounds_ve);
 
         p_from_v_e[i][j] = p_ve;
         T_from_v_e[i][j] = T_ve;
 
         p_guess = p_ve;
         T_guess = T_ve;
       }
     }
     // output warning if nans or values out of bounds
     outputWarnings(num_p_nans_ve,
                    num_T_nans_ve,
                    num_p_out_bounds_ve,
                    num_T_out_bounds_ve,
                    fail_counter_ve,
                    _num_e * _num_v,
                    "(v,e)");
 
     // the bicubic interpolation object are init'ed now
     _p_from_v_e_ipol =
         std::make_unique<BicubicInterpolation>(_specific_volume, _internal_energy, p_from_v_e);
     _T_from_v_e_ipol =
         std::make_unique<BicubicInterpolation>(_specific_volume, _internal_energy, T_from_v_e);
   }
 
   // Create interpolations of (p,T) from (v,h)
   if (_construct_pT_from_vh)
   {
     // Grids in specific volume and enthalpy can be either linear or logarithmic
     // NOTE: the specific volume grid could have been created when generating tabulated data
     createVHGridVectors();
 
     // initialize vectors for interpolation
     std::vector<std::vector<Real>> p_from_v_h(_num_v);
     std::vector<std::vector<Real>> T_from_v_h(_num_v);
 
     unsigned int num_p_nans_vh = 0, num_T_nans_vh = 0, num_p_out_bounds_vh = 0,
                  num_T_out_bounds_vh = 0;
 
     for (unsigned int i = 0; i < _num_v; ++i)
     {
       Real p_guess = _p_initial_guess;
       Real T_guess = _T_initial_guess;
       p_from_v_h[i].resize(_num_e);
       T_from_v_h[i].resize(_num_e);
       for (unsigned int j = 0; j < _num_e; ++j)
       {
         Real p_vh, T_vh;
         // Using an input fluid property instead of the tabulation will get more exact inversions
         if (_fp)
           _fp->p_T_from_v_h(_specific_volume[i],
                             _enthalpy[j],
                             _p_initial_guess,
                             _T_initial_guess,
                             p_vh,
                             T_vh,
                             conversion_succeeded);
         else
         {
           // The inversion may step outside of the domain of definition of the interpolations,
           // which are restricted to the range of the input CSV file
           const auto old_error_behavior = _OOBBehavior;
           _OOBBehavior = SetToClosestBound;
           p_T_from_v_h(_specific_volume[i],
                        _enthalpy[j],
                        p_guess,
                        T_guess,
                        p_vh,
                        T_vh,
                        conversion_succeeded);
           _OOBBehavior = old_error_behavior;
           // track number of times convergence failed
           if (!conversion_succeeded)
             ++fail_counter_vh;
         }
 
         // check for NaNs in Newton Method
         checkNaNs(_pressure_min,
                   _pressure_max,
                   _temperature_min,
                   _temperature_max,
                   i,
                   p_vh,
                   T_vh,
                   num_p_nans_vh,
                   num_T_nans_vh);
 
         // replace out of bounds pressure values with pmax or pmin
         checkOutofBounds(_pressure_min, _pressure_max, p_vh, num_p_out_bounds_vh);
         // replace out of bounds temperature values with Tmax or Tmin
         checkOutofBounds(_temperature_min, _temperature_max, T_vh, num_T_out_bounds_vh);
 
         p_from_v_h[i][j] = p_vh;
         T_from_v_h[i][j] = T_vh;
 
         p_guess = p_vh;
         T_guess = T_vh;
       }
     }
     // output warnings if nans our values out of bounds
     outputWarnings(num_p_nans_vh,
                    num_T_nans_vh,
                    num_p_out_bounds_vh,
                    num_T_out_bounds_vh,
                    fail_counter_vh,
                    _num_e * _num_v,
                    "(v,h)");
 
     // the bicubic interpolation object are init'ed now
     _p_from_v_h_ipol =
         std::make_unique<BicubicInterpolation>(_specific_volume, _enthalpy, p_from_v_h);
     _T_from_v_h_ipol =
         std::make_unique<BicubicInterpolation>(_specific_volume, _enthalpy, T_from_v_h);
   }
 }

◆ cp_from_p_T() [1/2]

Real TabulatedFluidProperties::cp_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 1057 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::cp_from_v_e().

 {
   if (_interpolate_cp && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_cp_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->cp_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("cp_from_p_T", "c");
   }
 }

◆ cp_from_p_T() [2/2]

void TabulatedFluidProperties::cp_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	cp,
		Real &	dcp_dp,
		Real &	dcp_dT
	)		const

overridevirtualinherited

Definition at line 1074 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_cp && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_cp_idx]->sampleValueAndDerivatives(pressure, temperature, cp, dcp_dp, dcp_dT);
   }
   else
   {
     if (_fp)
       _fp->cp_from_p_T(pressure, temperature, cp, dcp_dp, dcp_dT);
     else
       NeedTabulationOrFPError("cp_from_p_T with derivatives", "cp");
   }
 }

◆ cp_from_v_e() [1/2]

Real TabulatedFluidProperties::cp_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1528 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_cp && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_cp)
     return _property_ve_ipol[_cp_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real p = _p_from_v_e_ipol->sample(v, e);
     Real T = _T_from_v_e_ipol->sample(v, e);
     return cp_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->cp_from_v_e(v, e);
   else
     NeedTabulationOrFPError("cp_from_v_e", "cp");
 }

◆ cp_from_v_e() [2/2]

void TabulatedFluidProperties::cp_from_v_e	(	Real	v,
		Real	e,
		Real &	cp,
		Real &	dcp_dv,
		Real &	dcp_de
	)		const

overridevirtualinherited

Definition at line 1549 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_cp && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_cp)
     _property_ve_ipol[_cp_idx]->sampleValueAndDerivatives(v, e, cp, dcp_dv, dcp_de);
   else if (_construct_pT_from_ve)
   {
     Real p, dp_dv, dp_de;
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real T, dT_dv, dT_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     Real dcp_dp, dcp_dT;
     cp_from_p_T(p, T, cp, dcp_dp, dcp_dT);
     dcp_dv = dcp_dp * dp_dv + dcp_dT * dT_dv;
     dcp_de = dcp_dp * dp_de + dcp_dT * dT_de;
   }
   else if (_fp)
     _fp->cp_from_v_e(v, e, cp, dcp_dv, dcp_de);
   else
     NeedTabulationOrFPError("cp_from_v_e with derivatives", "cp");
 }

◆ createVEGridVectors()

void TabulatedFluidProperties::createVEGridVectors ( )

protectedinherited

Definition at line 2685 of file TabulatedFluidProperties.C.

Referenced by constructInterpolation(), TabulatedFluidProperties::generateVETabulatedData(), and TabulatedFluidProperties::initialSetup().

 {
   createVGridVector();
   if (!_e_bounds_specified)
   {
     // if csv exists, get max and min values from csv file
     if (_interpolate_internal_energy)
     {
       _e_min = *std::min_element(_properties[_internal_energy_idx].begin(),
                                  _properties[_internal_energy_idx].end());
       _e_max = *std::max_element(_properties[_internal_energy_idx].begin(),
                                  _properties[_internal_energy_idx].end());
     }
     else if (_fp)
     {
       // extreme values of internal energy for the grid bounds
       Real e1 = _fp->e_from_p_T(_pressure_min, _temperature_min);
       Real e2 = _fp->e_from_p_T(_pressure_max, _temperature_min);
       Real e3 = _fp->e_from_p_T(_pressure_min, _temperature_max);
       Real e4 = _fp->e_from_p_T(_pressure_max, _temperature_max);
       _e_min = std::min({e1, e2, e3, e4});
       _e_max = std::max({e1, e2, e3, e4});
     }
     else
       mooseWarning("Unable to compute grid bounds in internal energy. Please specify the e_min/max "
                    "parameters");
   }
 
   // Create e grid for interpolation
   _internal_energy.resize(_num_e);
   if (_log_space_e)
   {
     // incrementing the exponent linearly will yield a log-spaced grid after taking the value to
     // the power of 10
     if (_e_min < 0)
       mooseError("Logarithmic grid in specific energy can only be used with a positive specific "
                  "energy. Current minimum: " +
                  std::to_string(_e_min));
     Real de = (std::log10(_e_max) - std::log10(_e_min)) / ((Real)_num_e - 1);
     Real log_e_min = std::log10(_e_min);
     for (const auto j : make_range(_num_e))
       _internal_energy[j] = std::pow(10, log_e_min + j * de);
   }
   else
   {
     Real de = (_e_max - _e_min) / ((Real)_num_e - 1);
     for (const auto j : make_range(_num_e))
       _internal_energy[j] = _e_min + j * de;
   }
 }

◆ createVGridVector()

void TabulatedFluidProperties::createVGridVector ( )

protectedinherited

Create (or reset) the grid vectors for the specific volume and internal energy interpolations The order of priority for determining the range boundaries in v and e:

if user-specified, use _v_min/max and _e_min/max
if reading a (v,e) interpolation, the bounds of that range
if a _fp exist find the min/max v/e from T_min/max and p_min/max

Definition at line 2632 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::createVEGridVectors(), and TabulatedFluidProperties::createVHGridVectors().

 {
   mooseAssert(_file_name_ve_in.empty(), "We should be reading the specific volume grid from file");
   if (!_v_bounds_specified)
   {
     // if csv exists, get max and min values from csv file
     if (_interpolate_density)
     {
       Real rho_max =
           *std::max_element(_properties[_density_idx].begin(), _properties[_density_idx].end());
       Real rho_min =
           *std::min_element(_properties[_density_idx].begin(), _properties[_density_idx].end());
       _v_max = 1 / rho_min;
       _v_min = 1 / rho_max;
     }
     else if (_fp)
     {
       // extreme values of specific volume for the grid bounds
       Real v1 = _fp->v_from_p_T(_pressure_min, _temperature_min);
       Real v2 = _fp->v_from_p_T(_pressure_max, _temperature_min);
       Real v3 = _fp->v_from_p_T(_pressure_min, _temperature_max);
       Real v4 = _fp->v_from_p_T(_pressure_max, _temperature_max);
       _v_min = std::min({v1, v2, v3, v4});
       _v_max = std::max({v1, v2, v3, v4});
     }
     else
       mooseWarning("Unable to compute grid bounds in specific volume. Please specify the v_min/max "
                    "parameters");
 
     // Prevent changing the bounds of the grid
     _v_bounds_specified = true;
   }
 
   // Create v grid for interpolation
   _specific_volume.resize(_num_v);
   if (_log_space_v)
   {
     // incrementing the exponent linearly will yield a log-spaced grid after taking the value to
     // the power of 10
     Real dv = (std::log10(_v_max) - std::log10(_v_min)) / ((Real)_num_v - 1);
     Real log_v_min = std::log10(_v_min);
     for (unsigned int j = 0; j < _num_v; ++j)
       _specific_volume[j] = std::pow(10, log_v_min + j * dv);
   }
   else
   {
     Real dv = (_v_max - _v_min) / ((Real)_num_v - 1);
     for (unsigned int j = 0; j < _num_v; ++j)
       _specific_volume[j] = _v_min + j * dv;
   }
 }

◆ createVHGridVectors()

void TabulatedFluidProperties::createVHGridVectors ( )

protectedinherited

Create (or reset) the grid vectors for the specific volume and enthalpy interpolation The order of priority for determining the range boundaries in v and h:

if user-specified, use _v_min/max and _e_min/max
if a _fp exist find the min/max v/e from T_min/max and p_min/max
if reading a (p,T) tabulation, the bounds of the enthalpy grid
if reading a (v,e) tabulation, the bounds of the enthalpy grid

Definition at line 2737 of file TabulatedFluidProperties.C.

Referenced by constructInterpolation().

 {
   if (_file_name_ve_in.empty())
     createVGridVector();
   if (_fp)
   {
     // extreme values of enthalpy for the grid bounds
     Real h1 = _fp->h_from_p_T(_pressure_min, _temperature_min);
     Real h2 = _fp->h_from_p_T(_pressure_max, _temperature_min);
     Real h3 = _fp->h_from_p_T(_pressure_min, _temperature_max);
     Real h4 = _fp->h_from_p_T(_pressure_max, _temperature_max);
     _h_min = std::min({h1, h2, h3, h4});
     _h_max = std::max({h1, h2, h3, h4});
   }
   // if csv exists, get max and min values from csv file
   else if (_properties.size())
   {
     _h_max = *max_element(_properties[_enthalpy_idx].begin(), _properties[_enthalpy_idx].end());
     _h_min = *min_element(_properties[_enthalpy_idx].begin(), _properties[_enthalpy_idx].end());
   }
   else if (_properties_ve.size())
   {
     _h_max = *max_element(_properties[_enthalpy_idx].begin(), _properties[_enthalpy_idx].end());
     _h_min = *min_element(_properties[_enthalpy_idx].begin(), _properties[_enthalpy_idx].end());
   }
   else
     mooseError("Need a source to compute the enthalpy grid bounds: either a FP object, or a (p,T) "
                "tabulation file or a (v,e) tabulation file");
 
   // Create h grid for interpolation
   // enthalpy & internal energy use same # grid points
   _enthalpy.resize(_num_e);
   if (_log_space_h)
   {
     // incrementing the exponent linearly will yield a log-spaced grid after taking the value to
     // the power of 10
     if (_h_min < 0)
       mooseError("Logarithmic grid in specific energy can only be used with a positive enthalpy. "
                  "Current minimum: " +
                  std::to_string(_h_min));
     Real dh = (std::log10(_h_max) - std::log10(_h_min)) / ((Real)_num_e - 1);
     Real log_h_min = std::log10(_h_min);
     for (const auto j : make_range(_num_e))
       _enthalpy[j] = std::pow(10, log_h_min + j * dh);
   }
   else
   {
     Real dh = (_h_max - _h_min) / ((Real)_num_e - 1);
     for (const auto j : make_range(_num_e))
       _enthalpy[j] = _h_min + j * dh;
   }
 }

◆ criticalDensity()

Real TabulatedFluidProperties::criticalDensity ( ) const

overridevirtualinherited

Critical density.

Returns: critical density (kg/m^3)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1366 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->criticalDensity();
   else
     TabulationNotImplementedError("criticalDensity");
 }

◆ criticalInternalEnergy()

Real SinglePhaseFluidProperties::criticalInternalEnergy ( ) const

virtualinherited

Critical specific internal energy.

Returns: specific internal energy (J/kg)

Reimplemented in IdealGasFluidProperties, CaloricallyImperfectGas, and StiffenedGasFluidProperties.

Definition at line 320 of file SinglePhaseFluidProperties.C.

 {
   return e_from_p_rho(criticalPressure(), criticalDensity());
 }

◆ criticalPressure()

Real TabulatedFluidProperties::criticalPressure ( ) const

overridevirtualinherited

Critical pressure.

Returns: critical pressure (Pa)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1346 of file TabulatedFluidProperties.C.

 {
 
   if (_fp)
     return _fp->criticalPressure();
   else
     TabulationNotImplementedError("criticalPressure");
 }

◆ criticalTemperature()

Real TabulatedFluidProperties::criticalTemperature ( ) const

overridevirtualinherited

Critical temperature.

Returns: critical temperature (K)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1356 of file TabulatedFluidProperties.C.

 {
 
   if (_fp)
     return _fp->criticalTemperature();
   else
     TabulationNotImplementedError("criticalTemperature");
 }

◆ cv_from_p_T() [1/2]

Real TabulatedFluidProperties::cv_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 1092 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::cv_from_v_e().

 {
   if (_interpolate_cv && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_cv_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->cv_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("cv_from_p_T", "cv");
   }
 }

◆ cv_from_p_T() [2/2]

void TabulatedFluidProperties::cv_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	cv,
		Real &	dcv_dp,
		Real &	dcv_dT
	)		const

overridevirtualinherited

Definition at line 1109 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_cv)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_cv_idx]->sampleValueAndDerivatives(pressure, temperature, cv, dcv_dp, dcv_dT);
   }
   else
   {
     if (_fp)
       _fp->cv_from_p_T(pressure, temperature, cv, dcv_dp, dcv_dT);
     else
       NeedTabulationOrFPError("cv_from_p_T with derivatives", "cv");
   }
 }

◆ cv_from_v_e() [1/2]

Real TabulatedFluidProperties::cv_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1575 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_cv && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_cv)
     return _property_ve_ipol[_cv_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real p = _p_from_v_e_ipol->sample(v, e);
     Real T = _T_from_v_e_ipol->sample(v, e);
     return cv_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->cv_from_v_e(v, e);
   else
     NeedTabulationOrFPError("cv_from_v_e", "cv");
 }

◆ cv_from_v_e() [2/2]

void TabulatedFluidProperties::cv_from_v_e	(	Real	v,
		Real	e,
		Real &	cv,
		Real &	dcv_dv,
		Real &	dcv_de
	)		const

overridevirtualinherited

Definition at line 1596 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_cv && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_cv)
     _property_ve_ipol[_cv_idx]->sampleValueAndDerivatives(v, e, cv, dcv_dv, dcv_de);
   else if (_construct_pT_from_ve)
   {
     Real p, dp_dv, dp_de;
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real T, dT_dv, dT_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     Real dcv_dp, dcv_dT;
     cv_from_p_T(p, T, cv, dcv_dp, dcv_dT);
     dcv_dv = dcv_dp * dp_dv + dcv_dT * dT_dv;
     dcv_de = dcv_dp * dp_de + dcv_dT * dT_de;
   }
   else if (_fp)
     _fp->cv_from_v_e(v, e, cv, dcv_dv, dcv_de);
   else
     NeedTabulationOrFPError("cv_from_v_e with derivatives", "cv");
 }

◆ e_from_p_rho() [1/3]

Real TabulatedFluidProperties::e_from_p_rho	(	Real	pressure,
		Real	rho
	)		const

overridevirtualinherited

Definition at line 744 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::T_from_p_rho().

 {
   Real e;
   // Use v,e data, we already have v from rho
   if (_create_direct_ve_interpolations)
   {
     Real T_dummy = _T_initial_guess;
     checkInputVariables(pressure, T_dummy);
     auto lambda = [&](Real v, Real current_e, Real & new_p, Real & dp_dv, Real & dp_de)
     { p_from_v_e(v, current_e, new_p, dp_dv, dp_de); };
     const auto pair = FluidPropertiesUtils::NewtonSolve(1. / rho,
                                                         pressure,
                                                         /*initial guess*/ (_e_min + _e_max) / 2,
                                                         _tolerance,
                                                         lambda,
                                                         name() + "::e_from_p_rho",
                                                         _max_newton_its,
                                                         _verbose_newton);
     e = pair.first;
   }
   // May use rho_from_p_T with derivatives in a Newton solve
   else
   {
     Real T = T_from_p_rho(pressure, rho);
     e = e_from_p_T(pressure, T);
   }
   return e;
 }

◆ e_from_p_rho() [2/3]

ADReal TabulatedFluidProperties::e_from_p_rho	(	const ADReal &	pressure,
		const ADReal &	rho
	)		const

overridevirtualinherited

Definition at line 716 of file TabulatedFluidProperties.C.

 {
   ADReal e;
   // Use v,e data, we already have v from rho
   if (_create_direct_ve_interpolations)
   {
     auto lambda = [&](ADReal v, ADReal current_e, ADReal & new_p, ADReal & dp_dv, ADReal & dp_de)
     { p_from_v_e(v, current_e, new_p, dp_dv, dp_de); };
     const auto pair = FluidPropertiesUtils::NewtonSolve(1. / rho,
                                                         pressure,
                                                         /*initial guess*/ (_e_min + _e_max) / 2,
                                                         _tolerance,
                                                         lambda,
                                                         name() + "::e_from_p_rho",
                                                         _max_newton_its,
                                                         _verbose_newton);
     e = pair.first;
   }
   // May use rho_from_p_T with derivatives in a Newton solve
   else
   {
     const auto T = T_from_p_rho(pressure, rho);
     e = e_from_p_T(pressure, T);
   }
   return e;
 }

◆ e_from_p_rho() [3/3]

void TabulatedFluidProperties::e_from_p_rho	(	Real	pressure,
		Real	rho,
		Real &	e,
		Real &	de_dp,
		Real &	de_drho
	)		const

overridevirtualinherited

Definition at line 774 of file TabulatedFluidProperties.C.

 {
   // get derivatives of T wrt to pressure and density
   Real T, dT_dp, dT_drho;
   T_from_p_rho(pressure, rho, T, dT_dp, dT_drho);
 
   // Get e, then derivatives of e wrt pressure and temperature
   Real de_dp_at_const_T, de_dT;
   e_from_p_T(pressure, T, e, de_dp_at_const_T, de_dT);
 
   // Get the derivatives of density wrt pressure and temperature
   Real rho_pT, drho_dp, drho_dT;
   rho_from_p_T(pressure, T, rho_pT, drho_dp, drho_dT);
 
   // derivatives of e wrt pressure and rho (what we want from e_from_p_rho)
   de_drho = de_dT * dT_drho;
   de_dp = de_dp_at_const_T - (de_drho * drho_dp);
 }

◆ e_from_p_T() [1/3]

Real TabulatedFluidProperties::e_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 611 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), and TabulatedFluidProperties::e_from_v_h().

 {
   if (_interpolate_internal_energy)
   {
     checkInputVariables(pressure, temperature);
     if (_create_direct_pT_interpolations)
       return _property_ipol[_internal_energy_idx]->sample(pressure, temperature);
     else
       NeedTabulationError("internal_energy");
   }
   else if (_create_direct_ve_interpolations)
   {
     checkInputVariables(pressure, temperature);
     const Real rho = rho_from_p_T(pressure, temperature);
     auto lambda = [&](Real v, Real current_e, Real & new_T, Real & dT_dv, Real & dT_de)
     { T_from_v_e(v, current_e, new_T, dT_dv, dT_de); };
     const auto pair = FluidPropertiesUtils::NewtonSolve(1. / rho,
                                                         temperature,
                                                         /*initial guess*/ (_e_min + _e_max) / 2,
                                                         _tolerance,
                                                         lambda,
                                                         name() + "::e_from_p_T",
                                                         _max_newton_its,
                                                         _verbose_newton);
     return pair.first;
   }
   else
   {
     if (_fp)
       return _fp->e_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("e_from_p_T", "internal_energy");
   }
 }

◆ e_from_p_T() [2/3]

ADReal TabulatedFluidProperties::e_from_p_T	(	const ADReal &	pressure,
		const ADReal &	temperature
	)		const

overridevirtualinherited

Definition at line 647 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_internal_energy)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     if (_create_direct_pT_interpolations)
       return _property_ipol[_internal_energy_idx]->sample(pressure_nc, temperature_nc);
     else
       NeedTabulationError("internal_energy");
   }
   else if (_create_direct_ve_interpolations)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     const ADReal rho = rho_from_p_T(pressure_nc, temperature_nc);
     auto lambda = [&](ADReal v, ADReal current_e, ADReal & new_T, ADReal & dT_dv, ADReal & dT_de)
     { T_from_v_e(v, current_e, new_T, dT_dv, dT_de); };
     const auto pair = FluidPropertiesUtils::NewtonSolve(1. / rho,
                                                         temperature_nc,
                                                         /*initial guess*/ (_e_min + _e_max) / 2,
                                                         _tolerance,
                                                         lambda,
                                                         name() + "::e_from_p_T",
                                                         _max_newton_its,
                                                         _verbose_newton);
     return pair.first;
   }
   else
   {
     if (_fp)
       return _fp->e_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("AD e_from_p_T", "internal_energy");
   }
 }

◆ e_from_p_T() [3/3]

void TabulatedFluidProperties::e_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	e,
		Real &	de_dp,
		Real &	de_dT
	)		const

overridevirtualinherited

Definition at line 685 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_internal_energy)
   {
     checkInputVariables(pressure, temperature);
     if (_create_direct_pT_interpolations)
       _property_ipol[_internal_energy_idx]->sampleValueAndDerivatives(
           pressure, temperature, e, de_dp, de_dT);
     else
       NeedTabulationError("internal_energy");
   }
   else if (_create_direct_ve_interpolations)
   {
     checkInputVariables(pressure, temperature);
     // use finite differencing stencil
     e = e_from_p_T(pressure, temperature);
     Real eps = 1e-8;
     de_dp = (e_from_p_T(pressure * (1 + eps), temperature) - e) / (eps * pressure);
     de_dT = (e_from_p_T(pressure, temperature * (1 + eps)) - e) / (eps * temperature);
   }
   else
   {
     if (_fp)
       _fp->e_from_p_T(pressure, temperature, e, de_dp, de_dT);
     else
       NeedTabulationOrFPError("e_from_p_T with derivatives", "internal_energy");
   }
 }

◆ e_from_v_h() [1/2]

Real TabulatedFluidProperties::e_from_v_h	(	Real	v,
		Real	h
	)		const

overridevirtualinherited

Definition at line 1209 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::e_from_v_h().

 {
   if (_construct_pT_from_vh)
   {
     const Real p = _p_from_v_h_ipol->sample(v, h);
     const Real T = _T_from_v_h_ipol->sample(v, h);
     return e_from_p_T(p, T);
   }
   else if (_create_direct_ve_interpolations)
   {
     // Lambda computes h from v and the current_e
     auto lambda = [&](Real v, Real current_e, Real & new_h, Real & dh_dv, Real & dh_de)
     { h_from_v_e(v, current_e, new_h, dh_dv, dh_de); };
     Real e = FluidPropertiesUtils::NewtonSolve(v,
                                                h,
                                                /*e initial guess*/ h - _p_initial_guess * v,
                                                _tolerance,
                                                lambda,
                                                name() + "::e_from_v_h",
                                                _max_newton_its,
                                                _verbose_newton)
                  .first;
     return e;
   }
   else if (_fp)
     return _fp->e_from_v_h(v, h);
   else
     NeedTabulationOrFPError("e_from_v_h", "internal_energy");
 }

◆ e_from_v_h() [2/2]

void TabulatedFluidProperties::e_from_v_h	(	Real	v,
		Real	h,
		Real &	e,
		Real &	de_dv,
		Real &	de_dh
	)		const

overridevirtualinherited

Definition at line 1240 of file TabulatedFluidProperties.C.

 {
   if (_construct_pT_from_vh)
   {
     Real p = 0, dp_dv = 0, dp_dh = 0;
     _p_from_v_h_ipol->sampleValueAndDerivatives(v, h, p, dp_dv, dp_dh);
     Real T = 0, dT_dv = 0, dT_dh = 0;
     _T_from_v_h_ipol->sampleValueAndDerivatives(v, h, T, dT_dv, dT_dh);
     Real de_dp, de_dT;
     e_from_p_T(p, T, e, de_dp, de_dT);
     de_dv = de_dp * dp_dv + de_dT * dT_dv;
     de_dh = de_dp * dp_dh + de_dT * dT_dh;
   }
   else if (_create_direct_ve_interpolations)
   {
     // Lambda computes h from v and the current_e
     auto lambda = [&](Real v, Real current_e, Real & new_h, Real & dh_dv, Real & dh_de)
     { h_from_v_e(v, current_e, new_h, dh_dv, dh_de); };
     const auto e_data =
         FluidPropertiesUtils::NewtonSolve(v,
                                           h,
                                           /*e initial guess*/ h - _p_initial_guess * v,
                                           _tolerance,
                                           lambda,
                                           name() + "::e_from_v_h",
                                           _max_newton_its,
                                           _verbose_newton);
     e = e_data.first;
     // Finite difference approximation
     const auto e2 = e_from_v_h(v * (1 + TOLERANCE), h);
     de_dv = (e2 - e) / (TOLERANCE * v);
     de_dh = 1. / e_data.second;
   }
   else if (_fp)
     _fp->e_from_v_h(v, h, e, de_dv, de_dh);
   else
     NeedTabulationOrFPError("e_from_v_h", "internal_energy");
 }

◆ e_spndl_from_v()

Real SinglePhaseFluidProperties::e_spndl_from_v ( Real v ) const

virtualinherited

Specific internal energy from temperature and specific volume.

Parameters

[in]	T	temperature
[in]	v	specific volume

Reimplemented in IdealGasFluidProperties, CaloricallyImperfectGas, and StiffenedGasFluidProperties.

Definition at line 483 of file SinglePhaseFluidProperties.C.

 {
   mooseError(__PRETTY_FUNCTION__, " not implemented.");
 }

◆ execute()

virtual void FluidProperties::execute ( )

inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 33 of file FluidProperties.h.

33 {}

◆ finalize()

virtual void FluidProperties::finalize ( )

inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 35 of file FluidProperties.h.

35 {}

◆ fluidName()

std::string TabulatedFluidProperties::fluidName ( ) const

overridevirtualinherited

Fluid name.

Returns: string representing fluid name

Reimplemented from SinglePhaseFluidProperties.

Definition at line 379 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->fluidName();
   else
     return "TabulationFromFile";
 }

◆ g_from_v_e()

Real TabulatedFluidProperties::g_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1762 of file TabulatedFluidProperties.C.

 {
   if (!_construct_pT_from_ve &&
       (!_create_direct_ve_interpolations || _entropy_idx == libMesh::invalid_uint ||
        _enthalpy_idx == libMesh::invalid_uint || _T_idx == libMesh::invalid_uint))
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   Real h, T = 0, s;
   if (_create_direct_ve_interpolations)
   {
     s = _property_ve_ipol[_entropy_idx]->sample(v, e);
     h = _property_ve_ipol[_enthalpy_idx]->sample(v, e);
     T = _property_ve_ipol[_T_idx]->sample(v, e);
   }
   else if (_fp || _create_direct_pT_interpolations)
   {
     Real p0 = _p_initial_guess;
     Real T0 = _T_initial_guess;
     Real p = 0;
     bool conversion_succeeded;
     p_T_from_v_e(v, e, p0, T0, p, T, conversion_succeeded);
     s = s_from_p_T(p, T);
     h = h_from_p_T(p, T);
   }
   else
     mooseError(__PRETTY_FUNCTION__,
                "\nNo tabulation or fluid property 'input_fp' object to compute value");
   return h - T * s;
 }

◆ generateTabulatedData()

void TabulatedFluidProperties::generateTabulatedData ( )

protectedvirtualinherited

Generates a table of fluid properties by looping over pressure and temperature and calculating properties using the FluidProperties UserObject _fp.

Definition at line 2051 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::initialSetup().

 {
   mooseAssert(_fp, "We should not try to generate (p,T) tabulated data without a _fp user object");
   _pressure.resize(_num_p);
   _temperature.resize(_num_T);
 
   // Generate data for all properties entered in input file
   _properties.resize(_interpolated_properties_enum.size());
   _interpolated_properties.resize(_interpolated_properties_enum.size());
 
   for (std::size_t i = 0; i < _interpolated_properties_enum.size(); ++i)
     _interpolated_properties[i] = _interpolated_properties_enum[i];
 
   for (const auto i : index_range(_properties))
     _properties[i].resize(_num_p * _num_T);
 
   // Temperature is divided equally into _num_T segments
   Real delta_T = (_temperature_max - _temperature_min) / static_cast<Real>(_num_T - 1);
 
   for (unsigned int j = 0; j < _num_T; ++j)
     _temperature[j] = _temperature_min + j * delta_T;
 
   // Divide the pressure into _num_p equal segments
   Real delta_p = (_pressure_max - _pressure_min) / static_cast<Real>(_num_p - 1);
 
   for (unsigned int i = 0; i < _num_p; ++i)
     _pressure[i] = _pressure_min + i * delta_p;
 
   // Generate the tabulated data at the pressure and temperature points
   for (const auto i : index_range(_properties))
   {
     if (_interpolated_properties[i] == "density")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->rho_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "enthalpy")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->h_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "internal_energy")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->e_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "viscosity")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->mu_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "k")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->k_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "c")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->c_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "cv")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->cv_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "cp")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->cp_from_p_T(_pressure[p], _temperature[t]);
 
     if (_interpolated_properties[i] == "entropy")
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
           _properties[i][p * _num_T + t] = _fp->s_from_p_T(_pressure[p], _temperature[t]);
   }
 }

◆ generateVETabulatedData()

void TabulatedFluidProperties::generateVETabulatedData ( )

protectedvirtualinherited

Generates a table of fluid properties by looping over specific volume and internal energy and calculating properties using the FluidProperties UserObject _fp.

Definition at line 2130 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::initialSetup().

 {
   mooseAssert(_fp, "We should not try to generate (v,e) tabulated data without a _fp user object");
   _specific_volume.resize(_num_v);
   _internal_energy.resize(_num_e);
 
   // Generate data for all properties entered in input file
   _properties_ve.resize(_interpolated_properties_enum.size());
   _interpolated_properties.resize(_interpolated_properties_enum.size());
 
   // This is filled from the user input, so it does not matter than this operation is performed
   // for both the (p,T) and (v,e) tabulated data generation
   for (std::size_t i = 0; i < _interpolated_properties_enum.size(); ++i)
     _interpolated_properties[i] = _interpolated_properties_enum[i];
 
   for (const auto i : index_range(_properties_ve))
     _properties_ve[i].resize(_num_v * _num_e);
 
   // Grids in (v,e) are not read, so we either use user input or rely on (p,T) data
   createVEGridVectors();
 
   // Generate the tabulated data at the pressure and temperature points
   for (const auto i : index_range(_properties_ve))
   {
     if (_interpolated_properties[i] == "density")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] = 1. / _specific_volume[v];
 
     if (_interpolated_properties[i] == "enthalpy")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->h_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "internal_energy")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] = _internal_energy[e];
 
     if (_interpolated_properties[i] == "viscosity")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->mu_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "k")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->k_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "c")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->c_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "cv")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->cv_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "cp")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->cp_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "entropy")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->s_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "pressure")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->p_from_v_e(_specific_volume[v], _internal_energy[e]);
 
     if (_interpolated_properties[i] == "temperature")
       for (unsigned int v = 0; v < _num_v; ++v)
         for (unsigned int e = 0; e < _num_e; ++e)
           _properties_ve[i][v * _num_e + e] =
               _fp->T_from_v_e(_specific_volume[v], _internal_energy[e]);
   }
 }

◆ h_from_p_T() [1/3]

Real TabulatedFluidProperties::h_from_p_T	(	Real	p,
		Real	T
	)		const

overridevirtualinherited

Definition at line 904 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::g_from_v_e(), and TabulatedFluidProperties::T_from_p_h().

 {
   if (_interpolate_enthalpy)
   {
     checkInputVariables(pressure, temperature);
     if (_create_direct_pT_interpolations)
       return _property_ipol[_enthalpy_idx]->sample(pressure, temperature);
     else if (_create_direct_ve_interpolations)
     {
       Real v, e;
       SinglePhaseFluidProperties::v_e_from_p_T(pressure, temperature, v, e);
       return _property_ve_ipol[_enthalpy_idx]->sample(v, e);
     }
     else
       NeedTabulationError("enthalpy");
   }
   else
   {
     if (_fp)
       return _fp->h_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("h_from_p_T", "enthalpy");
   }
 }

◆ h_from_p_T() [2/3]

ADReal TabulatedFluidProperties::h_from_p_T	(	const ADReal &	pressure,
		const ADReal &	temperature
	)		const

overridevirtualinherited

Definition at line 930 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_enthalpy)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     if (_create_direct_pT_interpolations)
       return _property_ipol[_enthalpy_idx]->sample(pressure_nc, temperature_nc);
     else if (_create_direct_ve_interpolations)
     {
       ADReal v, e;
       SinglePhaseFluidProperties::v_e_from_p_T(pressure_nc, temperature_nc, v, e);
       return _property_ve_ipol[_enthalpy_idx]->sample(v, e);
     }
     else
       NeedTabulationError("enthalpy");
   }
   else if (_fp) // Assuming _fp can handle ADReal types
     return _fp->h_from_p_T(pressure, temperature);
   else
     NeedTabulationOrFPError("AD h_from_p_T", "enthalpy");
 }

◆ h_from_p_T() [3/3]

void TabulatedFluidProperties::h_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	h,
		Real &	dh_dp,
		Real &	dh_dT
	)		const

overridevirtualinherited

Definition at line 954 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_enthalpy)
   {
     checkInputVariables(pressure, temperature);
     if (_create_direct_pT_interpolations)
       _property_ipol[_enthalpy_idx]->sampleValueAndDerivatives(
           pressure, temperature, h, dh_dp, dh_dT);
     else if (_create_direct_ve_interpolations)
     {
       Real v, e, dv_dp, dv_dT, de_dp, de_dT;
       SinglePhaseFluidProperties::v_e_from_p_T(
           pressure, temperature, v, dv_dp, dv_dT, e, de_dp, de_dT);
       Real dh_dv, dh_de;
       _property_ve_ipol[_enthalpy_idx]->sampleValueAndDerivatives(v, e, h, dh_dv, dh_de);
       dh_dp = dh_dv * dv_dp + dh_de * de_dp;
       dh_dT = dh_dv * dv_dT + dh_de * de_dT;
     }
     else
       NeedTabulationError("enthalpy");
   }
   else
   {
     if (_fp)
       _fp->h_from_p_T(pressure, temperature, h, dh_dp, dh_dT);
     else
       NeedTabulationOrFPError("h_from_p_T with derivatives", "enthalpy");
   }
 }

◆ henryCoefficients()

std::vector< Real > TabulatedFluidProperties::henryCoefficients ( ) const

overridevirtualinherited

The following routines are simply forwarded to the 'fp' companion FluidProperties as they are not included in the tabulations presently.

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1280 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->henryCoefficients();
   else
     TabulationNotImplementedError("henryCoefficients");
 }

◆ initialize()

virtual void FluidProperties::initialize ( )

inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 34 of file FluidProperties.h.

34 {}

◆ initialSetup()

void TabulatedFluidProperties::initialSetup ( )

overridevirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 319 of file TabulatedFluidProperties.C.

 {
   if (_initial_setup_done)
     return;
   _initial_setup_done = true;
 
   if (_create_direct_pT_interpolations)
   {
     // If the user specified a (p, T) tabulation to read, use that
     if (!_file_name_in.empty())
       readFileTabulationData(true);
     else
     {
       if (!_fp)
         paramError("create_pT_interpolations",
                    "No FluidProperties (specified with 'input_fp' parameter) exists. Either "
                    "specify a 'input_fp' or "
                    "specify a (p, T) tabulation file with the 'fluid_property_file' parameter");
       _console << name() + ": Generating (p, T) tabulated data\n";
       _console << std::flush;
 
       generateTabulatedData();
     }
   }
 
   if (_create_direct_ve_interpolations)
   {
     // If the user specified a (v, e) tabulation to read, use that
     if (!_file_name_ve_in.empty())
       readFileTabulationData(false);
     else
     {
       if (!_fp)
         paramError("create_ve_interpolations",
                    "No FluidProperties (specified with 'input_fp' parameter) exists. Either "
                    "specify a 'input_fp' or "
                    "specify a (v, e) tabulation file with the 'fluid_property_ve_file' parameter");
       _console << name() + ": Generating (v, e) tabulated data\n";
       _console << std::flush;
 
       generateVETabulatedData();
     }
   }
 
   computePropertyIndicesInInterpolationVectors();
   constructInterpolation();
 
   // Could be needed to get bounds computed from (p, T) bounds
   if (_fp && !_create_direct_ve_interpolations)
     createVEGridVectors();
 
   // Write tabulated data to file
   if (_save_file)
   {
     _console << name() + ": Writing tabulated data to " << _file_name_out << "\n";
     writeTabulatedData(_file_name_out);
   }
 }

◆ k_from_p_T() [1/2]

Real TabulatedFluidProperties::k_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 1127 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::k_from_v_e().

 {
   if (_interpolate_k && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_k_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->k_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("k_from_p_T", "k");
   }
 }

◆ k_from_p_T() [2/2]

void TabulatedFluidProperties::k_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	k,
		Real &	dk_dp,
		Real &	dk_dT
	)		const

overridevirtualinherited

Definition at line 1144 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_k && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_k_idx]->sampleValueAndDerivatives(
         pressure, temperature, k, dk_dp, dk_dT);
   }
   else
   {
     if (_fp)
       return _fp->k_from_p_T(pressure, temperature, k, dk_dp, dk_dT);
     else
       NeedTabulationOrFPError("k_from_p_T with derivatives", "k");
   }
 }

◆ k_from_v_e() [1/2]

Real TabulatedFluidProperties::k_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1669 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_k && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_k)
     return _property_ve_ipol[_k_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real T = _T_from_v_e_ipol->sample(v, e);
     Real p = _p_from_v_e_ipol->sample(v, e);
     return k_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->k_from_v_e(v, e);
   else
     NeedTabulationOrFPError("k_from_v_e", "k");
 }

◆ k_from_v_e() [2/2]

void TabulatedFluidProperties::k_from_v_e	(	Real	v,
		Real	e,
		Real &	k,
		Real &	dk_dv,
		Real &	dk_de
	)		const

overridevirtualinherited

Definition at line 1690 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_k && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_k)
     _property_ve_ipol[_k_idx]->sampleValueAndDerivatives(v, e, k, dk_dv, dk_de);
   else if (_construct_pT_from_ve)
   {
     Real p, dp_dv, dp_de;
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real T, dT_dv, dT_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     Real dk_dp, dk_dT;
     k_from_p_T(p, T, k, dk_dp, dk_dT);
     dk_dv = dk_dp * dp_dv + dk_dT * dT_dv;
     dk_de = dk_dp * dp_de + dk_dT * dT_de;
   }
   else if (_fp)
     _fp->k_from_v_e(v, e, k, dk_dv, dk_de);
   else
     NeedTabulationOrFPError("k_from_v_e with derivatives", "k");
 }

◆ makeZeroAndOne() [1/2]

template<typename T >

std::pair< T, T > SinglePhaseFluidProperties::makeZeroAndOne ( const T & )

staticprotectedinherited

Given a type example, this method returns zero and unity representations of that type (first and second members of returned pair respectively)

Definition at line 478 of file SinglePhaseFluidProperties.h.

Referenced by SinglePhaseFluidProperties::xyDerivatives().

 {
   return {T{0, 0}, T{1, 0}};
 }

◆ makeZeroAndOne() [2/2]

template<>

std::pair<Real, Real> SinglePhaseFluidProperties::makeZeroAndOne ( const Real & )

inlineinherited

Definition at line 485 of file SinglePhaseFluidProperties.h.

 {
   return {Real{0}, Real{1}};
 }

◆ missingVEInterpolationError()

void TabulatedFluidProperties::missingVEInterpolationError ( const std::string & function_name ) const

protectedinherited

Standardized error message for missing interpolation.

Definition at line 2791 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::c_from_v_e(), TabulatedFluidProperties::cp_from_v_e(), TabulatedFluidProperties::cv_from_v_e(), TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::k_from_v_e(), TabulatedFluidProperties::mu_from_v_e(), TabulatedFluidProperties::p_from_v_e(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::T_from_v_e().

 {
   mooseError(function_name +
              ": to call this function you must:\n-add this property to the list to the list of "
              "'interpolated_properties'\n and then either:\n-construct (p, T) from (v, e) "
              "tabulations using the 'construct_pT_from_ve' parameter\n-load (v,e) interpolation "
              "tables using the 'fluid_property_ve_file' parameter");
 }

◆ molarMass()

Real TabulatedFluidProperties::molarMass ( ) const

overridevirtualinherited

Molar mass [kg/mol].

Returns: molar mass

Reimplemented from SinglePhaseFluidProperties.

Definition at line 388 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->molarMass();
   else
     TabulationNotImplementedError("molarMass");
 }

◆ mu_from_p_T() [1/2]

Real TabulatedFluidProperties::mu_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 986 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::mu_from_v_e().

 {
   if (_interpolate_viscosity && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_viscosity_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->mu_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("mu_from_p_T", "viscosity");
   }
 }

◆ mu_from_p_T() [2/2]

void TabulatedFluidProperties::mu_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	mu,
		Real &	dmu_dp,
		Real &	dmu_dT
	)		const

overridevirtualinherited

Definition at line 1003 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_viscosity && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_viscosity_idx]->sampleValueAndDerivatives(
         pressure, temperature, mu, dmu_dp, dmu_dT);
   }
   else
   {
     if (_fp)
       _fp->mu_from_p_T(pressure, temperature, mu, dmu_dp, dmu_dT);
     else
       NeedTabulationOrFPError("mu_from_p_T with derivatives", "viscosity");
   }
 }

◆ mu_from_v_e() [1/2]

Real TabulatedFluidProperties::mu_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1622 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_viscosity && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_viscosity)
     return _property_ve_ipol[_viscosity_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real p = _p_from_v_e_ipol->sample(v, e);
     Real T = _T_from_v_e_ipol->sample(v, e);
     return mu_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->mu_from_v_e(v, e);
   else
     NeedTabulationOrFPError("mu_from_v_e", "viscosity");
 }

◆ mu_from_v_e() [2/2]

void TabulatedFluidProperties::mu_from_v_e	(	Real	v,
		Real	e,
		Real &	mu,
		Real &	dmu_dv,
		Real &	dmu_de
	)		const

overridevirtualinherited

Definition at line 1643 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_viscosity & !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_viscosity)
     _property_ve_ipol[_viscosity_idx]->sampleValueAndDerivatives(v, e, mu, dmu_dv, dmu_de);
   else if (_construct_pT_from_ve)
   {
     Real p, dp_dv, dp_de;
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real T, dT_dv, dT_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     Real dmu_dp, dmu_dT;
     mu_from_p_T(p, T, mu, dmu_dp, dmu_dT);
     dmu_dv = dmu_dp * dp_dv + dmu_dT * dT_dv;
     dmu_de = dmu_dp * dp_de + dmu_dT * dT_de;
   }
   else if (_fp)
     _fp->mu_from_v_e(v, e, mu, dmu_dv, dmu_de);
   else
     NeedTabulationOrFPError("mu_from_v_e with derivatives", "viscosity");
 }

◆ NeedTabulationError()

void TabulatedFluidProperties::NeedTabulationError ( const std::string & needed_property ) const

protectedinherited

Utility to forward errors related to properties being requested for tabulation, but no tabulation is present This should generally be used as an 'else' condition to if (_interpolate_needed_property)

Definition at line 1911 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::h_from_p_T(), and TabulatedFluidProperties::s_from_p_T().

 {
   mooseError("Property '" + needed_property +
              "' is marked as interpolated but neither of the following methods are active:\n- "
              "(p,T) interpolation created from fluid properties ('create_pT_interpolations' "
              "parameter)\n- a (p,T) tabulation file ('fluid_property_file')\n- (v,e) interpolation "
              "created from fluid properties or a (p,T) tabulation ('create_ve_interpolations' "
              "parameter)\n- a (v,e) tabulation file ('fluid_property_ve_file' parameter)");
 }

◆ NeedTabulationOrFPError()

void TabulatedFluidProperties::NeedTabulationOrFPError	(	const std::string &	desired_routine,
		const std::string &	needed_property
	)		const

protectedinherited

Utility to forward errors related to fluid properties needing more data for their computation This should generally be used as an 'else' condition to if (_interpolate_property) / else if (_fp)

Definition at line 1900 of file TabulatedFluidProperties.C.

 {
   mooseError(
       "TabulatedFluidProperties can only call the function '" + desired_routine +
       "' when either:\n- the property '" + needed_property +
       "' is tabulated and listed in the 'interpolated_properties' parameter.\n- the 'input_fp' "
       "parameter is provided.");
 }

◆ outputWarnings()

void TabulatedBicubicFluidProperties::outputWarnings	(	unsigned int	num_nans_p,
		unsigned int	num_nans_T,
		unsigned int	num_out_bounds_p,
		unsigned int	num_out_bounds_T,
		unsigned int	convergence_failures,
		unsigned int	number_points,
		std::string	variable_set
	)

protected

Definition at line 321 of file TabulatedBicubicFluidProperties.C.

Referenced by constructInterpolation().

 {
   // make string variables before mooseWarning
   std::string while_creating =
       "While creating (p,T) from " + variable_set + " interpolation tables,\n";
   std::string warning_message = while_creating;
   std::string converge_fails = "Inversion to (p,T) from " + variable_set + " failed " +
                                std::to_string(convergence_failures) + " times\n";
   std::string p_nans = "- " + std::to_string(num_nans_p) + " nans generated out of " +
                        std::to_string(number_points) + " points for pressure\n";
   std::string T_nans = "- " + std::to_string(num_nans_T) + " nans generated out of " +
                        std::to_string(number_points) + " points for temperature\n";
   std::string p_oob = "- " + std::to_string(num_out_bounds_p) + " of " +
                       std::to_string(number_points) + " pressure values were out of bounds\n";
   std::string T_oob = "- " + std::to_string(num_out_bounds_T) + " of " +
                       std::to_string(number_points) + " temperature values were out of bounds\n";
   std::string outcome = "The pressure and temperature values were replaced with their respective "
                         "min and max values.\n";
 
   // bounds are different depending on how the object is used
   std::string source = (_fp ? "from input parameters" : "from tabulation file");
 
   // if any of these do not exist, do not want to print them
   if (convergence_failures)
     warning_message += converge_fails;
   if (num_nans_p)
     warning_message += p_nans;
   if (num_nans_T)
     warning_message += T_nans;
   if (num_out_bounds_p)
   {
     warning_message += p_oob;
     warning_message += ("Pressure bounds " + source + ": [" + std::to_string(_pressure_min) + ", " +
                         std::to_string(_pressure_max) + "]\n");
   }
   if (num_out_bounds_T)
   {
     warning_message += T_oob;
     warning_message += ("Temperature bounds " + source + ": [" + std::to_string(_temperature_min) +
                         ", " + std::to_string(_temperature_max) + "]\n");
   }
   // print warning
   if (num_nans_p || num_nans_T || num_out_bounds_p || num_out_bounds_T || convergence_failures)
     mooseWarning(warning_message + outcome);
 }

◆ p_from_v_e() [1/3]

Real TabulatedFluidProperties::p_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Derivatives like dc_dv & dc_de are computed using the chain rule dy/dx(p,T) = dy/dp * dp/dx + dy/dT * dT/dx where y = c, cp, cv...

& x = v, e

Definition at line 1375 of file TabulatedFluidProperties.C.

Referenced by constructInterpolation(), TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::v_from_p_T(), and TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_pressure && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_pressure)
     return _property_ve_ipol[_p_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
     return _p_from_v_e_ipol->sample(v, e);
   else if (_fp)
     return _fp->p_from_v_e(v, e);
   else
     NeedTabulationOrFPError("p_from_v_e", "pressure");
 }

◆ p_from_v_e() [2/3]

void TabulatedFluidProperties::p_from_v_e	(	Real	v,
		Real	e,
		Real &	p,
		Real &	dp_dv,
		Real &	dp_de
	)		const

overridevirtualinherited

Definition at line 1392 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_pressure && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_pressure)
     _property_ve_ipol[_p_idx]->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
   else if (_construct_pT_from_ve)
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
   else if (_fp)
     _fp->p_from_v_e(v, e, p, dp_dv, dp_de);
   else
     NeedTabulationOrFPError("p_from_v_e with derivatives", "pressure");
 }

◆ p_from_v_e() [3/3]

void TabulatedFluidProperties::p_from_v_e	(	const ADReal &	v,
		const ADReal &	e,
		ADReal &	p,
		ADReal &	dp_dv,
		ADReal &	dp_de
	)		const

overridevirtualinherited

Definition at line 1409 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_pressure && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   ADReal vc = v, ec = e;
   checkInputVariablesVE(vc, ec);
 
   if (_create_direct_ve_interpolations && _interpolate_pressure)
     _property_ve_ipol[_p_idx]->sampleValueAndDerivatives(vc, ec, p, dp_dv, dp_de);
   else if (_construct_pT_from_ve)
     _p_from_v_e_ipol->sampleValueAndDerivatives(vc, ec, p, dp_dv, dp_de);
   else if (_fp)
     _fp->p_from_v_e(vc, ec, p, dp_dv, dp_de);
   else
     NeedTabulationOrFPError("AD p_from_v_e with derivatives", "pressure");
 }

◆ p_T_from_h_s()

template<typename T >

void SinglePhaseFluidProperties::p_T_from_h_s	(	const T &	h,
		const T &	s,
		Real	p0,
		Real	T0,
		T &	pressure,
		T &	temperature,
		bool &	conversion_succeeded
	)		const

inherited

Determines (p,T) from (h,s) using Newton Solve in 2D Useful for conversion between different sets of state variables.

Parameters

[in]	h	specific enthalpy (J / kg)
[in]	s	specific entropy (J/K*kg)
[in]	p0	initial guess for pressure (Pa / kg)
[in]	T0	initial guess for temperature (K)
[out]	fluid	pressure (Pa / kg)
[out]	Temperature	(K)

Definition at line 599 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::T_from_h_s().

 {
   auto h_lambda = [&](const T & pressure, const T & temperature, T & new_h, T & dh_dp, T & dh_dT)
   { h_from_p_T(pressure, temperature, new_h, dh_dp, dh_dT); };
   auto s_lambda = [&](const T & pressure, const T & temperature, T & new_s, T & ds_dp, T & ds_dT)
   { s_from_p_T(pressure, temperature, new_s, ds_dp, ds_dT); };
   try
   {
     FluidPropertiesUtils::NewtonSolve2D(h,
                                         s,
                                         p0,
                                         T0,
                                         pressure,
                                         temperature,
                                         _tolerance,
                                         _tolerance,
                                         h_lambda,
                                         s_lambda,
                                         "p_T_from_h_s",
                                         _max_newton_its,
                                         _verbose_newton);
     conversion_succeeded = true;
   }
   catch (MooseException &)
   {
     conversion_succeeded = false;
   }
 
   if (!conversion_succeeded)
     mooseDoOnce(mooseWarning("Conversion from (h, s)=(", h, ", ", s, ") to (p, T) failed"));
 }

◆ p_T_from_v_e()

template<typename CppType >

void SinglePhaseFluidProperties::p_T_from_v_e	(	const CppType &	v,
		const CppType &	e,
		Real	p0,
		Real	T0,
		CppType &	p,
		CppType &	T,
		bool &	conversion_succeeded
	)		const

inherited

Determines (p,T) from (v,e) using Newton Solve in 2D Useful for conversion between different sets of state variables.

Parameters

[in]	v	specific volume (m^3 / kg)
[in]	e	specific internal energy (J / kg)
[in]	p0	initial guess for pressure (Pa / kg)
[in]	T0	initial guess for temperature (K)
[out]	fluid	pressure (Pa / kg)
[out]	Temperature	(K)

Definition at line 513 of file SinglePhaseFluidProperties.h.

Referenced by constructInterpolation(), TemperaturePressureFunctionFluidProperties::cp_from_v_e(), TemperaturePressureFunctionFluidProperties::cv_from_v_e(), TabulatedFluidProperties::g_from_v_e(), TemperaturePressureFunctionFluidProperties::k_from_v_e(), TemperaturePressureFunctionFluidProperties::mu_from_v_e(), and TemperaturePressureFunctionFluidProperties::T_from_v_e().

 {
   auto v_lambda = [&](const CppType & pressure,
                       const CppType & temperature,
                       CppType & new_v,
                       CppType & dv_dp,
                       CppType & dv_dT) { v_from_p_T(pressure, temperature, new_v, dv_dp, dv_dT); };
   auto e_lambda = [&](const CppType & pressure,
                       const CppType & temperature,
                       CppType & new_e,
                       CppType & de_dp,
                       CppType & de_dT) { e_from_p_T(pressure, temperature, new_e, de_dp, de_dT); };
   try
   {
     FluidPropertiesUtils::NewtonSolve2D(v,
                                         e,
                                         p0,
                                         T0,
                                         p,
                                         T,
                                         _tolerance,
                                         _tolerance,
                                         v_lambda,
                                         e_lambda,
                                         "p_T_from_v_e",
                                         _max_newton_its,
                                         _verbose_newton);
     conversion_succeeded = true;
   }
   catch (MooseException &)
   {
     conversion_succeeded = false;
   }
 
   if (!conversion_succeeded)
     mooseDoOnce(mooseWarning("Conversion from (v, e)=(", v, ", ", e, ") to (p, T) failed"));
 }

◆ p_T_from_v_h()

template<typename T >

void SinglePhaseFluidProperties::p_T_from_v_h	(	const T &	v,
		const T &	h,
		Real	p0,
		Real	T0,
		T &	pressure,
		T &	temperature,
		bool &	conversion_succeeded
	)		const

inherited

Determines (p,T) from (v,h) using Newton Solve in 2D Useful for conversion between different sets of state variables.

Parameters

[in]	v	specific volume (m^3 / kg)
[in]	h	specific enthalpy (J / kg)
[in]	p0	initial guess for pressure (Pa / kg)
[in]	T0	initial guess for temperature (K)
[out]	fluid	pressure (Pa / kg)
[out]	Temperature	(K)

Definition at line 559 of file SinglePhaseFluidProperties.h.

Referenced by constructInterpolation().

 {
   auto v_lambda = [&](const T & pressure, const T & temperature, T & new_v, T & dv_dp, T & dv_dT)
   { v_from_p_T(pressure, temperature, new_v, dv_dp, dv_dT); };
   auto h_lambda = [&](const T & pressure, const T & temperature, T & new_h, T & dh_dp, T & dh_dT)
   { h_from_p_T(pressure, temperature, new_h, dh_dp, dh_dT); };
   try
   {
     FluidPropertiesUtils::NewtonSolve2D(v,
                                         h,
                                         p0,
                                         T0,
                                         pressure,
                                         temperature,
                                         _tolerance,
                                         _tolerance,
                                         v_lambda,
                                         h_lambda,
                                         "p_T_from_v_h",
                                         _max_newton_its,
                                         _verbose_newton);
     conversion_succeeded = true;
   }
   catch (MooseException &)
   {
     conversion_succeeded = false;
   }
 
   if (!conversion_succeeded)
     mooseDoOnce(mooseWarning("Conversion from (v, h)=(", v, ", ", h, ") to (p, T) failed"));
 }

◆ propfunc() [1/12]

SinglePhaseFluidProperties::propfunc	(	p	,
		v	,
		e
	)

inherited

Compute a fluid property given for the state defined by two given properties.

For all functions, the first two arguments are the given properties that define the fluid state. For the two-argument variants, the desired property is the return value. The five-argument variants also provide partial derivatives dx/da and dx/db where x is the desired property being computed, a is the first given property, and b is the second given property. The desired property, dx/da, and dx/db are stored into the 3rd, 4th, and 5th arguments respectively.

Properties/parameters used in these function are listed below with their units:

p pressure [Pa] T temperature [K] e specific internal energy [J/kg] v specific volume [m^3/kg] rho density [kg/m^3] h specific enthalpy [J/kg] s specific entropy [J/(kg*K)] mu viscosity [Pa*s] k thermal conductivity [W/(m*K)] c speed of sound [m/s] cp constant-pressure specific heat [J/K] cv constant-volume specific heat [J/K] beta volumetric thermal expansion coefficient [1/K] g Gibbs free energy [J] pp_sat partial pressure at saturation [Pa] gamma Adiabatic ratio (cp/cv) [-]

As an example:

// calculate pressure given specific vol and energy: auto pressure = your_fluid_properties_object.p_from_v_e(specific_vol, specific_energy);

// or use the derivative variant: Real dp_dv = 0; // derivative will be stored into here Real dp_de = 0; // derivative will be stored into here your_fluid_properties_object.p_from_v_e(specific_vol, specific_energy, pressure, dp_dv, dp_de);

Automatic differentiation (AD) support is provided through x_from_a_b(ADReal a, ADReal b) and x_from_a_b(ADReal a, ADReal b, ADReal x, ADReal dx_da, ADReal dx_db) versions of the functions where a and b must be ADReal/DualNumber's calculated using all AD-supporting values:

auto v = 1/rho; // rho must be an AD non-linear variable. auto e = rhoE/rho - vel_energy; // rhoE and vel_energy must be AD variables/numbers also. auto pressure = your_fluid_properties_object.p_from_v_e(v, e); // pressure now contains partial derivatives w.r.t. all degrees of freedom

◆ propfunc() [2/12]

e SinglePhaseFluidProperties::propfunc	(	c	,
		v	,
		e
	)

inherited

◆ propfunc() [3/12]

e e SinglePhaseFluidProperties::propfunc	(	cv	,
		v	,
		e
	)

inherited

◆ propfunc() [4/12]

e e e SinglePhaseFluidProperties::propfunc	(	k	,
		v	,
		e
	)

inherited

◆ propfunc() [5/12]

e e e e SinglePhaseFluidProperties::propfunc	(	s	,
		h	,
		p
	)

inherited

◆ propfunc() [6/12]

e e e e s SinglePhaseFluidProperties::propfunc	(	e	,
		v	,
		h
	)

inherited

◆ propfunc() [7/12]

e e e e s T SinglePhaseFluidProperties::propfunc	(	pp_sat	,
		p	,
		T
	)

inherited

◆ propfunc() [8/12]

e e e e s T T SinglePhaseFluidProperties::propfunc	(	k	,
		rho	,
		T
	)

inherited

◆ propfunc() [9/12]

e e e e s T T T T T SinglePhaseFluidProperties::propfunc	(	rho	,
		p	,
		T
	)

inherited

◆ propfunc() [10/12]

e e e e s T T T T T rho SinglePhaseFluidProperties::propfunc	(	e	,
		T	,
		v
	)

inherited

◆ propfunc() [11/12]

e e e e s T T T T T rho v SinglePhaseFluidProperties::propfunc	(	h	,
		T	,
		v
	)

inherited

◆ propfunc() [12/12]

e e e e s T T T T T rho v v SinglePhaseFluidProperties::propfunc	(	cv	,
		T	,
		v
	)

inherited

◆ propfuncWithDefault() [1/7]

e e e e s T T T SinglePhaseFluidProperties::propfuncWithDefault	(	cp	,
		p	,
		T
	)

inherited

◆ propfuncWithDefault() [2/7]

e e e e s T T T T SinglePhaseFluidProperties::propfuncWithDefault	(	mu	,
		p	,
		T
	)

inherited

◆ propfuncWithDefault() [3/7]

e e e e s T T T T T rho v v T SinglePhaseFluidProperties::propfuncWithDefault	(	h	,
		v	,
		e
	)

inherited

◆ propfuncWithDefault() [4/7]

e e e e s T T T T T rho v v T e SinglePhaseFluidProperties::propfuncWithDefault	(	p	,
		h	,
		s
	)

inherited

◆ propfuncWithDefault() [5/7]

e e e e s T T T T T rho v v T e p SinglePhaseFluidProperties::propfuncWithDefault	(	T	,
		p	,
		h
	)

inherited

◆ propfuncWithDefault() [6/7]

e e e e s T T T T T rho v v T e p T SinglePhaseFluidProperties::propfuncWithDefault	(	v	,
		p	,
		T
	)

inherited

◆ propfuncWithDefault() [7/7]

e e e e s T T T T T rho v v T e p T T SinglePhaseFluidProperties::propfuncWithDefault	(	gamma	,
		v	,
		e
	)

inherited

◆ readFileTabulationData()

void TabulatedFluidProperties::readFileTabulationData ( bool use_pT )

protectedinherited

Read tabulation data from file.

Definition at line 2335 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::initialSetup().

 {
   std::string file_name;
   if (use_pT)
   {
     _console << name() + ": Reading tabulated properties from " << _file_name_in << std::endl;
     _csv_reader.read();
     file_name = _file_name_in;
   }
   else
   {
     _console << name() + ": Reading tabulated properties from " << _file_name_ve_in << std::endl;
     _csv_reader.setFileName(_file_name_ve_in);
     _csv_reader.read();
     file_name = _file_name_ve_in;
   }
 
   const std::vector<std::string> & column_names = _csv_reader.getNames();
 
   // These columns form the grid and must be present in the file
   std::vector<std::string> required_columns;
   if (use_pT)
     required_columns = {"pressure", "temperature"};
   else
     required_columns = {"specific_volume", "internal_energy"};
 
   // Check that all required columns are present
   for (std::size_t i = 0; i < required_columns.size(); ++i)
   {
     if (std::find(column_names.begin(), column_names.end(), required_columns[i]) ==
         column_names.end())
       mooseError("No ",
                  required_columns[i],
                  " data read in ",
                  file_name,
                  ". A column named ",
                  required_columns[i],
                  " must be present");
   }
 
   // These columns can be present in the file
   std::vector<std::string> property_columns = {
       "density", "enthalpy", "viscosity", "k", "c", "cv", "cp", "entropy"};
   if (use_pT)
     property_columns.push_back("internal_energy");
   else
   {
     property_columns.push_back("pressure");
     property_columns.push_back("temperature");
   }
 
   // Check that any property names read from the file are present in the list of possible
   // properties, and if they are, add them to the list of read properties
   for (std::size_t i = 0; i < column_names.size(); ++i)
   {
     // Only check properties not in _required_columns
     if (std::find(required_columns.begin(), required_columns.end(), column_names[i]) ==
         required_columns.end())
     {
       if (std::find(property_columns.begin(), property_columns.end(), column_names[i]) ==
           property_columns.end())
         mooseWarning(column_names[i],
                      " read in ",
                      file_name,
                      " tabulation file is not one of the properties that TabulatedFluidProperties "
                      "understands. It will be ignored.");
       // We could be reading a (v,e) tabulation after having read a (p,T) tabulation, do not
       // insert twice
       // Also only allow properties specified as interpolated if user passed the parameter
       else if (std::find(_interpolated_properties.begin(),
                          _interpolated_properties.end(),
                          column_names[i]) == _interpolated_properties.end() &&
                (!isParamSetByUser("interpolated_properties") ||
                 _interpolated_properties_enum.contains(column_names[i])))
         _interpolated_properties.push_back(column_names[i]);
     }
   }
 
   std::map<std::string, unsigned int> data_index;
   for (std::size_t i = 0; i < column_names.size(); ++i)
   {
     auto it = std::find(column_names.begin(), column_names.end(), column_names[i]);
     data_index[column_names[i]] = std::distance(column_names.begin(), it);
   }
 
   const std::vector<std::vector<Real>> & column_data = _csv_reader.getData();
 
   // Extract the pressure and temperature data vectors
   if (use_pT)
   {
     _pressure = column_data[data_index.find("pressure")->second];
     _temperature = column_data[data_index.find("temperature")->second];
   }
   else
   {
     _specific_volume = column_data[data_index.find("specific_volume")->second];
     _internal_energy = column_data[data_index.find("internal_energy")->second];
   }
 
   if (use_pT)
     checkFileTabulationGrids(_pressure, _temperature, file_name, "pressure", "temperature");
   else
     checkFileTabulationGrids(_specific_volume,
                              _internal_energy,
                              file_name,
                              "specific volume",
                              "specific internal energy");
 
   if (use_pT)
   {
     _num_p = _pressure.size();
     _num_T = _temperature.size();
 
     // Minimum and maximum pressure and temperature. Note that _pressure and
     // _temperature are sorted
     _pressure_min = _pressure.front();
     _pressure_max = _pressure.back();
     _temperature_min = _temperature.front();
     _temperature_max = _temperature.back();
     checkInitialGuess(true);
 
     // Extract the fluid property data from the file
     for (std::size_t i = 0; i < _interpolated_properties.size(); ++i)
       _properties.push_back(column_data[data_index.find(_interpolated_properties[i])->second]);
   }
   else
   {
     _num_v = _specific_volume.size();
     _num_e = _internal_energy.size();
 
     // Minimum and maximum specific internal energy and specific volume
     _v_min = _specific_volume.front();
     _v_max = _specific_volume.back();
     _e_min = _internal_energy.front();
     _e_max = _internal_energy.back();
 
     // We cannot overwrite the tabulated data grid with a grid generated from user-input for the
     // purpose of creating (p,T) to (v,e) interpolations
     if (_construct_pT_from_ve)
       paramError("construct_pT_from_ve",
                  "Reading a (v,e) tabulation and generating (p,T) to (v,e) interpolation tables is "
                  "not supported at this time.");
 
     // Make sure we use the tabulation bounds
     _e_bounds_specified = true;
     _v_bounds_specified = true;
 
     // Extract the fluid property data from the file
     _properties_ve.reserve(_interpolated_properties.size());
     for (std::size_t i = 0; i < _interpolated_properties.size(); ++i)
       _properties_ve.push_back(column_data[data_index.find(_interpolated_properties[i])->second]);
 
     // Obtain the min/max T, p and check the initial guess
     const auto & p_col = column_data[data_index.find("pressure")->second];
     _pressure_min = *std::min_element(p_col.begin(), p_col.end());
     _pressure_max = *std::max_element(p_col.begin(), p_col.end());
     const auto & T_col = column_data[data_index.find("temperature")->second];
     _temperature_min = *std::min_element(T_col.begin(), T_col.end());
     _temperature_max = *std::max_element(T_col.begin(), T_col.end());
     checkInitialGuess(true);
   }
 }

◆ reshapeData2D()

void TabulatedBicubicFluidProperties::reshapeData2D	(	unsigned int	nrow,
		unsigned int	ncol,
		const std::vector< Real > &	vec,
		std::vector< std::vector< Real >> &	mat
	)

protected

Forms a 2D matrix from a single std::vector.

Parameters

	nrow	number of rows in the matrix
	ncol	number of columns in the matrix
	vec	1D vector to reshape into a 2D matrix
[out]	2D	matrix formed by reshaping vec

Definition at line 254 of file TabulatedBicubicFluidProperties.C.

Referenced by constructInterpolation().

 {
   if (!vec.empty())
   {
     mat.resize(nrow);
     for (unsigned int i = 0; i < nrow; ++i)
       mat[i].resize(ncol);
 
     for (unsigned int i = 0; i < nrow; ++i)
       for (unsigned int j = 0; j < ncol; ++j)
         mat[i][j] = vec[i * ncol + j];
   }
 }

◆ rho_e_from_p_T()

void SinglePhaseFluidProperties::rho_e_from_p_T	(	Real	p,
		Real	T,
		Real &	rho,
		Real &	drho_dp,
		Real &	drho_dT,
		Real &	e,
		Real &	de_dp,
		Real &	de_dT
	)		const

virtualinherited

Definition at line 438 of file SinglePhaseFluidProperties.C.

 {
   rho_from_p_T(p, T, rho, drho_dp, drho_dT);
   e_from_p_T(p, T, e, de_dp, de_dT);
 }

◆ rho_from_p_s() [1/2]

Real TabulatedFluidProperties::rho_from_p_s	(	Real	p,
		Real	s
	)		const

overridevirtualinherited

Definition at line 592 of file TabulatedFluidProperties.C.

 {
   Real T = T_from_p_s(p, s);
   return rho_from_p_T(p, T);
 }

◆ rho_from_p_s() [2/2]

void TabulatedFluidProperties::rho_from_p_s	(	Real	p,
		Real	s,
		Real &	rho,
		Real &	drho_dp,
		Real &	drho_ds
	)		const

overridevirtualinherited

Definition at line 599 of file TabulatedFluidProperties.C.

 {
   Real T, dT_dp, dT_ds;
   T_from_p_s(p, s, T, dT_dp, dT_ds);
   Real drho_dp_T, drho_dT;
   rho_from_p_T(p, T, rho, drho_dp_T, drho_dT);
   drho_dp = drho_dT * dT_dp + drho_dp_T;
   drho_ds = drho_dT * dT_ds;
 }

◆ rho_from_p_T() [1/4]

Real TabulatedFluidProperties::rho_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 503 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::rho_from_p_s(), TabulatedFluidProperties::rho_from_p_T(), and TabulatedFluidProperties::T_from_p_rho().

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_density_idx]->sample(pressure, temperature);
   }
   else if (_create_direct_ve_interpolations)
     return 1. / v_from_p_T(pressure, temperature);
   else
   {
     if (_fp)
       return _fp->rho_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("rho_from_p_T", "density");
   }
 }

◆ rho_from_p_T() [2/4]

ADReal TabulatedFluidProperties::rho_from_p_T	(	const ADReal &	pressure,
		const ADReal &	temperature
	)		const

overridevirtualinherited

Definition at line 522 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     return _property_ipol[_density_idx]->sample(pressure_nc, temperature_nc);
   }
   else if (_create_direct_ve_interpolations)
     return 1. / v_from_p_T(pressure, temperature);
   else
   {
     if (_fp)
       return _fp->rho_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("AD rho_from_p_T", "density");
   }
 }

◆ rho_from_p_T() [3/4]

void TabulatedFluidProperties::rho_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	rho,
		Real &	drho_dp,
		Real &	drho_dT
	)		const

overridevirtualinherited

Definition at line 542 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_density_idx]->sampleValueAndDerivatives(
         pressure, temperature, rho, drho_dp, drho_dT);
   }
   else if (_create_direct_ve_interpolations)
   {
     checkInputVariables(pressure, temperature);
     // use finite differencing stencil
     rho = rho_from_p_T(pressure, temperature);
     Real eps = 1e-8;
     drho_dp = (rho_from_p_T(pressure * (1 + eps), temperature) - rho) / (eps * pressure);
     drho_dT = (rho_from_p_T(pressure, temperature * (1 + eps)) - rho) / (eps * temperature);
   }
   else
   {
     if (_fp)
       _fp->rho_from_p_T(pressure, temperature, rho, drho_dp, drho_dT);
     else
       NeedTabulationOrFPError("rho_from_p_T with derivatives", "density");
   }
 }

◆ rho_from_p_T() [4/4]

void TabulatedFluidProperties::rho_from_p_T	(	const ADReal &	pressure,
		const ADReal &	temperature,
		ADReal &	rho,
		ADReal &	drho_dp,
		ADReal &	drho_dT
	)		const

overridevirtualinherited

Definition at line 570 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     ADReal p = pressure, T = temperature;
     checkInputVariables(p, T);
     _property_ipol[_density_idx]->sampleValueAndDerivatives(p, T, rho, drho_dp, drho_dT);
   }
   else
   {
     if (_fp)
       _fp->rho_from_p_T(pressure, temperature, rho, drho_dp, drho_dT);
     else
       NeedTabulationOrFPError("AD rho_from_p_T with derivatives", "density");
   }
 }

◆ rho_mu_from_p_T() [1/3]

void SinglePhaseFluidProperties::rho_mu_from_p_T	(	Real	p,
		Real	T,
		Real &	rho,
		Real &	mu
	)		const

virtualinherited

Combined methods.

These methods are particularly useful for the PorousFlow module, where density and viscosity are typically both computed everywhere. The combined methods allow the most efficient means of calculating both properties, especially where rho(p, T) and mu(rho, T). In this case, an extra density calculation would be required to calculate mu(p, T). All property names are described above.

Reimplemented in Water97FluidProperties, CO2FluidProperties, HydrogenFluidProperties, and NitrogenFluidProperties.

Definition at line 452 of file SinglePhaseFluidProperties.C.

Referenced by PorousFlowWaterNCG::gasProperties(), PorousFlowBrineCO2::gasProperties(), and PorousFlowWaterNCG::liquidProperties().

 {
   rho = rho_from_p_T(p, T);
   mu = mu_from_p_T(p, T);
 }

◆ rho_mu_from_p_T() [2/3]

void SinglePhaseFluidProperties::rho_mu_from_p_T	(	Real	p,
		Real	T,
		Real &	rho,
		Real &	drho_dp,
		Real &	drho_dT,
		Real &	mu,
		Real &	dmu_dp,
		Real &	dmu_dT
	)		const

virtualinherited

Reimplemented in Water97FluidProperties, CO2FluidProperties, HydrogenFluidProperties, and NitrogenFluidProperties.

Definition at line 459 of file SinglePhaseFluidProperties.C.

 {
   rho_from_p_T(p, T, rho, drho_dp, drho_dT);
   mu_from_p_T(p, T, mu, dmu_dp, dmu_dT);
 }

◆ rho_mu_from_p_T() [3/3]

void SinglePhaseFluidProperties::rho_mu_from_p_T	(	const ADReal &	p,
		const ADReal &	T,
		ADReal &	rho,
		ADReal &	mu
	)		const

virtualinherited

Definition at line 473 of file SinglePhaseFluidProperties.C.

 {
   rho = rho_from_p_T(p, T);
   mu = mu_from_p_T(p, T);
 }

◆ s_from_h_p() [1/2]

Real TabulatedFluidProperties::s_from_h_p	(	Real	h,
		Real	pressure
	)		const

overridevirtualinherited

Definition at line 1874 of file TabulatedFluidProperties.C.

 {
   Real T = T_from_p_h(pressure, enthalpy);
   return s_from_p_T(pressure, T);
 }

◆ s_from_h_p() [2/2]

void TabulatedFluidProperties::s_from_h_p	(	Real	h,
		Real	pressure,
		Real &	s,
		Real &	ds_dh,
		Real &	ds_dp
	)		const

overridevirtualinherited

Definition at line 1881 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     _fp->s_from_h_p(h, pressure, s, ds_dh, ds_dp);
   else
     TabulationNotImplementedError("s_from_h_p with derivatives");
 }

◆ s_from_p_T() [1/2]

Real TabulatedFluidProperties::s_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 1163 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::s_from_h_p(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::T_from_p_s().

 {
   if (_interpolate_entropy && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return _property_ipol[_entropy_idx]->sample(pressure, temperature);
   }
   else
   {
     if (_fp)
       return _fp->s_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("s_from_p_T", "entropy");
   }
 }

◆ s_from_p_T() [2/2]

void TabulatedFluidProperties::s_from_p_T	(	Real	p,
		Real	T,
		Real &	s,
		Real &	ds_dp,
		Real &	ds_dT
	)		const

overridevirtualinherited

Definition at line 1180 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_entropy)
   {
     checkInputVariables(p, T);
     if (_create_direct_pT_interpolations)
       _property_ipol[_entropy_idx]->sampleValueAndDerivatives(p, T, s, ds_dp, ds_dT);
     else if (_create_direct_ve_interpolations)
     {
       Real v, e, dv_dp, dv_dT, de_dp, de_dT;
       SinglePhaseFluidProperties::v_e_from_p_T(p, T, v, dv_dp, dv_dT, e, de_dp, de_dT);
       Real ds_dv, ds_de;
       _property_ve_ipol[_entropy_idx]->sampleValueAndDerivatives(v, e, s, ds_dv, ds_de);
       ds_dp = ds_dv * dv_dp + ds_de * de_dp;
       ds_dT = ds_dv * dv_dT + ds_de * de_dT;
     }
     else
       NeedTabulationError("entropy");
   }
   else
   {
     if (_fp)
       _fp->s_from_p_T(p, T, s, ds_dp, ds_dT);
     else
       NeedTabulationOrFPError("s_from_p_T with derivatives", "entropy");
   }
 }

◆ s_from_v_e() [1/2]

Real TabulatedFluidProperties::s_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1716 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_entropy && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_entropy)
     return _property_ve_ipol[_entropy_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
   {
     Real T = _T_from_v_e_ipol->sample(v, e);
     Real p = _p_from_v_e_ipol->sample(v, e);
     return s_from_p_T(p, T);
   }
   else if (_fp)
     return _fp->s_from_v_e(v, e);
   else
     NeedTabulationOrFPError("s_from_v_e", "entropy");
 }

◆ s_from_v_e() [2/2]

void TabulatedFluidProperties::s_from_v_e	(	Real	v,
		Real	e,
		Real &	s,
		Real &	ds_dv,
		Real &	ds_de
	)		const

overridevirtualinherited

Definition at line 1737 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_entropy && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_entropy)
     _property_ve_ipol[_entropy_idx]->sampleValueAndDerivatives(v, e, s, ds_dv, ds_de);
   else if (_construct_pT_from_ve)
   {
     Real p, T, dT_dv, dT_de, dp_dv, dp_de;
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
     _p_from_v_e_ipol->sampleValueAndDerivatives(v, e, p, dp_dv, dp_de);
     Real ds_dp, ds_dT;
     s_from_p_T(p, T, s, ds_dp, ds_dT);
     ds_dv = ds_dp * dp_dv + ds_dT * dT_dv;
     ds_dv = ds_dp * dp_de + ds_dT * dT_de;
   }
   else if (_fp)
     _fp->s_from_v_e(v, e, s, ds_dv, ds_de);
   else
     NeedTabulationOrFPError("s_from_v_e", "entropy");
 }

◆ subdomainSetup()

virtual void FluidProperties::subdomainSetup ( )

inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 38 of file FluidProperties.h.

38 {}

◆ T_from_h_s()

Real TabulatedFluidProperties::T_from_h_s	(	Real	h,
		Real	s
	)		const

virtualinherited

Definition at line 1794 of file TabulatedFluidProperties.C.

 {
   Real p0 = _p_initial_guess;
   Real T0 = _T_initial_guess;
   Real p, T;
   bool conversion_succeeded;
   p_T_from_h_s(h, s, p0, T0, p, T, conversion_succeeded);
   return T;
 }

◆ T_from_p_h() [1/2]

Real TabulatedFluidProperties::T_from_p_h	(	Real	pressure,
		Real	enthalpy
	)		const

overridevirtualinherited

Definition at line 1805 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::s_from_h_p().

 {
   if (_create_direct_pT_interpolations || _create_direct_ve_interpolations)
   {
     auto lambda = [&](Real pressure, Real current_T, Real & new_h, Real & dh_dp, Real & dh_dT)
     { h_from_p_T(pressure, current_T, new_h, dh_dp, dh_dT); };
     Real T = FluidPropertiesUtils::NewtonSolve(pressure,
                                                enthalpy,
                                                _T_initial_guess,
                                                _tolerance,
                                                lambda,
                                                name() + "::T_from_p_h",
                                                _max_newton_its,
                                                _verbose_newton)
                  .first;
     // check for nans
     if (std::isnan(T))
       mooseError("Conversion from enthalpy (h = ",
                  enthalpy,
                  ") and pressure (p = ",
                  pressure,
                  ") to temperature failed to converge.");
     return T;
   }
   else if (_fp)
     return _fp->T_from_p_h(pressure, enthalpy);
   else
     NeedTabulationOrFPError("T_from_p_h", "temperature");
 }

◆ T_from_p_h() [2/2]

ADReal TabulatedFluidProperties::T_from_p_h	(	const ADReal &	pressure,
		const ADReal &	enthalpy
	)		const

overridevirtualinherited

Definition at line 1836 of file TabulatedFluidProperties.C.

 {
   using std::isnan;
   if (_create_direct_pT_interpolations || _create_direct_ve_interpolations)
   {
     auto lambda =
         [&](ADReal pressure, ADReal current_T, ADReal & new_h, ADReal & dh_dp, ADReal & dh_dT)
     {
       h_from_p_T(pressure.value(), current_T.value(), new_h.value(), dh_dp.value(), dh_dT.value());
       // Reconstruct derivatives
       new_h.derivatives() =
           dh_dp.value() * pressure.derivatives() + dh_dT.value() * current_T.derivatives();
     };
     ADReal T = FluidPropertiesUtils::NewtonSolve(pressure,
                                                  enthalpy,
                                                  _T_initial_guess,
                                                  _tolerance,
                                                  lambda,
                                                  name() + "::T_from_p_h",
                                                  _max_newton_its,
                                                  _verbose_newton)
                    .first;
     // check for nans
     if (isnan(T))
       mooseError("Conversion from enthalpy (h = ",
                  enthalpy,
                  ") and pressure (p = ",
                  pressure,
                  ") to temperature failed to converge.");
     return T;
   }
   else if (_fp)
     return _fp->T_from_p_h(pressure, enthalpy);
   else
     NeedTabulationOrFPError("T_from_p_h", "temperature");
 }

◆ T_from_p_rho() [1/3]

Real TabulatedFluidProperties::T_from_p_rho	(	Real	pressure,
		Real	rho
	)		const

virtualinherited

Definition at line 795 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::e_from_p_rho(), and TabulatedFluidProperties::T_from_p_rho().

 {
   Real T = _T_initial_guess;
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, T);
     auto lambda = [&](Real p, Real current_T, Real & new_rho, Real & drho_dp, Real & drho_dT)
     { rho_from_p_T(p, current_T, new_rho, drho_dp, drho_dT); };
     T = FluidPropertiesUtils::NewtonSolve(pressure,
                                           rho,
                                           _T_initial_guess,
                                           _tolerance,
                                           lambda,
                                           name() + "::T_from_p_rho",
                                           _max_newton_its,
                                           _verbose_newton)
             .first;
   }
   else if (_create_direct_ve_interpolations)
     T = T_from_v_e(1. / rho, e_from_p_rho(pressure, rho));
   else
     NeedTabulationOrFPError("T_from_p_rho", "temperature");
   // check for nans
   if (std::isnan(T))
     mooseError("Conversion from pressure (p = ",
                pressure,
                ") and density (rho = ",
                rho,
                ") to temperature failed to converge.");
   return T;
 }

◆ T_from_p_rho() [2/3]

ADReal TabulatedFluidProperties::T_from_p_rho	(	const ADReal &	pressure,
		const ADReal &	rho
	)		const

virtualinherited

Definition at line 828 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_density)
   {
     auto lambda =
         [&](ADReal p, ADReal current_T, ADReal & new_rho, ADReal & drho_dp, ADReal & drho_dT)
     { rho_from_p_T(p, current_T, new_rho, drho_dp, drho_dT); };
     ADReal T = FluidPropertiesUtils::NewtonSolve(pressure,
                                                  rho,
                                                  _T_initial_guess,
                                                  _tolerance,
                                                  lambda,
                                                  name() + "::T_from_p_rho",
                                                  _max_newton_its,
                                                  _verbose_newton)
                    .first;
     // check for nans
     if (std::isnan(T.value()))
       mooseError("Conversion from pressure (p = ",
                  pressure,
                  ") and density (rho = ",
                  rho,
                  ") to temperature failed to converge.");
     return T;
   }
   else if (_create_direct_ve_interpolations)
     return T_from_v_e(1. / rho, e_from_p_rho(pressure, rho));
   else
     NeedTabulationOrFPError("AD T_from_p_rho", "temperature");
 }

◆ T_from_p_rho() [3/3]

void TabulatedFluidProperties::T_from_p_rho	(	Real	pressure,
		Real	rho,
		Real &	T,
		Real &	dT_dp,
		Real &	dT_drho
	)		const

virtualinherited

Definition at line 860 of file TabulatedFluidProperties.C.

 {
   T = T_from_p_rho(pressure, rho);
   Real eps = 1e-8;
   dT_dp = (T_from_p_rho(pressure * (1 + eps), rho) - T) / (eps * pressure);
   dT_drho = (T_from_p_rho(pressure, rho * (1 + eps)) - T) / (eps * rho);
 }

◆ T_from_p_s() [1/2]

Real TabulatedFluidProperties::T_from_p_s	(	Real	p,
		Real	s
	)		const

virtualinherited

Definition at line 870 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::rho_from_p_s(), and TabulatedFluidProperties::T_from_p_s().

 {
   auto lambda = [&](Real p, Real current_T, Real & new_s, Real & ds_dp, Real & ds_dT)
   { s_from_p_T(p, current_T, new_s, ds_dp, ds_dT); };
   Real T = FluidPropertiesUtils::NewtonSolve(pressure,
                                              s,
                                              _T_initial_guess,
                                              _tolerance,
                                              lambda,
                                              name() + "::T_from_p_s",
                                              _max_newton_its,
                                              _verbose_newton)
                .first;
   // check for nans
   if (std::isnan(T))
     mooseError("Conversion from pressure (p = ",
                pressure,
                ") and entropy (s = ",
                s,
                ") to temperature failed to converge.");
   return T;
 }

◆ T_from_p_s() [2/2]

void TabulatedFluidProperties::T_from_p_s	(	Real	p,
		Real	s,
		Real &	T,
		Real &	dT_dp,
		Real &	dT_ds
	)		const

virtualinherited

Definition at line 894 of file TabulatedFluidProperties.C.

 {
   T = T_from_p_s(pressure, s);
   Real eps = 1e-8;
   dT_dp = (T_from_p_s(pressure * (1 + eps), s) - T) / (eps * pressure);
   dT_ds = (T_from_p_s(pressure, s * (1 + eps)) - T) / (eps * s);
 }

◆ T_from_v_e() [1/3]

Real TabulatedFluidProperties::T_from_v_e	(	Real	v,
		Real	e
	)		const

overridevirtualinherited

Definition at line 1428 of file TabulatedFluidProperties.C.

Referenced by constructInterpolation(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::T_from_p_rho(), TabulatedFluidProperties::v_from_p_T(), and TabulatedFluidProperties::writeTabulatedData().

 {
   if (_interpolate_temperature && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_temperature)
     return _property_ve_ipol[_T_idx]->sample(v, e);
   else if (_construct_pT_from_ve)
     return _T_from_v_e_ipol->sample(v, e);
   else if (_fp)
     return _fp->T_from_v_e(v, e);
   else
     NeedTabulationOrFPError("T_from_v_e", "temperature");
 }

◆ T_from_v_e() [2/3]

void TabulatedFluidProperties::T_from_v_e	(	Real	v,
		Real	e,
		Real &	T,
		Real &	dT_dv,
		Real &	dT_de
	)		const

overridevirtualinherited

Definition at line 1445 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_temperature && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   checkInputVariablesVE(v, e);
 
   if (_create_direct_ve_interpolations && _interpolate_temperature)
     _property_ve_ipol[_T_idx]->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
   else if (_construct_pT_from_ve)
     _T_from_v_e_ipol->sampleValueAndDerivatives(v, e, T, dT_dv, dT_de);
   else if (_fp)
     _fp->T_from_v_e(v, e, T, dT_dv, dT_de);
   else
     NeedTabulationOrFPError("T_from_v_e with derivatives", "temperature");
 }

◆ T_from_v_e() [3/3]

void TabulatedFluidProperties::T_from_v_e	(	const ADReal &	v,
		const ADReal &	e,
		ADReal &	p,
		ADReal &	dp_dv,
		ADReal &	dp_de
	)		const

overridevirtualinherited

Definition at line 1462 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_temperature && !_construct_pT_from_ve && !_create_direct_ve_interpolations)
     missingVEInterpolationError(__PRETTY_FUNCTION__);
   ADReal vc = v, ec = e;
   checkInputVariablesVE(vc, ec);
 
   if (_create_direct_ve_interpolations && _interpolate_temperature)
     _property_ve_ipol[_T_idx]->sampleValueAndDerivatives(vc, ec, T, dT_dv, dT_de);
   else if (_construct_pT_from_ve)
     _T_from_v_e_ipol->sampleValueAndDerivatives(vc, ec, T, dT_dv, dT_de);
   else if (_fp)
     _fp->T_from_v_e(vc, ec, T, dT_dv, dT_de);
   else
     NeedTabulationOrFPError("AD T_from_v_e with derivatives", "temperature");
 }

◆ TabulationNotImplementedError()

void TabulatedFluidProperties::TabulationNotImplementedError ( const std::string & desired_routine ) const

protectedinherited

Utility to forward errors related to fluid properties methods not implemented.

Definition at line 1891 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::criticalDensity(), TabulatedFluidProperties::criticalPressure(), TabulatedFluidProperties::criticalTemperature(), TabulatedFluidProperties::henryCoefficients(), TabulatedFluidProperties::molarMass(), TabulatedFluidProperties::s_from_h_p(), TabulatedFluidProperties::triplePointPressure(), TabulatedFluidProperties::triplePointTemperature(), TabulatedFluidProperties::vaporPressure(), and TabulatedFluidProperties::vaporTemperature().

 {
   mooseError("TabulatedFluidProperties can only call the function '" + desired_routine +
              "' when the 'input_fp' parameter is provided. It is currently not implemented using "
              "tabulations, and this property is simply forwarded to the FluidProperties specified "
              "in the 'input_fp' parameter");
 }

◆ threadJoin()

virtual void FluidProperties::threadJoin ( const UserObject & )

inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 37 of file FluidProperties.h.

37 {}

◆ triplePointPressure()

Real TabulatedFluidProperties::triplePointPressure ( ) const

overridevirtualinherited

Triple point pressure.

Returns: triple point pressure (Pa)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1326 of file TabulatedFluidProperties.C.

 {
 
   if (_fp)
     return _fp->triplePointPressure();
   else
     TabulationNotImplementedError("triplePointPressure");
 }

◆ triplePointTemperature()

Real TabulatedFluidProperties::triplePointTemperature ( ) const

overridevirtualinherited

Triple point temperature.

Returns: triple point temperature (K)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1336 of file TabulatedFluidProperties.C.

 {
 
   if (_fp)
     return _fp->triplePointTemperature();
   else
     TabulationNotImplementedError("triplePointTemperature");
 }

◆ v_e_from_p_T() [1/2]

template<typename CppType >

void SinglePhaseFluidProperties::v_e_from_p_T	(	const CppType &	p,
		const CppType &	T,
		CppType &	v,
		CppType &	e
	)		const

inherited

Definition at line 639 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::h_from_p_T(), and TabulatedFluidProperties::s_from_p_T().

 {
   const CppType rho = rho_from_p_T(p, T);
   v = 1.0 / rho;
   try
   {
     // more likely to not involve a Newton search
     e = e_from_p_T(p, T);
   }
   catch (...)
   {
     e = e_from_p_rho(p, rho);
   }
 }

◆ v_e_from_p_T() [2/2]

template<typename CppType >

void SinglePhaseFluidProperties::v_e_from_p_T	(	const CppType &	p,
		const CppType &	T,
		CppType &	v,
		CppType &	dv_dp,
		CppType &	dv_dT,
		CppType &	e,
		CppType &	de_dp,
		CppType &	de_dT
	)		const

inherited

Definition at line 659 of file SinglePhaseFluidProperties.h.

 {
   CppType rho, drho_dp, drho_dT;
   rho_from_p_T(p, T, rho, drho_dp, drho_dT);
 
   v = 1.0 / rho;
   const CppType dv_drho = -1.0 / (rho * rho);
   dv_dp = dv_drho * drho_dp;
   dv_dT = dv_drho * drho_dT;
 
   CppType de_dp_partial, de_drho;
   e_from_p_rho(p, rho, e, de_dp_partial, de_drho);
   de_dp = de_dp_partial + de_drho * drho_dp;
   de_dT = de_drho * drho_dT;
 }

◆ v_e_spndl_from_T()

void SinglePhaseFluidProperties::v_e_spndl_from_T	(	Real	T,
		Real &	v,
		Real &	e
	)		const

virtualinherited

Specific internal energy from temperature and specific volume.

Parameters

[in]	T	temperature
[in]	v	specific volume

Reimplemented in IdealGasFluidProperties, CaloricallyImperfectGas, and StiffenedGasFluidProperties.

Definition at line 489 of file SinglePhaseFluidProperties.C.

 {
   mooseError(__PRETTY_FUNCTION__, " not implemented.");
 }

◆ v_from_p_T() [1/3]

Real TabulatedFluidProperties::v_from_p_T	(	Real	pressure,
		Real	temperature
	)		const

overridevirtualinherited

Definition at line 397 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::rho_from_p_T().

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     return 1.0 / _property_ipol[_density_idx]->sample(pressure, temperature);
   }
   else if (_create_direct_ve_interpolations)
   {
     checkInputVariables(pressure, temperature);
     Real v, e;
     auto p_from_v_e = [&](Real v, Real e, Real & new_p, Real & dp_dv, Real & dp_de)
     { this->p_from_v_e(v, e, new_p, dp_dv, dp_de); };
     auto T_from_v_e = [&](Real v, Real e, Real & new_T, Real & dT_dv, Real & dT_de)
     { this->T_from_v_e(v, e, new_T, dT_dv, dT_de); };
     FluidPropertiesUtils::NewtonSolve2D(pressure,
                                         temperature,
                                         (_v_min + _v_max) / 2,
                                         (_e_min + _e_max) / 2,
                                         v,
                                         e,
                                         _tolerance,
                                         _tolerance,
                                         p_from_v_e,
                                         T_from_v_e,
                                         name() + "::v_from_p_T",
                                         _max_newton_its,
                                         _verbose_newton);
     return v;
   }
   else
   {
     if (_fp)
       return 1.0 / _fp->rho_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("AD v_from_p_T", "density");
   }
 }

◆ v_from_p_T() [2/3]

ADReal TabulatedFluidProperties::v_from_p_T	(	const ADReal &	pressure,
		const ADReal &	temperature
	)		const

overridevirtualinherited

Definition at line 437 of file TabulatedFluidProperties.C.

 {
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     return 1.0 / _property_ipol[_density_idx]->sample(pressure_nc, temperature_nc);
   }
   else if (_create_direct_ve_interpolations)
   {
     ADReal pressure_nc = pressure, temperature_nc = temperature;
     checkInputVariables(pressure_nc, temperature_nc);
     ADReal v, e;
     auto p_from_v_e = [&](ADReal v, ADReal e, ADReal & new_p, ADReal & dp_dv, ADReal & dp_de)
     { this->p_from_v_e(v, e, new_p, dp_dv, dp_de); };
     auto T_from_v_e = [&](ADReal v, ADReal e, ADReal & new_T, ADReal & dT_dv, ADReal & dT_de)
     { this->T_from_v_e(v, e, new_T, dT_dv, dT_de); };
     FluidPropertiesUtils::NewtonSolve2D(pressure_nc,
                                         temperature_nc,
                                         (_v_min + _v_max) / 2,
                                         (_e_min + _e_max) / 2,
                                         v,
                                         e,
                                         _tolerance,
                                         _tolerance,
                                         p_from_v_e,
                                         T_from_v_e,
                                         name() + "::v_from_p_T",
                                         _max_newton_its,
                                         _verbose_newton);
     return v;
   }
   else
   {
     if (_fp)
       return 1.0 / _fp->rho_from_p_T(pressure, temperature);
     else
       NeedTabulationOrFPError("AD v_from_p_T", "density");
   }
 }

◆ v_from_p_T() [3/3]

void TabulatedFluidProperties::v_from_p_T	(	Real	pressure,
		Real	temperature,
		Real &	v,
		Real &	dv_dp,
		Real &	dv_dT
	)		const

overridevirtualinherited

Definition at line 479 of file TabulatedFluidProperties.C.

 {
   Real rho = 0, drho_dp = 0, drho_dT = 0;
   if (_interpolate_density && _create_direct_pT_interpolations)
   {
     checkInputVariables(pressure, temperature);
     _property_ipol[_density_idx]->sampleValueAndDerivatives(
         pressure, temperature, rho, drho_dp, drho_dT);
   }
   else
   {
     if (_fp)
       _fp->rho_from_p_T(pressure, temperature, rho, drho_dp, drho_dT);
     else
       NeedTabulationOrFPError("v_from_p_T with derivatives", "density");
   }
   // convert from rho to v
   v = 1.0 / rho;
   dv_dp = -drho_dp / (rho * rho);
   dv_dT = -drho_dT / (rho * rho);
 }

◆ validParams()

InputParameters TabulatedBicubicFluidProperties::validParams ( )

static

Definition at line 27 of file TabulatedBicubicFluidProperties.C.

 {
   InputParameters params = TabulatedFluidProperties::validParams();
   params.addClassDescription(
       "Fluid properties using bicubic interpolation on tabulated values provided");
   return params;
 }

◆ vaporPressure() [1/3]

Real TabulatedFluidProperties::vaporPressure ( Real T ) const

overridevirtualinherited

Vapor pressure.

Used to delineate liquid and gas phases. Valid for temperatures between the triple point temperature and the critical temperature

Parameters

	T	fluid temperature (K)
[out]	saturation	pressure (Pa)
[out]	derivative	of saturation pressure wrt temperature (Pa/K)

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1289 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->vaporPressure(temperature);
   else
     TabulationNotImplementedError("vaporPressure");
 }

◆ vaporPressure() [2/3]

void TabulatedFluidProperties::vaporPressure	(	Real	temperature,
		Real &	psat,
		Real &	dpsat_dT
	)		const

overridevirtualinherited

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1298 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     _fp->vaporPressure(temperature, psat, dpsat_dT);
   else
     TabulationNotImplementedError("vaporPressure");
 }

◆ vaporPressure() [3/3]

ADReal SinglePhaseFluidProperties::vaporPressure ( const ADReal & T ) const

virtualinherited

Definition at line 393 of file SinglePhaseFluidProperties.C.

 {
   Real p = 0.0;
   Real temperature = T.value();
   Real dpdT = 0.0;
 
   vaporPressure(temperature, p, dpdT);
 
   ADReal result = p;
   result.derivatives() = T.derivatives() * dpdT;
 
   return result;
 }

◆ vaporTemperature() [1/3]

Real TabulatedFluidProperties::vaporTemperature ( Real p ) const

overridevirtualinherited

Vapor temperature.

Used to delineate liquid and gas phases. Valid for pressures between the triple point pressure and the critical pressure

Parameters

	p	fluid pressure (Pa)
[out]	saturation	temperature (K)
[out]	derivative	of saturation temperature wrt pressure

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1307 of file TabulatedFluidProperties.C.

 {
   if (_fp)
     return _fp->vaporTemperature(pressure);
   else
     TabulationNotImplementedError("vaporTemperature");
 }

◆ vaporTemperature() [2/3]

void TabulatedFluidProperties::vaporTemperature	(	Real	pressure,
		Real &	Tsat,
		Real &	dTsat_dp
	)		const

overridevirtualinherited

Reimplemented from SinglePhaseFluidProperties.

Definition at line 1316 of file TabulatedFluidProperties.C.

 {
 
   if (_fp)
     _fp->vaporTemperature(pressure, Tsat, dTsat_dp);
   else
     TabulationNotImplementedError("vaporTemperature");
 }

◆ vaporTemperature() [3/3]

ADReal SinglePhaseFluidProperties::vaporTemperature ( const ADReal & p ) const

virtualinherited

Definition at line 423 of file SinglePhaseFluidProperties.C.

 {
   Real T = 0.0;
   Real pressure = p.value();
   Real dTdp = 0.0;
 
   vaporTemperature(pressure, T, dTdp);
 
   ADReal result = T;
   result.derivatives() = p.derivatives() * dTdp;
 
   return result;
 }

◆ writeTabulatedData()

void TabulatedFluidProperties::writeTabulatedData ( std::string file_name )

protectedinherited

Writes tabulated data to a file.

Parameters

file_name name of the file to be written

Definition at line 1922 of file TabulatedFluidProperties.C.

Referenced by TabulatedFluidProperties::initialSetup().

 {
   if (processor_id() == 0)
   {
     // Write out the (p, T) interpolation tables
     if (_file_name_out != "")
     {
       file_name = file_name.empty() ? "fluid_properties_" + name() + "_out.csv" : file_name;
       MooseUtils::checkFileWriteable(file_name);
 
       std::ofstream file_out(file_name.c_str());
 
       if (!getParam<bool>("skip_header_tabulation"))
       {
         // Write out date and fluid type
         time_t now = std::time(&now);
         file_out << "# " << (_fp ? _fp->fluidName() : "")
                  << " properties (p,T) tabulation created by TabulatedFluidProperties on "
                  << ctime(&now) << "\n";
       }
 
       // Write out column names
       file_out << "pressure, temperature";
       for (std::size_t i = 0; i < _interpolated_properties.size(); ++i)
         if (_interpolated_properties[i] != "pressure" &&
             _interpolated_properties[i] != "temperature")
           file_out << ", " << _interpolated_properties[i];
       file_out << "\n";
 
       // Write out the fluid property data
       for (unsigned int p = 0; p < _num_p; ++p)
         for (unsigned int t = 0; t < _num_T; ++t)
         {
           file_out << _pressure[p] << ", " << _temperature[t];
           for (std::size_t i = 0; i < _properties.size(); ++i)
             file_out << ", " << _properties[i][p * _num_T + t];
           file_out << "\n";
         }
 
       file_out << std::flush;
       file_out.close();
     }
 
     // Write out the (v,e) interpolation tables
     if (_file_name_ve_out != "" && (_construct_pT_from_ve || _create_direct_ve_interpolations))
     {
       const auto file_name_ve = (_file_name_ve_out == "")
                                     ? std::regex_replace(file_name, std::regex("\\.csv"), "_ve.csv")
                                     : _file_name_ve_out;
       MooseUtils::checkFileWriteable(file_name_ve);
       std::ofstream file_out(file_name_ve.c_str());
 
       // Write out date and fluid type
       if (!getParam<bool>("skip_header_tabulation"))
       {
         time_t now = std::time(&now);
         file_out << "# " << (_fp ? _fp->fluidName() : "")
                  << " properties (v,e) tabulation created by TabulatedFluidProperties on "
                  << ctime(&now) << "\n";
       }
 
       // Write out column names
       file_out << "specific_volume, internal_energy, pressure, temperature";
       for (const auto i : index_range(_interpolated_properties))
         // Avoid writing the fixed columns twice
         if (_interpolated_properties[i] != "internal_energy" &&
             _interpolated_properties[i] != "pressure" &&
             _interpolated_properties[i] != "temperature")
           file_out << ", " << _interpolated_properties[i];
       file_out << "\n";
 
       // Write out the fluid property data
       for (const auto v : make_range(_num_v))
         for (const auto e : make_range(_num_e))
         {
           const auto v_val = _specific_volume[v];
           const auto e_val = _internal_energy[e];
           // Use the expected source for the grid. Note that the tabulations are already created
           Real pressure, temperature;
           if (_construct_pT_from_ve)
           {
             pressure = _p_from_v_e_ipol->sample(v_val, e_val);
             temperature = _T_from_v_e_ipol->sample(v_val, e_val);
           }
           else
           {
             pressure = p_from_v_e(v_val, e_val);
             temperature = T_from_v_e(v_val, e_val);
           }
           file_out << v_val << ", " << e_val << ", " << pressure << ", " << temperature
                    << (_interpolated_properties.size() ? ", " : "");
           for (const auto i : index_range(_interpolated_properties))
           {
             bool add_comma = true;
             if (i == _density_idx)
               file_out << 1. / v_val;
             else if (i == _enthalpy_idx)
               file_out << h_from_v_e(v_val, e_val);
             // Note that we could use (p,T) routine to generate this instead of (v,e)
             // Or could use the _properties_ve array similar to what we do for (pressure,
             // temperature)
             else if (i == _viscosity_idx)
               file_out << mu_from_v_e(v_val, e_val);
             else if (i == _k_idx)
               file_out << k_from_v_e(v_val, e_val);
             else if (i == _c_idx)
               file_out << c_from_v_e(v_val, e_val);
             else if (i == _cv_idx)
               file_out << cv_from_v_e(v_val, e_val);
             else if (i == _cp_idx)
               file_out << cp_from_v_e(v_val, e_val);
             else if (i == _entropy_idx)
               file_out << s_from_v_e(v_val, e_val);
             else
               add_comma = false;
             if (i != _interpolated_properties.size() - 1 && add_comma)
               file_out << ", ";
           }
 
           file_out << "\n";
         }
 
       file_out << std::flush;
       file_out.close();
     }
   }
 }

◆ xyDerivatives()

template<typename T , typename Functor >

void SinglePhaseFluidProperties::xyDerivatives	(	const T	x,
		const T &	y,
		T &	z,
		T &	dz_dx,
		T &	dz_dy,
		const Functor &	z_from_x_y
	)

staticprotectedinherited

Computes the dependent variable z and its derivatives with respect to the independent variables x and y using the simple two parameter z_from_x_y functor.

The derivatives are computed using a compound automatic differentiation type

Definition at line 492 of file SinglePhaseFluidProperties.h.

Referenced by Water97FluidProperties::e_from_p_rho_template(), Water97FluidProperties::h_from_p_T_template(), Water97FluidProperties::rho_from_p_T_template(), and Water97FluidProperties::v_from_p_T_template().

 {
   typedef MetaPhysicL::DualNumber<T, MetaPhysicL::NumberArray<2, T>> CompoundType;
   const auto [zero, one] = makeZeroAndOne(x);
 
   CompoundType x_c(x, zero);
   auto & x_cd = x_c.derivatives();
   x_cd[0] = one;
   CompoundType y_c(y, zero);
   auto & y_cd = y_c.derivatives();
   y_cd[1] = one;
 
   const auto z_c = z_from_x_y(x_c, y_c);
   z = z_c.value();
   dz_dx = z_c.derivatives()[0];
   dz_dy = z_c.derivatives()[1];
 }

Member Data Documentation

◆ _allow_fp_and_tabulation

const bool TabulatedFluidProperties::_allow_fp_and_tabulation

protectedinherited

Whether to allow a fp object when a tabulation is in use.

Definition at line 328 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::TabulatedFluidProperties().

◆ _allow_imperfect_jacobians

const bool FluidProperties::_allow_imperfect_jacobians

protectedinherited

Flag to set unimplemented Jacobian entries to zero.

Definition at line 47 of file FluidProperties.h.

Referenced by VaporMixtureFluidProperties::imperfectJacobianMessage(), Water97FluidProperties::T_from_p_h_ad(), and SinglePhaseFluidProperties::unimplementedDerivativeMethod().

◆ _c_idx

unsigned int TabulatedFluidProperties::_c_idx

protectedinherited

Definition at line 353 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_p_T(), TabulatedFluidProperties::c_from_v_e(), TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), and TabulatedFluidProperties::writeTabulatedData().

◆ _construct_pT_from_ve

bool TabulatedFluidProperties::_construct_pT_from_ve

protectedinherited

if the lookup table p(v, e) and T(v, e) should be constructed

Definition at line 364 of file TabulatedFluidProperties.h.

◆ _construct_pT_from_vh

bool TabulatedFluidProperties::_construct_pT_from_vh

protectedinherited

if the lookup table p(v, h) and T(v, h) should be constructed

Definition at line 366 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), constructInterpolation(), and TabulatedFluidProperties::e_from_v_h().

◆ _cp_idx

unsigned int TabulatedFluidProperties::_cp_idx

protectedinherited

Definition at line 354 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::cp_from_p_T(), TabulatedFluidProperties::cp_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _create_direct_pT_interpolations

const bool TabulatedFluidProperties::_create_direct_pT_interpolations

protectedinherited

Whether the object has direct (p,T) interpolations (whether created from file or from _fp)

Definition at line 298 of file TabulatedFluidProperties.h.

◆ _create_direct_ve_interpolations

const bool TabulatedFluidProperties::_create_direct_ve_interpolations

protectedinherited

Whether the object has direct (v,e) interpolations (whether created from file or from _fp)

Definition at line 300 of file TabulatedFluidProperties.h.

◆ _csv_reader

MooseUtils::DelimitedFileReader TabulatedFluidProperties::_csv_reader

protectedinherited

The MOOSE delimited file reader.

Definition at line 361 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _cv_idx

unsigned int TabulatedFluidProperties::_cv_idx

protectedinherited

Definition at line 355 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::cv_from_p_T(), TabulatedFluidProperties::cv_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _density_idx

unsigned int TabulatedFluidProperties::_density_idx

protectedinherited

Index of each property.

Definition at line 348 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::rho_from_p_T(), TabulatedFluidProperties::v_from_p_T(), and TabulatedFluidProperties::writeTabulatedData().

◆ _e_bounds_specified

bool TabulatedFluidProperties::_e_bounds_specified

protectedinherited

Whether the specific internal energy bounds were set by the user.

Definition at line 405 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _e_max

Real TabulatedFluidProperties::_e_max

protectedinherited

Maximum internal energy in tabulated data (can be user-specified)

Definition at line 411 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInputVariablesVE(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::readFileTabulationData(), TabulatedFluidProperties::TabulatedFluidProperties(), and TabulatedFluidProperties::v_from_p_T().

◆ _e_min

Real TabulatedFluidProperties::_e_min

protectedinherited

Minimum internal energy in tabulated data (can be user-specified)

Definition at line 409 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInputVariablesVE(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::readFileTabulationData(), TabulatedFluidProperties::TabulatedFluidProperties(), and TabulatedFluidProperties::v_from_p_T().

◆ _enthalpy

std::vector<Real> TabulatedFluidProperties::_enthalpy

protectedinherited

Specific enthalpy vector.

Definition at line 295 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), and TabulatedFluidProperties::createVHGridVectors().

◆ _enthalpy_idx

unsigned int TabulatedFluidProperties::_enthalpy_idx

protectedinherited

Definition at line 349 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::h_from_p_T(), and TabulatedFluidProperties::writeTabulatedData().

◆ _entropy_idx

unsigned int TabulatedFluidProperties::_entropy_idx

protectedinherited

Definition at line 356 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::s_from_p_T(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _file_name_in

FileName TabulatedFluidProperties::_file_name_in

protectedinherited

File name of input tabulated data file.

Definition at line 276 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::initialSetup(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _file_name_out

FileName TabulatedFluidProperties::_file_name_out

protectedinherited

File name of output tabulated data file.

Definition at line 280 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::initialSetup(), and TabulatedFluidProperties::writeTabulatedData().

◆ _file_name_ve_in

FileName TabulatedFluidProperties::_file_name_ve_in

protectedinherited

File name of input (v,e) tabulated data file.

Definition at line 278 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::initialSetup(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _file_name_ve_out

FileName TabulatedFluidProperties::_file_name_ve_out

protectedinherited

File name of output (v,e) tabulated data file.

Definition at line 282 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::writeTabulatedData().

◆ _fp

const SinglePhaseFluidProperties* const TabulatedFluidProperties::_fp

protectedinherited

SinglePhaseFluidPropertiesPT UserObject.

Definition at line 326 of file TabulatedFluidProperties.h.

◆ _h_max

Real TabulatedFluidProperties::_h_max

protectedinherited

Maximum specific enthalpy in tabulated data.

Definition at line 419 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVHGridVectors().

◆ _h_min

Real TabulatedFluidProperties::_h_min

protectedinherited

Minimum specific enthalpy in tabulated data.

Definition at line 417 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVHGridVectors().

◆ _initial_setup_done

bool TabulatedFluidProperties::_initial_setup_done

protectedinherited

keeps track of whether initialSetup has been performed

Definition at line 368 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::initialSetup().

◆ _internal_energy

std::vector<Real> TabulatedFluidProperties::_internal_energy

protectedinherited

Specific internal energy vector.

Definition at line 293 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::generateVETabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _internal_energy_idx

unsigned int TabulatedFluidProperties::_internal_energy_idx

protectedinherited

Definition at line 350 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::createVEGridVectors(), and TabulatedFluidProperties::e_from_p_T().

◆ _interpolate_c

bool TabulatedFluidProperties::_interpolate_c

protectedinherited

Definition at line 340 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_p_T(), TabulatedFluidProperties::c_from_v_e(), and TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors().

◆ _interpolate_cp

bool TabulatedFluidProperties::_interpolate_cp

protectedinherited

Definition at line 341 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::cp_from_p_T(), and TabulatedFluidProperties::cp_from_v_e().

◆ _interpolate_cv

bool TabulatedFluidProperties::_interpolate_cv

protectedinherited

Definition at line 342 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::cv_from_p_T(), and TabulatedFluidProperties::cv_from_v_e().

◆ _interpolate_density

bool TabulatedFluidProperties::_interpolate_density

protectedinherited

Set of flags to note whether a property is to be interpolated.

Definition at line 335 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::rho_from_p_T(), TabulatedFluidProperties::T_from_p_rho(), and TabulatedFluidProperties::v_from_p_T().

◆ _interpolate_enthalpy

bool TabulatedFluidProperties::_interpolate_enthalpy

protectedinherited

Definition at line 336 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), and TabulatedFluidProperties::h_from_p_T().

◆ _interpolate_entropy

bool TabulatedFluidProperties::_interpolate_entropy

protectedinherited

Definition at line 343 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::s_from_p_T(), and TabulatedFluidProperties::s_from_v_e().

◆ _interpolate_internal_energy

bool TabulatedFluidProperties::_interpolate_internal_energy

protectedinherited

Definition at line 337 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::createVEGridVectors(), and TabulatedFluidProperties::e_from_p_T().

◆ _interpolate_k

bool TabulatedFluidProperties::_interpolate_k

protectedinherited

Definition at line 339 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::k_from_p_T(), and TabulatedFluidProperties::k_from_v_e().

◆ _interpolate_pressure

bool TabulatedFluidProperties::_interpolate_pressure

protectedinherited

Definition at line 344 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), and TabulatedFluidProperties::p_from_v_e().

◆ _interpolate_temperature

bool TabulatedFluidProperties::_interpolate_temperature

protectedinherited

Definition at line 345 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), and TabulatedFluidProperties::T_from_v_e().

◆ _interpolate_viscosity

bool TabulatedFluidProperties::_interpolate_viscosity

protectedinherited

Definition at line 338 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::mu_from_p_T(), and TabulatedFluidProperties::mu_from_v_e().

◆ _interpolated_properties

std::vector<std::string> TabulatedFluidProperties::_interpolated_properties

protectedinherited

List of properties to be interpolated.

Definition at line 333 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::generateVETabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _interpolated_properties_enum

MultiMooseEnum TabulatedFluidProperties::_interpolated_properties_enum

protectedinherited

Properties to be interpolated entered in the input file.

Definition at line 331 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::generateVETabulatedData(), and TabulatedFluidProperties::readFileTabulationData().

◆ _k_idx

unsigned int TabulatedFluidProperties::_k_idx

protectedinherited

Definition at line 352 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::k_from_p_T(), TabulatedFluidProperties::k_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _log_space_e

bool TabulatedFluidProperties::_log_space_e

protectedinherited

log-space the internal energy interpolation grid axis instead of linear

Definition at line 376 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVEGridVectors(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _log_space_h

bool TabulatedFluidProperties::_log_space_h

protectedinherited

log-space the enthalpy interpolation grid axis instead of linear

Definition at line 378 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVHGridVectors().

◆ _log_space_v

bool TabulatedFluidProperties::_log_space_v

protectedinherited

log-space the specific volume interpolation grid axis instead of linear

Definition at line 374 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVGridVector(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _max_newton_its

const unsigned int SinglePhaseFluidProperties::_max_newton_its

protectedinherited

Maximum number of iterations for the variable conversion newton solves.

Definition at line 449 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::e_from_v_h(), SinglePhaseFluidProperties::p_T_from_h_s(), SinglePhaseFluidProperties::p_T_from_v_e(), SinglePhaseFluidProperties::p_T_from_v_h(), TemperaturePressureFunctionFluidProperties::T_from_p_h(), SimpleFluidProperties::T_from_p_h(), TabulatedFluidProperties::T_from_p_h(), NaKFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_s(), and TabulatedFluidProperties::v_from_p_T().

◆ _num_e

unsigned int TabulatedFluidProperties::_num_e

protectedinherited

Number of internal energy points in tabulated data.

Definition at line 372 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateVETabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _num_p

unsigned int TabulatedFluidProperties::_num_p

protectedinherited

Number of pressure points in the tabulated data.

Definition at line 323 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _num_T

unsigned int TabulatedFluidProperties::_num_T

protectedinherited

Number of temperature points in the tabulated data.

Definition at line 321 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _num_v

unsigned int TabulatedFluidProperties::_num_v

protectedinherited

Number of specific volume points in the tabulated data.

Definition at line 370 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::generateVETabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _OOBBehavior

MooseEnum TabulatedFluidProperties::_OOBBehavior

protectedinherited

User-selected out-of-bounds behavior.

Definition at line 381 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInputVariables(), TabulatedFluidProperties::checkInputVariablesVE(), constructInterpolation(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _p_from_v_e_ipol

std::unique_ptr<BidimensionalInterpolation> TabulatedFluidProperties::_p_from_v_e_ipol

protectedinherited

Bi-dimensional interpolation of pressure from (v,e)

Definition at line 396 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_v_e(), constructInterpolation(), TabulatedFluidProperties::cp_from_v_e(), TabulatedFluidProperties::cv_from_v_e(), TabulatedFluidProperties::k_from_v_e(), TabulatedFluidProperties::mu_from_v_e(), TabulatedFluidProperties::p_from_v_e(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _p_from_v_h_ipol

std::unique_ptr<BidimensionalInterpolation> TabulatedFluidProperties::_p_from_v_h_ipol

protectedinherited

Bidimensional interpolation of pressure from (v,h)

Definition at line 402 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), and TabulatedFluidProperties::e_from_v_h().

◆ _p_idx

unsigned int TabulatedFluidProperties::_p_idx

protectedinherited

Definition at line 357 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), and TabulatedFluidProperties::p_from_v_e().

◆ _p_initial_guess

const Real SinglePhaseFluidProperties::_p_initial_guess

protectedinherited

Initial guess for pressure (or pressure used to compute the initial guess)

Definition at line 447 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), constructInterpolation(), TemperaturePressureFunctionFluidProperties::cp_from_v_e(), TemperaturePressureFunctionFluidProperties::cv_from_v_e(), TabulatedFluidProperties::e_from_v_h(), TabulatedFluidProperties::g_from_v_e(), TemperaturePressureFunctionFluidProperties::k_from_v_e(), TemperaturePressureFunctionFluidProperties::mu_from_v_e(), TemperaturePressureFunctionFluidProperties::p_from_v_e(), Water97FluidProperties::p_from_v_e_template(), Water97FluidProperties::p_T_from_v_h(), TabulatedFluidProperties::T_from_h_s(), and TemperaturePressureFunctionFluidProperties::T_from_v_e().

◆ _pressure

std::vector<Real> TabulatedFluidProperties::_pressure

protectedinherited

Pressure vector.

Definition at line 287 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _pressure_max

Real TabulatedFluidProperties::_pressure_max

protectedinherited

Maximum pressure in tabulated data.

Definition at line 319 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::checkInputVariables(), constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateTabulatedData(), outputWarnings(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _pressure_min

Real TabulatedFluidProperties::_pressure_min

protectedinherited

Minimum pressure in tabulated data.

Definition at line 317 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::checkInputVariables(), constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateTabulatedData(), outputWarnings(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _properties

std::vector<std::vector<Real> > TabulatedFluidProperties::_properties

protectedinherited

Tabulated fluid properties (read from file OR computed from _fp)

Definition at line 303 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _properties_ve

std::vector<std::vector<Real> > TabulatedFluidProperties::_properties_ve

protectedinherited

Tabulated fluid properties in (v,e) (read from file OR computed from _fp)

Definition at line 305 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateVETabulatedData(), and TabulatedFluidProperties::readFileTabulationData().

◆ _property_ipol

std::vector<std::unique_ptr<BidimensionalInterpolation> > TabulatedFluidProperties::_property_ipol

protectedinherited

Vector of bi-dimensional interpolation of fluid properties.

Definition at line 308 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_p_T(), constructInterpolation(), TabulatedFluidProperties::cp_from_p_T(), TabulatedFluidProperties::cv_from_p_T(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::h_from_p_T(), TabulatedFluidProperties::k_from_p_T(), TabulatedFluidProperties::mu_from_p_T(), TabulatedFluidProperties::rho_from_p_T(), TabulatedFluidProperties::s_from_p_T(), and TabulatedFluidProperties::v_from_p_T().

◆ _property_ve_ipol

std::vector<std::unique_ptr<BidimensionalInterpolation> > TabulatedFluidProperties::_property_ve_ipol

protectedinherited

Vector of bi-dimensional interpolation of fluid properties directly in (v,e)

Definition at line 310 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_v_e(), constructInterpolation(), TabulatedFluidProperties::cp_from_v_e(), TabulatedFluidProperties::cv_from_v_e(), TabulatedFluidProperties::g_from_v_e(), TabulatedFluidProperties::h_from_p_T(), TabulatedFluidProperties::k_from_v_e(), TabulatedFluidProperties::mu_from_v_e(), TabulatedFluidProperties::p_from_v_e(), TabulatedFluidProperties::s_from_p_T(), TabulatedFluidProperties::s_from_v_e(), and TabulatedFluidProperties::T_from_v_e().

◆ _R

const Real FluidProperties::_R = 8.3144598

staticinherited

Universal gas constant (J/mol/K)

Definition at line 41 of file FluidProperties.h.

Referenced by HelmholtzFluidProperties::c_from_p_T(), IdealGasFluidProperties::c_from_p_T(), MassDiffusionEnergyGasMixDGKernel::computeComponentTotalEnthalpy(), BinaryDiffusionCoefMaterial::computeQpProperties(), HelmholtzFluidProperties::cp_from_p_T(), HelmholtzFluidProperties::cv_from_p_T(), HelmholtzFluidProperties::e_from_p_T(), HelmholtzFluidProperties::h_from_p_T(), LeadLithiumFluidProperties::mu_from_p_T(), LeadLithiumFluidProperties::mu_from_v_e(), HelmholtzFluidProperties::p_from_rho_T(), HelmholtzFluidProperties::rho_from_p_T(), CaloricallyImperfectGas::rho_from_p_T(), IdealGasFluidProperties::rho_from_p_T(), HelmholtzFluidProperties::s_from_p_T(), and TEST_F().

◆ _save_file

const bool TabulatedFluidProperties::_save_file

protectedinherited

Whether to save a generated fluid properties file to disk.

Definition at line 284 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::initialSetup().

◆ _specific_volume

std::vector<Real> TabulatedFluidProperties::_specific_volume

protectedinherited

Specific volume vector.

Definition at line 291 of file TabulatedFluidProperties.h.

Referenced by checkNaNs(), constructInterpolation(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::generateVETabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _T_c2k

const Real FluidProperties::_T_c2k

protectedinherited

Conversion of temperature from Celsius to Kelvin.

Definition at line 45 of file FluidProperties.h.

Referenced by NaKFluidProperties::cp_from_p_T(), NaClFluidProperties::cp_from_p_T(), BrineFluidProperties::cp_from_p_T_X(), NaKFluidProperties::h_from_p_T(), NaClFluidProperties::h_from_p_T(), BrineFluidProperties::h_from_p_T_X(), BrineFluidProperties::haliteSolubility(), NaKFluidProperties::k_from_p_T(), NaClFluidProperties::k_from_p_T(), BrineFluidProperties::k_from_p_T_X(), NaKFluidProperties::mu_from_p_T(), BrineFluidProperties::mu_from_p_T_X(), CO2FluidProperties::partialDensity(), NaKFluidProperties::rho_from_p_T(), NaClFluidProperties::rho_from_p_T(), BrineFluidProperties::rho_from_p_T_X(), and NaKFluidProperties::T_from_p_h().

◆ _T_from_v_e_ipol

std::unique_ptr<BidimensionalInterpolation> TabulatedFluidProperties::_T_from_v_e_ipol

protectedinherited

Bi-dimensional interpolation of temperature from (v,e)

Definition at line 393 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::c_from_v_e(), constructInterpolation(), TabulatedFluidProperties::cp_from_v_e(), TabulatedFluidProperties::cv_from_v_e(), TabulatedFluidProperties::k_from_v_e(), TabulatedFluidProperties::mu_from_v_e(), TabulatedFluidProperties::s_from_v_e(), TabulatedFluidProperties::T_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ _T_from_v_h_ipol

std::unique_ptr<BidimensionalInterpolation> TabulatedFluidProperties::_T_from_v_h_ipol

protectedinherited

Bi-dimensional interpolation of temperature from (v,h)

Definition at line 399 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), and TabulatedFluidProperties::e_from_v_h().

◆ _T_idx

unsigned int TabulatedFluidProperties::_T_idx

protectedinherited

Definition at line 358 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::g_from_v_e(), and TabulatedFluidProperties::T_from_v_e().

◆ _T_initial_guess

const Real SinglePhaseFluidProperties::_T_initial_guess

protectedinherited

Initial guess for temperature (or temperature used to compute the initial guess)

Definition at line 445 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), constructInterpolation(), TemperaturePressureFunctionFluidProperties::cp_from_v_e(), TemperaturePressureFunctionFluidProperties::cv_from_v_e(), TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::g_from_v_e(), TemperaturePressureFunctionFluidProperties::k_from_v_e(), TemperaturePressureFunctionFluidProperties::mu_from_v_e(), Water97FluidProperties::p_T_from_v_h(), Water97FluidProperties::T_drhodT_from_p_rho(), TabulatedFluidProperties::T_from_h_s(), HelmholtzFluidProperties::T_from_p_h(), TemperaturePressureFunctionFluidProperties::T_from_p_h(), TabulatedFluidProperties::T_from_p_h(), NaKFluidProperties::T_from_p_rho(), TemperaturePressureFunctionFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_s(), and TemperaturePressureFunctionFluidProperties::T_from_v_e().

◆ _temperature

std::vector<Real> TabulatedFluidProperties::_temperature

protectedinherited

Temperature vector.

Definition at line 289 of file TabulatedFluidProperties.h.

Referenced by constructInterpolation(), TabulatedFluidProperties::generateTabulatedData(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::writeTabulatedData().

◆ _temperature_max

Real TabulatedFluidProperties::_temperature_max

protectedinherited

Maximum temperature in tabulated data.

Definition at line 315 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::checkInputVariables(), constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateTabulatedData(), outputWarnings(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _temperature_min

Real TabulatedFluidProperties::_temperature_min

protectedinherited

Minimum temperature in tabulated data.

Definition at line 313 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInitialGuess(), TabulatedFluidProperties::checkInputVariables(), constructInterpolation(), TabulatedFluidProperties::createVEGridVectors(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::createVHGridVectors(), TabulatedFluidProperties::generateTabulatedData(), outputWarnings(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _tolerance

const Real SinglePhaseFluidProperties::_tolerance

protectedinherited

Newton's method may be used to convert between variable sets.

Relative tolerance of the solves

Definition at line 443 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::e_from_v_h(), TemperaturePressureFunctionFluidProperties::p_from_v_e(), Water97FluidProperties::p_from_v_e_template(), SinglePhaseFluidProperties::p_T_from_h_s(), SinglePhaseFluidProperties::p_T_from_v_e(), SinglePhaseFluidProperties::p_T_from_v_h(), Water97FluidProperties::T_drhodT_from_p_rho(), HelmholtzFluidProperties::T_from_p_h(), TemperaturePressureFunctionFluidProperties::T_from_p_h(), SimpleFluidProperties::T_from_p_h(), TabulatedFluidProperties::T_from_p_h(), NaKFluidProperties::T_from_p_rho(), TemperaturePressureFunctionFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_s(), and TabulatedFluidProperties::v_from_p_T().

◆ _v_bounds_specified

bool TabulatedFluidProperties::_v_bounds_specified

protectedinherited

Whether the specific volume bounds were set by the user.

Definition at line 407 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::readFileTabulationData(), and TabulatedFluidProperties::TabulatedFluidProperties().

◆ _v_max

Real TabulatedFluidProperties::_v_max

protectedinherited

Maximum specific volume in tabulated data (can be user-specified)

Definition at line 415 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInputVariablesVE(), checkNaNs(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::readFileTabulationData(), TabulatedFluidProperties::TabulatedFluidProperties(), and TabulatedFluidProperties::v_from_p_T().

◆ _v_min

Real TabulatedFluidProperties::_v_min

protectedinherited

Minimum specific volume in tabulated data (can be user-specified)

Definition at line 413 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::checkInputVariablesVE(), checkNaNs(), TabulatedFluidProperties::createVGridVector(), TabulatedFluidProperties::readFileTabulationData(), TabulatedFluidProperties::TabulatedFluidProperties(), and TabulatedFluidProperties::v_from_p_T().

◆ _verbose_newton

const bool SinglePhaseFluidProperties::_verbose_newton

protectedinherited

Whether to output information about newton solves to console.

Definition at line 451 of file SinglePhaseFluidProperties.h.

Referenced by TabulatedFluidProperties::e_from_p_rho(), TabulatedFluidProperties::e_from_p_T(), TabulatedFluidProperties::e_from_v_h(), SinglePhaseFluidProperties::p_T_from_h_s(), SinglePhaseFluidProperties::p_T_from_v_e(), SinglePhaseFluidProperties::p_T_from_v_h(), TabulatedFluidProperties::T_from_p_h(), TabulatedFluidProperties::T_from_p_rho(), TabulatedFluidProperties::T_from_p_s(), and TabulatedFluidProperties::v_from_p_T().

◆ _viscosity_idx

unsigned int TabulatedFluidProperties::_viscosity_idx

protectedinherited

Definition at line 351 of file TabulatedFluidProperties.h.

Referenced by TabulatedFluidProperties::computePropertyIndicesInInterpolationVectors(), TabulatedFluidProperties::mu_from_p_T(), TabulatedFluidProperties::mu_from_v_e(), and TabulatedFluidProperties::writeTabulatedData().

◆ h

e e e e s T T T T T rho v v T e SinglePhaseFluidProperties::h

inherited

Definition at line 212 of file SinglePhaseFluidProperties.h.

◆ p [1/10]

e e e e SinglePhaseFluidProperties::p

inherited

Definition at line 190 of file SinglePhaseFluidProperties.h.

◆ p [2/10]

e e e e s SinglePhaseFluidProperties::p

inherited

Definition at line 192 of file SinglePhaseFluidProperties.h.

◆ p [3/10]

e e e e s T T SinglePhaseFluidProperties::p

inherited

Definition at line 196 of file SinglePhaseFluidProperties.h.

◆ p [4/10]

e e e e s T T T SinglePhaseFluidProperties::p

inherited

Definition at line 198 of file SinglePhaseFluidProperties.h.

◆ p [5/10]

e e e e s T T T T SinglePhaseFluidProperties::p

inherited

Definition at line 200 of file SinglePhaseFluidProperties.h.

◆ p [6/10]

e e e e s T T T T T SinglePhaseFluidProperties::p

inherited

Definition at line 202 of file SinglePhaseFluidProperties.h.

◆ p [7/10]

e e e e s T T T T T rho v v SinglePhaseFluidProperties::p

inherited

Definition at line 208 of file SinglePhaseFluidProperties.h.

◆ p [8/10]

e e e e s T T T T T rho v v T e p SinglePhaseFluidProperties::p

inherited

Definition at line 214 of file SinglePhaseFluidProperties.h.

◆ p [9/10]

e e e e s T T T T T rho v v T e p T SinglePhaseFluidProperties::p

inherited

Definition at line 216 of file SinglePhaseFluidProperties.h.

◆ p [10/10]

e e e e s T T T T T rho v v T e p T T SinglePhaseFluidProperties::p

inherited

Definition at line 218 of file SinglePhaseFluidProperties.h.

◆ rho

e e e e s T SinglePhaseFluidProperties::rho

inherited

Definition at line 194 of file SinglePhaseFluidProperties.h.

◆ T [1/2]

e e e e s T T T T T rho SinglePhaseFluidProperties::T

inherited

Definition at line 204 of file SinglePhaseFluidProperties.h.

◆ T [2/2]

e e e e s T T T T T rho v SinglePhaseFluidProperties::T

inherited

Definition at line 206 of file SinglePhaseFluidProperties.h.

◆ v [1/5]

SinglePhaseFluidProperties::v

inherited

Definition at line 182 of file SinglePhaseFluidProperties.h.

◆ v [2/5]

e SinglePhaseFluidProperties::v

inherited

Definition at line 184 of file SinglePhaseFluidProperties.h.

◆ v [3/5]

e e SinglePhaseFluidProperties::v

inherited

Definition at line 186 of file SinglePhaseFluidProperties.h.

◆ v [4/5]

e e e SinglePhaseFluidProperties::v

inherited

Definition at line 188 of file SinglePhaseFluidProperties.h.

◆ v [5/5]

e e e e s T T T T T rho v v T SinglePhaseFluidProperties::v

inherited

Definition at line 210 of file SinglePhaseFluidProperties.h.

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

fluid_properties/include/fluidproperties/TabulatedBicubicFluidProperties.h
fluid_properties/src/fluidproperties/TabulatedBicubicFluidProperties.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ OOBBehavior

Constructor & Destructor Documentation

◆ TabulatedBicubicFluidProperties()

Member Function Documentation

◆ c_from_p_T() [1/2]

◆ c_from_p_T() [2/2]

◆ c_from_v_e() [1/2]

◆ c_from_v_e() [2/2]

◆ checkFileTabulationGrids()

◆ checkInitialGuess()

◆ checkInputVariables()

◆ checkInputVariablesVE()

◆ checkNaNs()

◆ checkOutofBounds()

◆ computePropertyIndicesInInterpolationVectors()

◆ constructInterpolation()

◆ cp_from_p_T() [1/2]

◆ cp_from_p_T() [2/2]

◆ cp_from_v_e() [1/2]

◆ cp_from_v_e() [2/2]

◆ createVEGridVectors()

◆ createVGridVector()

◆ createVHGridVectors()

◆ criticalDensity()

◆ criticalInternalEnergy()

◆ criticalPressure()

◆ criticalTemperature()

◆ cv_from_p_T() [1/2]

◆ cv_from_p_T() [2/2]

◆ cv_from_v_e() [1/2]

◆ cv_from_v_e() [2/2]

◆ e_from_p_rho() [1/3]

◆ e_from_p_rho() [2/3]

◆ e_from_p_rho() [3/3]

◆ e_from_p_T() [1/3]

◆ e_from_p_T() [2/3]

◆ e_from_p_T() [3/3]

◆ e_from_v_h() [1/2]

◆ e_from_v_h() [2/2]

◆ e_spndl_from_v()

◆ execute()

◆ finalize()

◆ fluidName()

◆ g_from_v_e()

◆ generateTabulatedData()

◆ generateVETabulatedData()

◆ h_from_p_T() [1/3]

◆ h_from_p_T() [2/3]

◆ h_from_p_T() [3/3]

◆ henryCoefficients()

◆ initialize()

◆ initialSetup()

◆ k_from_p_T() [1/2]

◆ k_from_p_T() [2/2]

◆ k_from_v_e() [1/2]

◆ k_from_v_e() [2/2]

◆ makeZeroAndOne() [1/2]

◆ makeZeroAndOne() [2/2]

◆ missingVEInterpolationError()

◆ molarMass()

◆ mu_from_p_T() [1/2]

◆ mu_from_p_T() [2/2]

◆ mu_from_v_e() [1/2]

◆ mu_from_v_e() [2/2]

◆ NeedTabulationError()

◆ NeedTabulationOrFPError()

◆ outputWarnings()

◆ p_from_v_e() [1/3]