Fluid properties from a table of pressure, formation volume factor and viscosity (PVDO/PVDG style) More...

#include <TabulatedPVTFluidProperties.h>

Inheritance diagram for TabulatedPVTFluidProperties:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	TabulatedPVTFluidProperties (const InputParameters &parameters)

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

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

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

virtual void	rho_from_p_T (Real p, Real T, Real &rho, Real &drho_dp, Real &drho_dT) const override

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

virtual void	mu_from_p_T (Real p, Real T, Real &mu, Real &dmu_dp, Real &dmu_dT) const override

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

virtual void	e_from_p_T (Real p, Real T, Real &e, Real &de_dp, Real &de_dT) const override

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

virtual void	h_from_p_T (Real p, Real T, Real &h, Real &dh_dp, Real &dh_dT) const override

virtual Real	criticalPressure () const
	Critical pressure.

virtual Real	criticalTemperature () const
	Critical temperature.

virtual Real	criticalDensity () const
	Critical density.

virtual Real	criticalInternalEnergy () const
	Critical specific internal energy.

virtual Real	triplePointPressure () const
	Triple point pressure.

virtual Real	triplePointTemperature () const
	Triple point temperature.

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

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

virtual Real	vaporPressure (Real T) const
	Vapor pressure.

virtual void	vaporPressure (Real T, Real &psat, Real &dpsat_dT) const

virtual ADReal	vaporPressure (const ADReal &T) const

virtual Real	vaporTemperature (Real p) const
	Vapor temperature.

virtual void	vaporTemperature (Real p, Real &Tsat, Real &dTsat_dp) const

virtual ADReal	vaporTemperature (const ADReal &p) const

virtual std::vector< Real >	henryCoefficients () const
	Henry's law coefficients for dissolution in water.

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.

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.

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.

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.

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	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	initialSetup ()

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)

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 class	OOBBehavior { Ignore , Throw , DeclareInvalid , WarnInvalid , SetToClosestBound }
	Property evaluation behavior outside the tabulated pressure range (as in TabulatedFluidProperties). More...

Protected Member Functions
void	interpolate (Real p, const LinearInterpolation &table, Real &value, Real &dvalue_dp) const
	Interpolate a tabulated quantity in pressure, applying the out-of-bounds behavior.

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, const std::string &tag_param_name, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, const std::string &tag_param_name, 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

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::Scalar< const Real >	kokkosCoupledScalarDotDu (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.

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)

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

Protected Attributes
const Real	_density_sc
	Density at standard (surface) conditions (kg/m^3)

const std::vector< Real >	_p
	Tabulated pressures (Pa), strictly increasing.

LinearInterpolation	_inv_B_table
	Interpolation of the reciprocal of the formation volume factor, 1/B, in pressure.

LinearInterpolation	_inv_B_mu_table
	Interpolation of the reciprocal of the product of formation volume factor and viscosity, 1/(B mu), in pressure.

const Real	_cv
	Constant specific heat capacity at constant volume (J/kg/K)

const OOBBehavior	_OOBBehavior

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

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

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

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

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

const Real	_T_c2k
	Conversion of temperature from Celsius to Kelvin.

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

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

Private Member Functions
void	unimplementedDerivativeMethod (const std::string &property_function_name) const

const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

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

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

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

const VariableValue *	getDefaultValue (const std::string &var_name) const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

void	checkVar (const std::string &var_name) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

Moose::Kokkos::Variable	kokkosCoupledVectorTagScalarVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const

Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const

unsigned int	getMaxQps () const

void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
UserObject *	_primary_thread_copy

std::set< std::string >	_supplied_uo

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_fni_object

const InputParameters &	_fni_params

FEProblemBase &	_fni_feproblem

const THREAD_ID	_fni_tid

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const InputParameters &	_dni_params

FEProblemBase &	_dni_feproblem

const MooseObject *const	_dni_moose_object_ptr

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

const RestartableDataMapName	_metaname

std::string	_restartable_name

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const InputParameters &	_sc_parameters

const std::string &	_sc_name

const bool	_sc_is_implicit

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const MooseObject &	_mi_moose_object

const bool	_mi_boundary_restricted

const std::set< SubdomainID > &	_mi_block_ids

const std::set< BoundaryID > &	_mi_boundary_ids

std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > >	_optional_property_proxies

const std::string	_ti_name

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

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

Fluid properties from a table of pressure, formation volume factor and viscosity (PVDO/PVDG style)

Definition at line 19 of file TabulatedPVTFluidProperties.h.

Member Enumeration Documentation

◆ OOBBehavior

enum class TabulatedPVTFluidProperties::OOBBehavior

strongprotected

Property evaluation behavior outside the tabulated pressure range (as in TabulatedFluidProperties).

Must remain in the same order as the MooseEnum in validParams

Enumerator
Ignore
Throw
DeclareInvalid
WarnInvalid
SetToClosestBound

Definition at line 79 of file TabulatedPVTFluidProperties.h.

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

Constructor & Destructor Documentation

◆ TabulatedPVTFluidProperties()

TabulatedPVTFluidProperties::TabulatedPVTFluidProperties ( const InputParameters & parameters )

Definition at line 52 of file TabulatedPVTFluidProperties.C.

  : SinglePhaseFluidProperties(parameters),
    _density_sc(getParam<Real>("density_sc")),
    _p(getParam<std::vector<Real>>("pressure")),
    _cv(getParam<Real>("cv")),
    _OOBBehavior(getParam<MooseEnum>("out_of_bounds_behavior").getEnum<OOBBehavior>())
{
  const auto & B = getParam<std::vector<Real>>("formation_volume_factor");
  const auto & mu = getParam<std::vector<Real>>("viscosity");
 
  if (_p.size() < 2)
    paramError("pressure", "At least two tabulated pressures are required");
  if (B.size() != _p.size())
    paramError("formation_volume_factor", "Must have the same number of entries as 'pressure'");
  if (mu.size() != _p.size())
    paramError("viscosity", "Must have the same number of entries as 'pressure'");
 
  for (std::size_t i = 1; i < _p.size(); ++i)
    if (_p[i] <= _p[i - 1])
      paramError("pressure", "Tabulated pressures must be strictly increasing");
 
  std::vector<Real> inv_B(_p.size());
  std::vector<Real> inv_B_mu(_p.size());
  for (std::size_t i = 0; i < _p.size(); ++i)
  {
    if (B[i] <= 0.0)
      paramError("formation_volume_factor", "All entries must be positive");
    if (mu[i] <= 0.0)
      paramError("viscosity", "All entries must be positive");
    inv_B[i] = 1.0 / B[i];
    inv_B_mu[i] = 1.0 / (B[i] * mu[i]);
  }
 
  // Extrapolate linearly beyond the table for 'ignore' (and for 'throw', so that the one-sided
  // derivative is used exactly at the end points). Otherwise, the interpolation returns the end
  // values with zero derivative outside the table
  const bool extrapolate =
      (_OOBBehavior == OOBBehavior::Ignore || _OOBBehavior == OOBBehavior::Throw);
  _inv_B_table = LinearInterpolation(_p, inv_B, extrapolate);
  _inv_B_mu_table = LinearInterpolation(_p, inv_B_mu, extrapolate);
}

Member Function Documentation

◆ criticalDensity()

Real SinglePhaseFluidProperties::criticalDensity ( ) const

virtualinherited

Critical density.

Returns: critical density (kg/m^3)

Reimplemented in CaloricallyImperfectGas, CO2FluidProperties, HydrogenFluidProperties, IdealGasFluidProperties, MethaneFluidProperties, NaClFluidProperties, NitrogenFluidProperties, StiffenedGasFluidProperties, TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 314 of file SinglePhaseFluidProperties.C.

{
  return rho_from_p_T(criticalPressure(), criticalTemperature());
}

◆ criticalInternalEnergy()

Real SinglePhaseFluidProperties::criticalInternalEnergy ( ) const

virtualinherited

Critical specific internal energy.

Returns: specific internal energy (J/kg)

Reimplemented in CaloricallyImperfectGas, IdealGasFluidProperties, and StiffenedGasFluidProperties.

Definition at line 320 of file SinglePhaseFluidProperties.C.

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

◆ criticalPressure()

Real SinglePhaseFluidProperties::criticalPressure ( ) const

virtualinherited

Critical pressure.

Returns: critical pressure (Pa)

Reimplemented in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NaClFluidProperties, NitrogenFluidProperties, TabulatedFluidProperties, Water97FluidProperties, and TestSinglePhaseFluidProperties.

Definition at line 302 of file SinglePhaseFluidProperties.C.

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

Referenced by SinglePhaseFluidProperties::criticalDensity(), SinglePhaseFluidProperties::criticalInternalEnergy(), and TabulatedFluidProperties::criticalPressure().

◆ criticalTemperature()

Real SinglePhaseFluidProperties::criticalTemperature ( ) const

virtualinherited

Critical temperature.

Returns: critical temperature (K)

Reimplemented in CaloricallyImperfectGas, CO2FluidProperties, HydrogenFluidProperties, IdealGasFluidProperties, MethaneFluidProperties, NaClFluidProperties, NitrogenFluidProperties, StiffenedGasFluidProperties, TabulatedFluidProperties, Water97FluidProperties, and TestSinglePhaseFluidProperties.

Definition at line 308 of file SinglePhaseFluidProperties.C.

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

◆ e_from_p_T() [1/2]

Real TabulatedPVTFluidProperties::e_from_p_T	(	Real	p,
		Real	T
	)		const

overridevirtual

Definition at line 198 of file TabulatedPVTFluidProperties.C.

{
  return _cv * T;
}

Referenced by e_from_p_T(), and h_from_p_T().

◆ e_from_p_T() [2/2]

void TabulatedPVTFluidProperties::e_from_p_T	(	Real	p,
		Real	T,
		Real &	e,
		Real &	de_dp,
		Real &	de_dT
	)		const

overridevirtual

Definition at line 204 of file TabulatedPVTFluidProperties.C.

{
  e = e_from_p_T(p, T);
  de_dp = 0.0;
  de_dT = _cv;
}

◆ 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 CaloricallyImperfectGas, IdealGasFluidProperties, 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 TabulatedPVTFluidProperties::fluidName ( ) const

overridevirtual

Fluid name.

Returns: string representing fluid name

Reimplemented from SinglePhaseFluidProperties.

Definition at line 95 of file TabulatedPVTFluidProperties.C.

{
  return "tabulated_pvt";
}

◆ h_from_p_T() [1/2]

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

overridevirtual

Definition at line 212 of file TabulatedPVTFluidProperties.C.

{
  Real h, dh_dp, dh_dT;
  h_from_p_T(p, T, h, dh_dp, dh_dT);
  return h;
}

Referenced by h_from_p_T().

◆ h_from_p_T() [2/2]

void TabulatedPVTFluidProperties::h_from_p_T	(	Real	p,
		Real	T,
		Real &	h,
		Real &	dh_dp,
		Real &	dh_dT
	)		const

overridevirtual

Definition at line 220 of file TabulatedPVTFluidProperties.C.

{
  Real rho, drho_dp, drho_dT;
  rho_from_p_T(p, T, rho, drho_dp, drho_dT);
 
  // h = e + p / rho
  h = e_from_p_T(p, T) + p / rho;
  dh_dp = 1.0 / rho - p * drho_dp / (rho * rho);
  dh_dT = _cv;
}

◆ henryCoefficients()

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

virtualinherited

Henry's law coefficients for dissolution in water.

Returns: Henry's constant coefficients

Reimplemented in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NitrogenFluidProperties, and TabulatedFluidProperties.

Definition at line 378 of file SinglePhaseFluidProperties.C.

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

Referenced by TabulatedFluidProperties::henryCoefficients().

◆ initialize()

virtual void FluidProperties::initialize ( )

inlinefinalvirtualinherited

Implements ThreadedGeneralUserObject.

Definition at line 34 of file FluidProperties.h.

34{}

◆ interpolate()

void TabulatedPVTFluidProperties::interpolate	(	Real	p,
		const LinearInterpolation &	table,
		Real &	value,
		Real &	dvalue_dp
	)		const

protected

Interpolate a tabulated quantity in pressure, applying the out-of-bounds behavior.

Parameters

	p	pressure (Pa)
	table	interpolation of the tabulated quantity
[out]	value	interpolated value at p
[out]	dvalue_dp	derivative of the interpolated value with respect to p

Definition at line 110 of file TabulatedPVTFluidProperties.C.

{
  if (p < _p.front() || p > _p.back())
    switch (_OOBBehavior)
    {
      case OOBBehavior::Ignore:
      case OOBBehavior::SetToClosestBound:
        break;
 
      case OOBBehavior::Throw:
        throw MooseException(
            "Pressure " + Moose::stringify(p) + " is outside the range of tabulated pressure (" +
            Moose::stringify(_p.front()) + ", " + Moose::stringify(_p.back()) + ").");
 
      // The messages must differ: the solution invalidity registry identifies an entry by its
      // object type and message, and requires each entry to be either an error or a warning
      case OOBBehavior::DeclareInvalid:
        flagInvalidSolution("Pressure outside the tabulated range: set to the closest bound");
        break;
 
      case OOBBehavior::WarnInvalid:
        flagSolutionWarning("Pressure outside the tabulated range: set to the closest bound "
                            "(warning only)");
        break;
    }
 
  value = table.sample(p);
  dvalue_dp = table.sampleDerivative(p);
}

Referenced by mu_from_p_T(), and rho_from_p_T().

◆ makeZeroAndOne() [1/2]

template<>

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

inlineinherited

Definition at line 485 of file SinglePhaseFluidProperties.h.

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

◆ makeZeroAndOne() [2/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.

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

Referenced by SinglePhaseFluidProperties::xyDerivatives().

◆ molarMass()

Real TabulatedPVTFluidProperties::molarMass ( ) const

overridevirtual

Molar mass [kg/mol].

Returns: molar mass

Reimplemented from SinglePhaseFluidProperties.

Definition at line 101 of file TabulatedPVTFluidProperties.C.

{
  if (!isParamValid("molar_mass"))
    paramError("molar_mass",
               "molar_mass must be provided because it is required by another object");
  return getParam<Real>("molar_mass");
}

◆ mu_from_p_T() [1/2]

Real TabulatedPVTFluidProperties::mu_from_p_T	(	Real	p,
		Real	T
	)		const

overridevirtual

Definition at line 170 of file TabulatedPVTFluidProperties.C.

{
  Real mu, dmu_dp, dmu_dT;
  mu_from_p_T(p, T, mu, dmu_dp, dmu_dT);
  return mu;
}

Referenced by mu_from_p_T().

◆ mu_from_p_T() [2/2]

void TabulatedPVTFluidProperties::mu_from_p_T	(	Real	p,
		Real	T,
		Real &	mu,
		Real &	dmu_dp,
		Real &	dmu_dT
	)		const

overridevirtual

Definition at line 178 of file TabulatedPVTFluidProperties.C.

{
  Real inv_B, dinv_B_dp, inv_B_mu, dinv_B_mu_dp;
  interpolate(p, _inv_B_table, inv_B, dinv_B_dp);
  interpolate(p, _inv_B_mu_table, inv_B_mu, dinv_B_mu_dp);
 
  if (inv_B <= 0.0 || inv_B_mu <= 0.0)
    throw MooseException(name(),
                         ": the viscosity is non-positive at pressure ",
                         p,
                         ", which is outside the tabulated range. Extend the table.");
 
  // mu = (1/B) / (1/(B mu))
  mu = inv_B / inv_B_mu;
  dmu_dp = (dinv_B_dp * inv_B_mu - inv_B * dinv_B_mu_dp) / (inv_B_mu * inv_B_mu);
  dmu_dT = 0.0;
}

◆ 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.

{
  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"));
}

Referenced by TabulatedFluidProperties::T_from_h_s().

◆ 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.

{
  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"));
}

Referenced by TabulatedBicubicFluidProperties::constructInterpolation(), TemperaturePressureFunctionFluidProperties::cp_from_v_e(), TemperaturePressureFunctionFluidProperties::cv_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().

◆ 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.

{
  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"));
}

Referenced by TabulatedBicubicFluidProperties::constructInterpolation().

◆ propfunc() [1/12]

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

inherited

◆ propfunc() [2/12]

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

inherited

◆ propfunc() [3/12]

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

inherited

◆ propfunc() [4/12]

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

inherited

◆ propfunc() [5/12]

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

inherited

◆ propfunc() [6/12]

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

inherited

◆ propfunc() [7/12]

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

inherited

◆ propfunc() [8/12]

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

inherited

◆ propfunc() [9/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:

@begincode 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:

@begincode // 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:

@begincode 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() [10/12]

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

inherited

◆ propfunc() [11/12]

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

inherited

◆ propfunc() [12/12]

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

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 T rho v v T e p T T SinglePhaseFluidProperties::propfuncWithDefault	(	gamma	,
		v	,
		e
	)

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 SinglePhaseFluidProperties::propfuncWithDefault	(	mu	,
		p	,
		T
	)

inherited

◆ propfuncWithDefault() [5/7]

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

inherited

◆ propfuncWithDefault() [6/7]

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

inherited

◆ propfuncWithDefault() [7/7]

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

inherited

◆ 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_T() [1/2]

Real TabulatedPVTFluidProperties::rho_from_p_T	(	Real	p,
		Real	T
	)		const

overridevirtual

Definition at line 144 of file TabulatedPVTFluidProperties.C.

{
  Real rho, drho_dp, drho_dT;
  rho_from_p_T(p, T, rho, drho_dp, drho_dT);
  return rho;
}

Referenced by h_from_p_T(), and rho_from_p_T().

◆ rho_from_p_T() [2/2]

void TabulatedPVTFluidProperties::rho_from_p_T	(	Real	p,
		Real	T,
		Real &	rho,
		Real &	drho_dp,
		Real &	drho_dT
	)		const

overridevirtual

Definition at line 152 of file TabulatedPVTFluidProperties.C.

{
  Real inv_B, dinv_B_dp;
  interpolate(p, _inv_B_table, inv_B, dinv_B_dp);
 
  if (inv_B <= 0.0)
    throw MooseException(name(),
                         ": the formation volume factor is non-positive at pressure ",
                         p,
                         ", which is outside the tabulated range. Extend the table.");
 
  rho = _density_sc * inv_B;
  drho_dp = _density_sc * dinv_B_dp;
  drho_dT = 0.0;
}

◆ rho_mu_from_p_T() [1/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);
}

◆ 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 CO2FluidProperties, HydrogenFluidProperties, NitrogenFluidProperties, and Water97FluidProperties.

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	(	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 CO2FluidProperties, HydrogenFluidProperties, NitrogenFluidProperties, and Water97FluidProperties.

Definition at line 452 of file SinglePhaseFluidProperties.C.

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

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

◆ subdomainSetup()

virtual void FluidProperties::subdomainSetup ( )

inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 38 of file FluidProperties.h.

38{}

◆ threadJoin()

virtual void FluidProperties::threadJoin ( const UserObject & )

inlinefinalvirtualinherited

Reimplemented from ThreadedGeneralUserObject.

Definition at line 37 of file FluidProperties.h.

37{}

◆ triplePointPressure()

Real SinglePhaseFluidProperties::triplePointPressure ( ) const

virtualinherited

Triple point pressure.

Returns: triple point pressure (Pa)

Reimplemented in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NaClFluidProperties, NitrogenFluidProperties, TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 326 of file SinglePhaseFluidProperties.C.

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

Referenced by TabulatedFluidProperties::triplePointPressure().

◆ triplePointTemperature()

Real SinglePhaseFluidProperties::triplePointTemperature ( ) const

virtualinherited

Triple point temperature.

Returns: triple point temperature (K)

Reimplemented in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NaClFluidProperties, NitrogenFluidProperties, TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 332 of file SinglePhaseFluidProperties.C.

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

Referenced by TabulatedFluidProperties::triplePointTemperature().

◆ unimplementedDerivativeMethod()

void SinglePhaseFluidProperties::unimplementedDerivativeMethod ( const std::string & property_function_name ) const

inlineprivateinherited

Definition at line 454 of file SinglePhaseFluidProperties.h.

  {
    const std::string message =
        "The fluid properties class '" + type() +
        "' has not implemented the method below, which computes derivatives of fluid properties "
        "with regards to the flow variables. If your application requires this "
        "method, you must either implement it or use a different fluid properties "
        " class.\n\n" +
        property_function_name;
 
    if (_allow_imperfect_jacobians)
      mooseDoOnce(mooseWarning(message + "\nThe unimplemented derivatives for this fluid property "
                                         "are currently neglected, set to 0."));
    else
      mooseError(message + "\n\nYou can avoid this error by neglecting the "
                           "unimplemented derivatives of fluid properties by setting the "
                           "'allow_imperfect_jacobians' parameter");
  }

Referenced by SinglePhaseFluidProperties::vaporPressure(), and SinglePhaseFluidProperties::vaporTemperature().

◆ 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 &	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_from_p_T() [2/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.

{
  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);
  }
}

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

◆ 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 CaloricallyImperfectGas, IdealGasFluidProperties, and StiffenedGasFluidProperties.

Definition at line 489 of file SinglePhaseFluidProperties.C.

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

◆ validParams()

InputParameters TabulatedPVTFluidProperties::validParams ( )

static

Definition at line 17 of file TabulatedPVTFluidProperties.C.

{
  InputParameters params = SinglePhaseFluidProperties::validParams();
  params.addRequiredRangeCheckedParam<Real>(
      "density_sc",
      "density_sc>0",
      "Density of the fluid at standard (surface) conditions (kg/m^3)");
  params.addRequiredParam<std::vector<Real>>(
      "pressure", "Tabulated pressures (Pa). Must be strictly increasing");
  params.addRequiredParam<std::vector<Real>>(
      "formation_volume_factor",
      "Formation volume factor B (reservoir volume / standard volume) at each tabulated pressure");
  params.addRequiredParam<std::vector<Real>>("viscosity",
                                             "Dynamic viscosity (Pa.s) at each tabulated pressure");
  params.addRangeCheckedParam<Real>(
      "cv", 2000.0, "cv>0", "Constant specific heat capacity at constant volume (J/kg/K)");
  params.addRangeCheckedParam<Real>(
      "molar_mass", "molar_mass>0", "Molar mass of the fluid (kg/mol). Only needed if requested");
  // Same options and wording as TabulatedFluidProperties
  MooseEnum OOBBehavior("ignore throw declare_invalid warn_invalid set_to_closest_bound", "throw");
  params.addParam<MooseEnum>(
      "out_of_bounds_behavior",
      OOBBehavior,
      "Property evaluation behavior when evaluated outside the tabulated pressure range. "
      "'ignore': 1/B and 1/(B mu) are extrapolated linearly from the end intervals of the table; "
      "'throw': an exception is thrown, so the time step is cut; 'set_to_closest_bound': the "
      "pressure is moved to the closest bound of the table; 'declare_invalid' and 'warn_invalid': "
      "as 'set_to_closest_bound', but the solution is also marked as invalid or a warning is "
      "recorded. Results computed outside the table should be used with care");
  params.addClassDescription(
      "Isothermal fluid properties from a table of pressure, formation volume factor and "
      "viscosity (PVDO/PVDG style). 1/B and 1/(B mu) are interpolated linearly in pressure.");
  return params;
}

◆ vaporPressure() [1/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;
}

◆ vaporPressure() [2/3]

Real SinglePhaseFluidProperties::vaporPressure ( Real T ) const

virtualinherited

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 in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NitrogenFluidProperties, TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 372 of file SinglePhaseFluidProperties.C.

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

Referenced by PorousFlowWaterNCG::equilibriumMassFractions(), PorousFlowWaterNCG::gasDensity(), PorousFlowWaterNCG::gasProperties(), SinglePhaseFluidProperties::vaporPressure(), SinglePhaseFluidProperties::vaporPressure(), TabulatedFluidProperties::vaporPressure(), TabulatedFluidProperties::vaporPressure(), and BrineFluidProperties::vaporPressure().

◆ vaporPressure() [3/3]

void SinglePhaseFluidProperties::vaporPressure	(	Real	T,
		Real &	psat,
		Real &	dpsat_dT
	)		const

virtualinherited

Reimplemented in CO2FluidProperties, HydrogenFluidProperties, MethaneFluidProperties, NitrogenFluidProperties, TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 384 of file SinglePhaseFluidProperties.C.

{
  unimplementedDerivativeMethod(__PRETTY_FUNCTION__);
 
  dp_dT = 0.0;
  p = vaporPressure(T);
}

◆ vaporTemperature() [1/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;
}

◆ vaporTemperature() [2/3]

Real SinglePhaseFluidProperties::vaporTemperature ( Real p ) const

virtualinherited

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 in TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 408 of file SinglePhaseFluidProperties.C.

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

Referenced by PorousFlowWaterVapor::thermophysicalProperties(), SinglePhaseFluidProperties::vaporTemperature(), SinglePhaseFluidProperties::vaporTemperature(), TabulatedFluidProperties::vaporTemperature(), and TabulatedFluidProperties::vaporTemperature().

◆ vaporTemperature() [3/3]

void SinglePhaseFluidProperties::vaporTemperature	(	Real	p,
		Real &	Tsat,
		Real &	dTsat_dp
	)		const

virtualinherited

Reimplemented in TabulatedFluidProperties, and Water97FluidProperties.

Definition at line 414 of file SinglePhaseFluidProperties.C.

{
  unimplementedDerivativeMethod(__PRETTY_FUNCTION__);
 
  dT_dp = 0.0;
  T = vaporTemperature(p);
}

◆ 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.

{
  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];
}