FluidPropertiesInterrogator

User object for querying a single-phase or two-phase fluid properties object

Introduction

The FluidPropertiesInterrogator user object is used to query fluid properties objects that derive from the following types:

  • SinglePhaseFluidProperties

  • VaporMixtureFluidProperties

  • TwoPhaseFluidProperties (note that TwoPhaseNCGFluidProperties derives from this)

The user specifies a thermodynamic state at which to evaluate a number of fluid properties. This can be useful for a number of different tasks, such as the following:

  • Determining values for initial conditions or problem setup

  • Verifying out-of-bounds inputs to fluid properties interfaces

  • Getting values to be used in tests

Usage

The interrogator is used with a syntax for AddFluidPropertiesInterrogatorAction. In an input file, the user will only need a block for the FluidPropertiesInterrogator and a block for creating the fluid properties object that will be interrogated. For convenience, an input file to use the interrogator is provided in the module:

# The parameters in this block are used to specify the thermodynamic state
# at which to query the fluid properties package
[FluidPropertiesInterrogator]
  fp = fp
  p = 1e5
  T = 300
  vel = 10
[]

# The fluid properties (equation of state) to query is defined here
[FluidProperties]
  [fp]
    type = IdealGasFluidProperties
  []
[]
(contrib/moose/modules/fluid_properties/fp_interrogator/fp_interrogator.i)

Valid Input Combinations

Notation is summarized in the following table:

SymbolDescription
ppPressure
psatp_{sat}Saturation pressure
pcritp_{crit}Critical pressure
TTTemperature
TsatT_{sat}Saturation temperature
ρ\rhoDensity
vvSpecific volume
eeSpecific internal energy
EESpecific total energy
hhSpecific enthalpy
Δhv\Delta h_{\ell\rightarrow v}Latent heat of vaporization
ssSpecific entropy
ccSound speed
uuFluid speed
μ\muDynamic viscosity
cpc_pSpecific heat at constant pressure
cvc_vSpecific heat at constant volume
kkThermal conductivity
β\betaVolumetric expansion coefficient
xNCGx_{NCG}Mass fraction of non-condensable gas

Let the set of single-phase fluid properties be defined as P{p,T,ρ,v,e,h,s,c,μ,cp,cv,k,β}. \mathcal{P} \equiv \{p, T, \rho, v, e, h, s, c, \mu, c_p, c_v, k, \beta\} \,. The set of the same quantities for the stagnation state, rather than the static state, is denoted as P0\mathcal{P}_0.

Let the set of valid inputs for single-phase static fluid properties be A{{p,T},{p,ρ},{ρ,e}}, \mathcal{A} \equiv \{ \{p, T\}, \{p, \rho\}, \{\rho, e\} \} \,, and the set of valid inputs for single-phase stagnation fluid properties be A0{{p,T,u},{p,ρ,u},{ρ,e,u},{ρ,ρu,ρE}}. \mathcal{A}_0 \equiv \{ \{p, T, u\}, \{p, \rho, u\}, \{\rho, e, u\}, \{\rho, \rho u, \rho E\} \} \,. For single-phase vapor mixture fluid properties, the valid input sets are as follows: Amix{{p,T,xNCG},{ρ,e,xNCG}}, \mathcal{A}_{mix} \equiv \{ \{p, T, x_{NCG}\}, \{\rho, e, x_{NCG}\} \} \,, A0,mix{{p,T,xNCG,u},{ρ,e,xNCG,u},{ρ,ρu,ρE,xNCG}}, \mathcal{A}_{0,mix} \equiv \{ \{p, T, x_{NCG}, u\}, \{\rho, e, x_{NCG}, u\}, \{\rho, \rho u, \rho E, x_{NCG}\} \} \,,

The following table summarizes the valid input combinations for single-phase fluid properties objects. Note that TwoPhaseNCGFluidProperties inherits from TwoPhaseFluidProperties, so the column TwoPhaseFluidProperties is used to describe fluid properties classes that derive from TwoPhaseFluidProperties but not TwoPhaseNCGFluidProperties.

Base ClassValid Input CombinationsOutputs
SinglePhaseFluidPropertiesIA\mathcal{I}\in\mathcal{A}P\mathcal{P}
IA0\mathcal{I}\in\mathcal{A}_0P\mathcal{P}, P0\mathcal{P}_0
VaporMixtureFluidPropertiesIAmix\mathcal{I}\in\mathcal{A}_{mix}P\mathcal{P}
IA0,mix\mathcal{I}\in\mathcal{A}_{0,mix}P\mathcal{P}, P0\mathcal{P}_0
TwoPhaseFluidPropertiesI={}\mathcal{I} = \{\}pcritp_{crit}
I{p}\mathcal{I}\in\{p\}pcritp_{crit}, TsatT_{sat}, Δhv\Delta h_{\ell\rightarrow v}
I{T}\mathcal{I}\in\{T\}pcritp_{crit}, psatp_{sat}, Δhv\Delta h_{\ell\rightarrow v}
I{p,T}\mathcal{I}\in\{p, T\}pcritp_{crit}, Δhv\Delta h_{\ell\rightarrow v}
IA,I{p,T}\mathcal{I}\in\mathcal{A}, \mathcal{I}\ne\{p, T\}pcritp_{crit}, P\mathcal{P}_\ell, Pv\mathcal{P}_v
IA0\mathcal{I}\in\mathcal{A}_0pcritp_{crit}, P\mathcal{P}_\ell, Pv\mathcal{P}_v, P0,\mathcal{P}_{0,\ell}, P0,v\mathcal{P}_{0,v}
TwoPhaseNCGFluidPropertiesI={}\mathcal{I} = \{\}pcritp_{crit}
I{p}\mathcal{I}\in\{p\}pcritp_{crit}, TsatT_{sat}, Δhv\Delta h_{\ell\rightarrow v}
I{T}\mathcal{I}\in\{T\}pcritp_{crit}, psatp_{sat}, Δhv\Delta h_{\ell\rightarrow v}
I{p,T}\mathcal{I}\in\{p, T\}pcritp_{crit}, Δhv\Delta h_{\ell\rightarrow v}
IA,I{p,T}\mathcal{I}\in\mathcal{A}, \quad \mathcal{I}\ne\{p, T\}pcritp_{crit}, P\mathcal{P}_\ell
IA0\mathcal{I}\in\mathcal{A}_0pcritp_{crit}, P\mathcal{P}_\ell, P0,\mathcal{P}_{0,\ell}
IAmix\mathcal{I}\in\mathcal{A}_{mix}pcritp_{crit}, P\mathcal{P}_\ell, Pv\mathcal{P}_v
IA0,mix\mathcal{I}\in\mathcal{A}_{0,mix}pcritp_{crit}, P\mathcal{P}_\ell, Pv\mathcal{P}_v, P0,\mathcal{P}_{0,\ell}, P0,v\mathcal{P}_{0,v}

Input Parameters

  • fpThe name of the fluid properties object to query.

    C++ Type:UserObjectName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the fluid properties object to query.

  • precisionPrecision for printing values

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:Precision for printing values

Required Parameters

  • TTemperature

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Temperature

  • eSpecific internal energy

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specific internal energy

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • jsonFalseOutput in JSON format

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Output in JSON format

  • pPressure

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Pressure

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • rhoDensity

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Density

  • rhoETotal energy density; rho * E

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Total energy density; rho * E

  • rhouMomentum density; rho * u

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Momentum density; rho * u

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

  • velVelocity

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Velocity

  • x_ncgMass fractions of NCGs

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Mass fractions of NCGs

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters