- fpThe name of the fluid properties object to query.
C++ Type:UserObjectName
Controllable:No
Description:The name of the fluid properties object to query.
- precisionPrecision for printing values
C++ Type:unsigned int
Controllable:No
Description:Precision for printing values
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:
SinglePhaseFluidPropertiesVaporMixtureFluidPropertiesTwoPhaseFluidProperties(note thatTwoPhaseNCGFluidPropertiesderives 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
[]
[]
Valid Input Combinations
Notation is summarized in the following table:
| Symbol | Description |
|---|---|
| Pressure | |
| Saturation pressure | |
| Critical pressure | |
| Temperature | |
| Saturation temperature | |
| Density | |
| Specific volume | |
| Specific internal energy | |
| Specific total energy | |
| Specific enthalpy | |
| Latent heat of vaporization | |
| Specific entropy | |
| Sound speed | |
| Fluid speed | |
| Dynamic viscosity | |
| Specific heat at constant pressure | |
| Specific heat at constant volume | |
| Thermal conductivity | |
| Volumetric expansion coefficient | |
| Mass fraction of non-condensable gas |
Let the set of single-phase fluid properties be defined as The set of the same quantities for the stagnation state, rather than the static state, is denoted as .
Let the set of valid inputs for single-phase static fluid properties be and the set of valid inputs for single-phase stagnation fluid properties be For single-phase vapor mixture fluid properties, the valid input sets are as follows:
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 Class | Valid Input Combinations | Outputs |
|---|---|---|
SinglePhaseFluidProperties | ||
| , | ||
VaporMixtureFluidProperties | ||
| , | ||
TwoPhaseFluidProperties | ||
| , , | ||
| , , | ||
| , | ||
| , , | ||
| , , , , | ||
TwoPhaseNCGFluidProperties | ||
| , , | ||
| , , | ||
| , | ||
| , | ||
| , , | ||
| , , | ||
| , , , , |
Input Parameters
- TTemperature
C++ Type:double
Controllable:No
Description:Temperature
- eSpecific internal energy
C++ Type:double
Controllable:No
Description:Specific internal energy
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
- jsonFalseOutput in JSON format
Default:False
C++ Type:bool
Controllable:No
Description:Output in JSON format
- pPressure
C++ Type:double
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
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
Controllable:No
Description:Density
- rhoETotal energy density; rho * E
C++ Type:double
Controllable:No
Description:Total energy density; rho * E
- rhouMomentum density; rho * u
C++ Type:double
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
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
Controllable:No
Description:Velocity
- x_ncgMass fractions of NCGs
C++ Type:std::vector<double>
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
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>
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
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
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
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
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
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
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.