https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FluidPropertiesInterrogator Class Reference

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

#include <FluidPropertiesInterrogator.h>

Inheritance diagram for FluidPropertiesInterrogator:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 FluidPropertiesInterrogator (const InputParameters &parameters)
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () 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)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () 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
 
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 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 mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (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)
 
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
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
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 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
 
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)
 
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)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

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 constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

InputParameters compute1Phase (const SinglePhaseFluidProperties *const fp_1phase, bool throw_error_if_no_match)
 Queries a 1-phase fluid properties object. More...
 
InputParameters computeVaporMixture (bool throw_error_if_no_match)
 Queries a vapor mixture fluid properties object. More...
 
InputParameters compute2Phase ()
 Queries a 2-phase fluid properties object. More...
 
std::map< std::string, bool > getSpecifiedSetMap (const std::vector< std::vector< std::string >> &parameter_sets, const std::string &fp_type, bool throw_error_if_no_match) const
 Gets a map of a parameter set to a flag telling whether that set was provided. More...
 
void buildJSON1Phase (nlohmann::json &json, const InputParameters &params)
 Build 1-phase fluid properties in JSON format. More...
 
void buildJSON2Phase (nlohmann::json &json, const InputParameters &params)
 Build 2-phase fluid properties in JSON format. More...
 
void buildJSONVaporMixture (nlohmann::json &json, const InputParameters &params)
 Build vapor mixture fluid properties in JSON format. More...
 
void outputASCII1Phase (const std::string &description, const InputParameters &params)
 Output 1-phase fluid properties in plain text format. More...
 
void outputASCII2Phase (const InputParameters &params)
 Output 2-phase fluid properties in plain text format. More...
 
void outputASCIIVaporMixture (const InputParameters &params)
 Output vapor mixture fluid properties in plain text format. More...
 
void outputHeader (const std::string &header) const
 Outputs a header for a section of properties. More...
 
void outputProperty (const std::string &name, const Real &value, const std::string &units)
 Outputs a property value. More...
 
void outputStaticProperties (const InputParameters &params)
 Outputs static properties for a single-phase fluid properties object. More...
 
void outputStagnationProperties (const InputParameters &params)
 Outputs stagnation properties for a single-phase fluid properties object. More...
 
void outputVaporMixtureStaticProperties (const InputParameters &params)
 Outputs static properties for a vapor mixture fluid properties object. More...
 
void outputVaporMixtureStagnationProperties (const InputParameters &params)
 Outputs stagnation properties for a vapor mixture fluid properties object. More...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
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

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

Protected Attributes

const bool & _json
 true if the output should use JSON format More...
 
const FluidProperties *const _fp
 pointer to fluid properties object More...
 
const SinglePhaseFluidProperties *const _fp_1phase
 pointer to 1-phase fluid properties object (if provided 1-phase object) More...
 
const TwoPhaseFluidProperties *const _fp_2phase
 pointer to 2-phase fluid properties object (if provided 2-phase object) More...
 
const TwoPhaseNCGFluidProperties *const _fp_2phase_ncg
 pointer to 2-phase NCG fluid properties object (if provided 2-phase NCG object) More...
 
const TwoPhaseNCGPartialPressureFluidProperties *const _fp_2phase_ncg_partial_pressure
 pointer to 2-phase NCG partial pressure fluid properties object (if provided) More...
 
const bool _has_1phase
 flag that user provided 1-phase fluid properties More...
 
const bool _has_vapor_mixture
 flag that user provided vapor mixture fluid properties More...
 
const bool _has_2phase
 flag that user provided 2-phase fluid properties More...
 
const bool _has_2phase_ncg
 flag that user provided 2-phase NCG fluid properties More...
 
const bool _has_2phase_ncg_partial_pressure
 flag that user provided 2-phase NCG partial pressure fluid properties More...
 
const SinglePhaseFluidProperties *const _fp_liquid
 pointer to liquid fluid properties object (if provided 2-phase object) More...
 
const SinglePhaseFluidProperties *const _fp_vapor
 pointer to vapor fluid properties object (if provided 2-phase object) More...
 
const VaporMixtureFluidProperties *const _fp_vapor_mixture
 pointer to vapor mixture fluid properties object (if provided 2-phase NCG object) More...
 
bool _nan_encountered
 flag that NaN has been encountered More...
 
const unsigned int & _precision
 Precision used for printing values. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
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 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
 

Detailed Description

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

Definition at line 25 of file FluidPropertiesInterrogator.h.

Constructor & Destructor Documentation

◆ FluidPropertiesInterrogator()

FluidPropertiesInterrogator::FluidPropertiesInterrogator ( const InputParameters &  parameters)

Definition at line 43 of file FluidPropertiesInterrogator.C.

44  : GeneralUserObject(parameters),
45  _json(getParam<bool>("json")),
46  _fp(&getUserObject<FluidProperties>("fp")),
47  _fp_1phase(dynamic_cast<const SinglePhaseFluidProperties * const>(_fp)),
48  _fp_2phase(dynamic_cast<const TwoPhaseFluidProperties * const>(_fp)),
49  _fp_2phase_ncg(dynamic_cast<const TwoPhaseNCGFluidProperties * const>(_fp)),
50  _fp_2phase_ncg_partial_pressure(
51  dynamic_cast<const TwoPhaseNCGPartialPressureFluidProperties * const>(_fp)),
52  _has_1phase(_fp_1phase),
53  _has_vapor_mixture(dynamic_cast<const VaporMixtureFluidProperties * const>(_fp)),
54  _has_2phase(_fp_2phase),
55  _has_2phase_ncg(_fp_2phase_ncg),
56  _has_2phase_ncg_partial_pressure(_fp_2phase_ncg_partial_pressure),
57  _fp_liquid(_has_2phase
58  ? &getUserObjectByName<SinglePhaseFluidProperties>(_fp_2phase->getLiquidName())
59  : nullptr),
60  _fp_vapor(_has_2phase
61  ? &getUserObjectByName<SinglePhaseFluidProperties>(_fp_2phase->getVaporName())
62  : nullptr),
63  _fp_vapor_mixture(_has_vapor_mixture
64  ? dynamic_cast<const VaporMixtureFluidProperties * const>(_fp)
65  : (_has_2phase_ncg ? &getUserObjectByName<VaporMixtureFluidProperties>(
66  _fp_2phase_ncg->getVaporMixtureName())
67  : nullptr)),
68  _nan_encountered(false),
69  _precision(getParam<unsigned int>("precision"))
70 {
71  if (!(_has_1phase || _has_2phase || _has_vapor_mixture))
72  mooseError(
73  "The type of the parameter 'fp' must be derived from type 'SinglePhaseFluidProperties', "
74  "'VaporMixtureFluidProperties', or 'TwoPhaseFluidProperties'.");
75 }
FluidPropertiesInterrogator::_fp_vapor
const SinglePhaseFluidProperties *const _fp_vapor
pointer to vapor fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:182
TwoPhaseFluidProperties::getLiquidName
virtual const UserObjectName & getLiquidName() const
Returns the name of the liquid single-phase fluid properties object.
Definition: TwoPhaseFluidProperties.h:32
TwoPhaseFluidProperties::getVaporName
virtual const UserObjectName & getVaporName() const
Returns the name of the vapor single-phase fluid properties object.
Definition: TwoPhaseFluidProperties.h:37
FluidPropertiesInterrogator::_fp_vapor_mixture
const VaporMixtureFluidProperties *const _fp_vapor_mixture
pointer to vapor mixture fluid properties object (if provided 2-phase NCG object) ...
Definition: FluidPropertiesInterrogator.h:184
FluidPropertiesInterrogator::_fp
const FluidProperties *const _fp
pointer to fluid properties object
Definition: FluidPropertiesInterrogator.h:158
GeneralUserObject::parameters
const InputParameters & parameters() const
FluidPropertiesInterrogator::_fp_2phase
const TwoPhaseFluidProperties *const _fp_2phase
pointer to 2-phase fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:162
FluidPropertiesInterrogator::_has_2phase_ncg
const bool _has_2phase_ncg
flag that user provided 2-phase NCG fluid properties
Definition: FluidPropertiesInterrogator.h:175
FluidPropertiesInterrogator::_precision
const unsigned int & _precision
Precision used for printing values.
Definition: FluidPropertiesInterrogator.h:190
FluidPropertiesInterrogator::_fp_liquid
const SinglePhaseFluidProperties *const _fp_liquid
pointer to liquid fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:180
FluidPropertiesInterrogator::_nan_encountered
bool _nan_encountered
flag that NaN has been encountered
Definition: FluidPropertiesInterrogator.h:187
TwoPhaseNCGFluidProperties::getVaporMixtureName
const UserObjectName & getVaporMixtureName() const
Returns the name of the vapor mixture fluid properties object.
Definition: TwoPhaseNCGFluidProperties.h:35
FluidPropertiesInterrogator::_has_1phase
const bool _has_1phase
flag that user provided 1-phase fluid properties
Definition: FluidPropertiesInterrogator.h:169
FluidPropertiesInterrogator::_fp_2phase_ncg
const TwoPhaseNCGFluidProperties *const _fp_2phase_ncg
pointer to 2-phase NCG fluid properties object (if provided 2-phase NCG object)
Definition: FluidPropertiesInterrogator.h:164
FluidPropertiesInterrogator::_fp_2phase_ncg_partial_pressure
const TwoPhaseNCGPartialPressureFluidProperties *const _fp_2phase_ncg_partial_pressure
pointer to 2-phase NCG partial pressure fluid properties object (if provided)
Definition: FluidPropertiesInterrogator.h:166
FluidPropertiesInterrogator::_has_2phase_ncg_partial_pressure
const bool _has_2phase_ncg_partial_pressure
flag that user provided 2-phase NCG partial pressure fluid properties
Definition: FluidPropertiesInterrogator.h:177
FluidPropertiesInterrogator::_has_vapor_mixture
const bool _has_vapor_mixture
flag that user provided vapor mixture fluid properties
Definition: FluidPropertiesInterrogator.h:171
FluidPropertiesInterrogator::_json
const bool & _json
true if the output should use JSON format
Definition: FluidPropertiesInterrogator.h:156
FluidPropertiesInterrogator::_has_2phase
const bool _has_2phase
flag that user provided 2-phase fluid properties
Definition: FluidPropertiesInterrogator.h:173
GeneralUserObject::GeneralUserObject
GeneralUserObject(const InputParameters &parameters)
GeneralUserObject::mooseError
void mooseError(Args &&... args) const
FluidPropertiesInterrogator::_fp_1phase
const SinglePhaseFluidProperties *const _fp_1phase
pointer to 1-phase fluid properties object (if provided 1-phase object)
Definition: FluidPropertiesInterrogator.h:160

Member Function Documentation

◆ buildJSON1Phase()

void FluidPropertiesInterrogator::buildJSON1Phase ( nlohmann::json &  json,
const InputParameters &  params 
)
protected

Build 1-phase fluid properties in JSON format.

Definition at line 508 of file FluidPropertiesInterrogator.C.

Referenced by execute().

509 {
510  for (auto p : {"rho", "e", "p", "T", "v", "h", "s", "c", "mu", "cp", "cv", "k", "beta"})
511  json["static"][p] = params.get<Real>(p);
512 
513  if (params.have_parameter<Real>("vel"))
514  for (auto p : {"vel",
515  "rho0",
516  "s0",
517  "v0",
518  "e0",
519  "h0",
520  "p0",
521  "T0",
522  "c0",
523  "mu0",
524  "cp0",
525  "cv0",
526  "k0",
527  "beta0"})
528  json["stagnation"][p] = params.get<Real>(p);
529 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::have_parameter
bool have_parameter(std::string_view name) const

◆ buildJSON2Phase()

void FluidPropertiesInterrogator::buildJSON2Phase ( nlohmann::json &  json,
const InputParameters &  params 
)
protected

Build 2-phase fluid properties in JSON format.

Definition at line 532 of file FluidPropertiesInterrogator.C.

Referenced by execute().

533 {
534  json["p_critical"] = params.get<Real>("p_critical");
535  for (auto p : {"T_sat", "p_sat", "h_lat", "sigma"})
536  if (params.have_parameter<Real>(p))
537  json[p] = params.get<Real>(p);
538 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ buildJSONVaporMixture()

void FluidPropertiesInterrogator::buildJSONVaporMixture ( nlohmann::json &  json,
const InputParameters &  params 
)
protected

Build vapor mixture fluid properties in JSON format.

Definition at line 541 of file FluidPropertiesInterrogator.C.

Referenced by execute().

543 {
544  for (auto p : {"p", "T", "rho", "e", "v", "h", "s", "c", "mu", "cp", "cv", "k"})
545  if (params.have_parameter<Real>(p))
546  json["static"][p] = params.get<Real>(p);
547 
548  if (params.have_parameter<Real>("vel"))
549  json["stagnation"]["h0"] = params.get<Real>("h0");
550 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ compute1Phase()

InputParameters FluidPropertiesInterrogator::compute1Phase ( const SinglePhaseFluidProperties *const  fp_1phase,
bool  throw_error_if_no_match 
)
protected

Queries a 1-phase fluid properties object.

Returns
Input parameters holding the computed values
Parameters
[in]fp_1phase1-phase fluid properties
[in]throw_error_if_no_matchOption to throw an error if no sets match the inputs

Definition at line 189 of file FluidPropertiesInterrogator.C.

Referenced by execute().

191 {
192  InputParameters params = emptyInputParameters();
193 
194  // reset NaN flag
195  _nan_encountered = false;
196 
197  // determine how state is specified
198  std::vector<std::vector<std::string>> parameter_sets = {{"p", "T"}, {"rho", "e"}, {"rho", "p"}};
199  if (_has_1phase)
200  parameter_sets.push_back({"rho", "rhou", "rhoE"});
201  auto specified = getSpecifiedSetMap(parameter_sets, "one-phase", throw_error_if_no_match);
202 
203  // compute/determine rho, e, p, T, vel
204 
205  Real rho, e, p, T, vel = 0;
206  bool specified_a_set = false;
207  if (specified["rho,e"])
208  {
209  rho = getParam<Real>("rho");
210  e = getParam<Real>("e");
211  const Real v = 1.0 / rho;
212  p = fp_1phase->p_from_v_e(v, e);
213  T = fp_1phase->T_from_v_e(v, e);
214  if (isParamValid("vel"))
215  vel = getParam<Real>("vel");
216 
217  specified_a_set = true;
218  }
219  else if (specified["rho,p"])
220  {
221  rho = getParam<Real>("rho");
222  p = getParam<Real>("p");
223  const Real v = 1.0 / rho;
224  e = fp_1phase->e_from_p_rho(p, rho);
225  T = fp_1phase->T_from_v_e(v, e);
226  if (isParamValid("vel"))
227  vel = getParam<Real>("vel");
228 
229  specified_a_set = true;
230  }
231  else if (specified["p,T"])
232  {
233  p = getParam<Real>("p");
234  T = getParam<Real>("T");
235  rho = fp_1phase->rho_from_p_T(p, T);
236  e = fp_1phase->e_from_p_rho(p, rho);
237  if (isParamValid("vel"))
238  vel = getParam<Real>("vel");
239 
240  specified_a_set = true;
241  }
242  else if (specified["rho,rhou,rhoE"])
243  {
244  rho = getParam<Real>("rho");
245  const Real rhou = getParam<Real>("rhou");
246  const Real rhoE = getParam<Real>("rhoE");
247 
248  vel = rhou / rho;
249  const Real E = rhoE / rho;
250  e = E - 0.5 * vel * vel;
251 
252  const Real v = 1.0 / rho;
253  p = fp_1phase->p_from_v_e(v, e);
254  T = fp_1phase->T_from_v_e(v, e);
255 
256  specified_a_set = true;
257  }
258 
259  if (specified_a_set)
260  {
261  params.set<bool>("specified") = true;
262 
263  const Real v = 1.0 / rho;
264 
265  params.set<Real>("rho") = rho;
266  params.set<Real>("e") = e;
267  params.set<Real>("p") = p;
268  params.set<Real>("T") = T;
269  params.set<Real>("v") = v;
270  params.set<Real>("h") = fp_1phase->h_from_p_T(p, T);
271  params.set<Real>("s") = fp_1phase->s_from_v_e(v, e);
272  params.set<Real>("c") = fp_1phase->c_from_v_e(v, e);
273  params.set<Real>("mu") = fp_1phase->mu_from_v_e(v, e);
274  params.set<Real>("cp") = fp_1phase->cp_from_v_e(v, e);
275  params.set<Real>("cv") = fp_1phase->cv_from_v_e(v, e);
276  params.set<Real>("k") = fp_1phase->k_from_v_e(v, e);
277  params.set<Real>("beta") = fp_1phase->beta_from_p_T(p, T);
278 
279  if (isParamValid("vel") || specified["rho,rhou,rhoE"])
280  {
281  const Real s = fp_1phase->s_from_v_e(v, e);
282  const Real s0 = s;
283  const Real h = fp_1phase->h_from_p_T(p, T);
284  const Real h0 = h + 0.5 * vel * vel;
285  const Real p0 = fp_1phase->p_from_h_s(h0, s0);
286  const Real rho0 = fp_1phase->rho_from_p_s(p0, s0);
287  const Real e0 = fp_1phase->e_from_p_rho(p0, rho0);
288  const Real v0 = 1.0 / rho0;
289  const Real T0 = fp_1phase->T_from_v_e(v0, e0);
290  const Real c0 = fp_1phase->c_from_v_e(v0, e0);
291  const Real mu0 = fp_1phase->mu_from_v_e(v0, e0);
292  const Real cp0 = fp_1phase->cp_from_v_e(v0, e0);
293  const Real cv0 = fp_1phase->cv_from_v_e(v0, e0);
294  const Real k0 = fp_1phase->k_from_v_e(v0, e0);
295  const Real beta0 = fp_1phase->beta_from_p_T(p0, T0);
296 
297  params.set<Real>("vel") = vel;
298  params.set<Real>("rho0") = rho0;
299  params.set<Real>("s0") = s0;
300  params.set<Real>("v0") = v0;
301  params.set<Real>("e0") = e0;
302  params.set<Real>("h0") = h0;
303  params.set<Real>("p0") = p0;
304  params.set<Real>("T0") = T0;
305  params.set<Real>("c0") = c0;
306  params.set<Real>("mu0") = mu0;
307  params.set<Real>("cp0") = cp0;
308  params.set<Real>("cv0") = cv0;
309  params.set<Real>("k0") = k0;
310  params.set<Real>("beta0") = beta0;
311  }
312 
313  // warn if NaN encountered
314  if (_nan_encountered)
315  mooseWarning(
316  "At least one NaN was encountered. This implies one of the following:\n",
317  " 1. The specified thermodynamic state is inconsistent with the equation of state\n",
318  " (for example, the state corresponds to a different phase of the fluid).\n",
319  " 2. There is a problem with the equation of state package at this state\n",
320  " (for example, the supplied state is outside of the valid state space\n",
321  " that was programmed in the package).");
322  }
323 
324  return params;
325 }
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
emptyInputParameters
InputParameters emptyInputParameters()
FluidPropertiesInterrogator::_nan_encountered
bool _nan_encountered
flag that NaN has been encountered
Definition: FluidPropertiesInterrogator.h:187
FluidPropertiesInterrogator::_has_1phase
const bool _has_1phase
flag that user provided 1-phase fluid properties
Definition: FluidPropertiesInterrogator.h:169
FluidPropertiesInterrogator::getSpecifiedSetMap
std::map< std::string, bool > getSpecifiedSetMap(const std::vector< std::vector< std::string >> &parameter_sets, const std::string &fp_type, bool throw_error_if_no_match) const
Gets a map of a parameter set to a flag telling whether that set was provided.
Definition: FluidPropertiesInterrogator.C:600
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::v
static const std::string v
Definition: NS.h:84
GeneralUserObject::mooseWarning
void mooseWarning(Args &&... args) const
GeneralUserObject::isParamValid
bool isParamValid(const std::string &name) const

◆ compute2Phase()

InputParameters FluidPropertiesInterrogator::compute2Phase ( )
protected

Queries a 2-phase fluid properties object.

Returns
Input parameters holding the computed values

Definition at line 328 of file FluidPropertiesInterrogator.C.

Referenced by execute().

329 {
330  InputParameters params = emptyInputParameters();
331 
332  // reset NaN flag
333  _nan_encountered = false;
334 
335  // determine how state is specified
336  std::vector<std::vector<std::string>> parameter_sets = {{"p", "T"}, {"p"}, {"T"}};
337  auto specified = getSpecifiedSetMap(parameter_sets, "two-phase", true);
338 
339  const Real p_critical = _fp_2phase->p_critical();
340  params.set<Real>("p_critical") = p_critical;
341  if (specified["p"])
342  {
343  const Real p = getParam<Real>("p");
344  const Real T_sat = _fp_2phase->T_sat(p);
345  const Real h_lat = _fp_2phase->h_lat(p, T_sat);
346 
347  params.set<Real>("p") = p;
348  params.set<Real>("T_sat") = T_sat;
349  params.set<Real>("h_lat") = h_lat;
350  }
351  else if (specified["T"])
352  {
353  const Real T = getParam<Real>("T");
354  const Real p_sat = _fp_2phase->p_sat(T);
355  const Real h_lat = _fp_2phase->h_lat(p_sat, T);
356  const Real sigma = _fp_2phase->sigma_from_T(T);
357 
358  params.set<Real>("T") = T;
359  params.set<Real>("p_sat") = p_sat;
360  params.set<Real>("h_lat") = h_lat;
361  params.set<Real>("sigma") = sigma;
362  }
363  else if (specified["p,T"])
364  {
365  const Real p = getParam<Real>("p");
366  const Real T = getParam<Real>("T");
367  const Real h_lat = _fp_2phase->h_lat(p, T);
368 
369  params.set<Real>("p") = p;
370  params.set<Real>("T") = T;
371  params.set<Real>("h_lat") = h_lat;
372  }
373 
374  // warn if NaN encountered
375  if (_nan_encountered)
376  mooseWarning("At least one NaN was encountered.");
377 
378  return params;
379 }
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
FluidPropertiesInterrogator::_fp_2phase
const TwoPhaseFluidProperties *const _fp_2phase
pointer to 2-phase fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:162
emptyInputParameters
InputParameters emptyInputParameters()
FluidPropertiesInterrogator::_nan_encountered
bool _nan_encountered
flag that NaN has been encountered
Definition: FluidPropertiesInterrogator.h:187
TwoPhaseFluidProperties::h_lat
virtual Real h_lat(Real p, Real T) const
Computes latent heat of vaporization.
Definition: TwoPhaseFluidProperties.C:92
TwoPhaseFluidProperties::p_critical
virtual Real p_critical() const =0
Returns the critical pressure.
FluidPropertiesInterrogator::getSpecifiedSetMap
std::map< std::string, bool > getSpecifiedSetMap(const std::vector< std::vector< std::string >> &parameter_sets, const std::string &fp_type, bool throw_error_if_no_match) const
Gets a map of a parameter set to a flag telling whether that set was provided.
Definition: FluidPropertiesInterrogator.C:600
TwoPhaseFluidProperties::p_sat
virtual Real p_sat(Real T) const =0
Computes the saturation pressure at a temperature.
TwoPhaseFluidProperties::T_sat
virtual Real T_sat(Real p) const =0
Computes the saturation temperature at a pressure.
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralUserObject::mooseWarning
void mooseWarning(Args &&... args) const
TwoPhaseFluidProperties::sigma_from_T
virtual Real sigma_from_T(Real T) const
Computes surface tension sigma of saturated liquid in contact with saturated vapor.
Definition: TwoPhaseFluidProperties.C:109

◆ computeVaporMixture()

InputParameters FluidPropertiesInterrogator::computeVaporMixture ( bool  throw_error_if_no_match)
protected

Queries a vapor mixture fluid properties object.

Returns
Input parameters holding the computed values
Parameters
[in]throw_error_if_no_matchOption to throw an error if no sets match the inputs

Definition at line 382 of file FluidPropertiesInterrogator.C.

Referenced by execute().

383 {
384  InputParameters params = emptyInputParameters();
385 
386  // reset NaN flag
387  _nan_encountered = false;
388 
389  // determine how state is specified
390  std::vector<std::vector<std::string>> parameter_sets = {
391  {"p", "T", "x_ncg"}, {"rho", "e", "x_ncg"}, {"rho", "rhou", "rhoE", "x_ncg"}};
392  if (_has_2phase_ncg_partial_pressure)
393  parameter_sets.push_back({"p", "T"});
394  auto specified = getSpecifiedSetMap(parameter_sets, "vapor mixture", throw_error_if_no_match);
395 
396  // compute/determine rho, e, p, T, vel
397 
398  Real rho, e, p, T, vel = 0;
399  std::vector<Real> x_ncg;
400  bool specified_a_set = false;
401  if (specified["rho,e,x_ncg"])
402  {
403  rho = getParam<Real>("rho");
404  e = getParam<Real>("e");
405  x_ncg = getParam<std::vector<Real>>("x_ncg");
406  const Real v = 1.0 / rho;
407  p = _fp_vapor_mixture->p_from_v_e(v, e, x_ncg);
408  T = _fp_vapor_mixture->T_from_v_e(v, e, x_ncg);
409  if (isParamValid("vel"))
410  vel = getParam<Real>("vel");
411 
412  specified_a_set = true;
413  }
414  else if (specified["p,T,x_ncg"])
415  {
416  p = getParam<Real>("p");
417  T = getParam<Real>("T");
418  x_ncg = getParam<std::vector<Real>>("x_ncg");
419  const Real v = _fp_vapor_mixture->v_from_p_T(p, T, x_ncg);
420  rho = 1.0 / v;
421  e = _fp_vapor_mixture->e_from_p_T(p, T, x_ncg);
422  if (isParamValid("vel"))
423  vel = getParam<Real>("vel");
424 
425  specified_a_set = true;
426  }
427  else if (_has_2phase_ncg_partial_pressure && specified["p,T"])
428  {
429  p = getParam<Real>("p");
430  T = getParam<Real>("T");
431  x_ncg = {_fp_2phase_ncg_partial_pressure->x_sat_ncg_from_p_T(p, T)};
432  const Real v = _fp_vapor_mixture->v_from_p_T(p, T, x_ncg);
433  rho = 1.0 / v;
434  e = _fp_vapor_mixture->e_from_p_T(p, T, x_ncg);
435  if (isParamValid("vel"))
436  vel = getParam<Real>("vel");
437 
438  specified_a_set = true;
439  }
440  else if (specified["rho,rhou,rhoE,x_ncg"])
441  {
442  rho = getParam<Real>("rho");
443  const Real rhou = getParam<Real>("rhou");
444  const Real rhoE = getParam<Real>("rhoE");
445  x_ncg = getParam<std::vector<Real>>("x_ncg");
446 
447  vel = rhou / rho;
448  const Real E = rhoE / rho;
449  e = E - 0.5 * vel * vel;
450 
451  const Real v = 1.0 / rho;
452  p = _fp_vapor_mixture->p_from_v_e(v, e, x_ncg);
453  T = _fp_vapor_mixture->T_from_v_e(v, e, x_ncg);
454 
455  specified_a_set = true;
456  }
457 
458  if (specified_a_set)
459  {
460  params.set<bool>("specified") = true;
461 
462  const Real v = 1.0 / rho;
463  const Real h = e + p / rho;
464  const Real s = _fp_vapor_mixture->s_from_p_T(p, T, x_ncg);
465  const Real c = _fp_vapor_mixture->c_from_p_T(p, T, x_ncg);
466  const Real mu = _fp_vapor_mixture->mu_from_p_T(p, T, x_ncg);
467  const Real cp = _fp_vapor_mixture->cp_from_p_T(p, T, x_ncg);
468  const Real cv = _fp_vapor_mixture->cv_from_p_T(p, T, x_ncg);
469  const Real k = _fp_vapor_mixture->k_from_p_T(p, T, x_ncg);
470 
471  params.set<std::vector<Real>>("x_ncg") = x_ncg;
472  params.set<Real>("p") = p;
473  params.set<Real>("T") = T;
474  params.set<Real>("rho") = rho;
475  params.set<Real>("e") = e;
476  params.set<Real>("v") = v;
477  params.set<Real>("h") = h;
478  params.set<Real>("s") = s;
479  params.set<Real>("c") = c;
480  params.set<Real>("mu") = mu;
481  params.set<Real>("cp") = cp;
482  params.set<Real>("cv") = cv;
483  params.set<Real>("k") = k;
484 
485  if (isParamValid("vel") || specified["rho,rhou,rhoE,x_ncg"])
486  {
487  const Real h = e + p / rho;
488  const Real h0 = h + 0.5 * vel * vel;
489 
490  params.set<Real>("h0") = h0;
491  }
492 
493  // warn if NaN encountered
494  if (_nan_encountered)
495  mooseWarning(
496  "At least one NaN was encountered. This implies one of the following:\n",
497  " 1. The specified thermodynamic state is inconsistent with the equation of state\n",
498  " (for example, the state corresponds to a different phase of the fluid).\n",
499  " 2. There is a problem with the equation of state package at this state\n",
500  " (for example, the supplied state is outside of the valid state space\n",
501  " that was programmed in the package).");
502  }
503 
504  return params;
505 }
NS::cv
static const std::string cv
Definition: NS.h:122
FluidPropertiesInterrogator::_fp_vapor_mixture
const VaporMixtureFluidProperties *const _fp_vapor_mixture
pointer to vapor mixture fluid properties object (if provided 2-phase NCG object) ...
Definition: FluidPropertiesInterrogator.h:184
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
TwoPhaseNCGPartialPressureFluidProperties::x_sat_ncg_from_p_T
Real x_sat_ncg_from_p_T(Real p, Real T) const
Computes the NCG mass fraction with the CG saturated at the given temperature.
Definition: TwoPhaseNCGPartialPressureFluidProperties.C:53
emptyInputParameters
InputParameters emptyInputParameters()
FluidPropertiesInterrogator::_nan_encountered
bool _nan_encountered
flag that NaN has been encountered
Definition: FluidPropertiesInterrogator.h:187
NS::cp
static const std::string cp
Definition: NS.h:121
NS::mu
static const std::string mu
Definition: NS.h:123
FluidPropertiesInterrogator::_fp_2phase_ncg_partial_pressure
const TwoPhaseNCGPartialPressureFluidProperties *const _fp_2phase_ncg_partial_pressure
pointer to 2-phase NCG partial pressure fluid properties object (if provided)
Definition: FluidPropertiesInterrogator.h:166
FluidPropertiesInterrogator::getSpecifiedSetMap
std::map< std::string, bool > getSpecifiedSetMap(const std::vector< std::vector< std::string >> &parameter_sets, const std::string &fp_type, bool throw_error_if_no_match) const
Gets a map of a parameter set to a flag telling whether that set was provided.
Definition: FluidPropertiesInterrogator.C:600
FluidPropertiesInterrogator::_has_2phase_ncg_partial_pressure
const bool _has_2phase_ncg_partial_pressure
flag that user provided 2-phase NCG partial pressure fluid properties
Definition: FluidPropertiesInterrogator.h:177
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::v
static const std::string v
Definition: NS.h:84
GeneralUserObject::mooseWarning
void mooseWarning(Args &&... args) const
GeneralUserObject::isParamValid
bool isParamValid(const std::string &name) const
NS::k
static const std::string k
Definition: NS.h:130

◆ execute()

void FluidPropertiesInterrogator::execute ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 83 of file FluidPropertiesInterrogator.C.

84 {
85  if (_has_2phase_ncg)
86  {
87  InputParameters pars_2phase = compute2Phase();
88  InputParameters pars_liquid = compute1Phase(_fp_liquid, false);
89  InputParameters pars_mixture = computeVaporMixture(false);
90 
91  if (_json)
92  {
93  nlohmann::json json;
94 
95  auto & json_2phase = json["2-phase"];
96  buildJSON2Phase(json_2phase, pars_2phase);
97  auto & json_liquid = json["liquid"];
98  buildJSON1Phase(json_liquid, pars_liquid);
99  auto & json_mixture = json["vapor-mixture"];
100  buildJSONVaporMixture(json_mixture, pars_mixture);
101 
102  Moose::out << "**START JSON DATA**\n";
103  Moose::out << json << "\n";
104  Moose::out << "**END JSON DATA**" << std::endl;
105  }
106  else
107  {
108  outputASCII2Phase(pars_2phase);
109  outputASCII1Phase("LIQUID phase", pars_liquid);
110  outputASCIIVaporMixture(pars_mixture);
111  }
112  }
113  else if (_has_2phase)
114  {
115  InputParameters pars_2phase = compute2Phase();
116  InputParameters pars_liquid = compute1Phase(_fp_liquid, false);
117  InputParameters pars_vapor = compute1Phase(_fp_vapor, false);
118 
119  if (_json)
120  {
121  nlohmann::json json;
122 
123  auto & json_2phase = json["2-phase"];
124  buildJSON2Phase(json_2phase, pars_2phase);
125  if (pars_liquid.have_parameter<bool>("specified"))
126  {
127  auto & json_liquid = json["liquid"];
128  buildJSON1Phase(json_liquid, pars_liquid);
129  }
130  if (pars_vapor.have_parameter<bool>("specified"))
131  {
132  auto & json_vapor = json["vapor"];
133  buildJSON1Phase(json_vapor, pars_vapor);
134  }
135 
136  Moose::out << "**START JSON DATA**\n";
137  Moose::out << json << "\n";
138  Moose::out << "**END JSON DATA**" << std::endl;
139  }
140  else
141  {
142  outputASCII2Phase(pars_2phase);
143  if (pars_liquid.have_parameter<bool>("specified"))
144  outputASCII1Phase("LIQUID phase", pars_liquid);
145  if (pars_vapor.have_parameter<bool>("specified"))
146  outputASCII1Phase("VAPOR phase", pars_vapor);
147  }
148  }
149  else if (_has_vapor_mixture)
150  {
151  InputParameters pars_mixture = computeVaporMixture(true);
152  if (_json)
153  {
154  nlohmann::json json;
155  buildJSONVaporMixture(json, pars_mixture);
156 
157  Moose::out << "**START JSON DATA**\n";
158  Moose::out << json << "\n";
159  Moose::out << "**END JSON DATA**" << std::endl;
160  }
161  else
162  outputASCIIVaporMixture(pars_mixture);
163  }
164  else
165  {
166  InputParameters pars_1phase = compute1Phase(_fp_1phase, true);
167 
168  if (_json)
169  {
170  nlohmann::json json;
171 
172  buildJSON1Phase(json, pars_1phase);
173 
174  Moose::out << "**START JSON DATA**\n";
175  Moose::out << json << "\n";
176  Moose::out << "**END JSON DATA**" << std::endl;
177  }
178  else
179  outputASCII1Phase("Single-phase", pars_1phase);
180  }
181 }
FluidPropertiesInterrogator::computeVaporMixture
InputParameters computeVaporMixture(bool throw_error_if_no_match)
Queries a vapor mixture fluid properties object.
Definition: FluidPropertiesInterrogator.C:382
FluidPropertiesInterrogator::_fp_vapor
const SinglePhaseFluidProperties *const _fp_vapor
pointer to vapor fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:182
FluidPropertiesInterrogator::buildJSON1Phase
void buildJSON1Phase(nlohmann::json &json, const InputParameters &params)
Build 1-phase fluid properties in JSON format.
Definition: FluidPropertiesInterrogator.C:508
FluidPropertiesInterrogator::compute1Phase
InputParameters compute1Phase(const SinglePhaseFluidProperties *const fp_1phase, bool throw_error_if_no_match)
Queries a 1-phase fluid properties object.
Definition: FluidPropertiesInterrogator.C:189
FluidPropertiesInterrogator::_has_2phase_ncg
const bool _has_2phase_ncg
flag that user provided 2-phase NCG fluid properties
Definition: FluidPropertiesInterrogator.h:175
FluidPropertiesInterrogator::_fp_liquid
const SinglePhaseFluidProperties *const _fp_liquid
pointer to liquid fluid properties object (if provided 2-phase object)
Definition: FluidPropertiesInterrogator.h:180
FluidPropertiesInterrogator::outputASCII2Phase
void outputASCII2Phase(const InputParameters &params)
Output 2-phase fluid properties in plain text format.
Definition: FluidPropertiesInterrogator.C:569
FluidPropertiesInterrogator::outputASCII1Phase
void outputASCII1Phase(const std::string &description, const InputParameters &params)
Output 1-phase fluid properties in plain text format.
Definition: FluidPropertiesInterrogator.C:553
FluidPropertiesInterrogator::outputASCIIVaporMixture
void outputASCIIVaporMixture(const InputParameters &params)
Output vapor mixture fluid properties in plain text format.
Definition: FluidPropertiesInterrogator.C:585
FluidPropertiesInterrogator::buildJSONVaporMixture
void buildJSONVaporMixture(nlohmann::json &json, const InputParameters &params)
Build vapor mixture fluid properties in JSON format.
Definition: FluidPropertiesInterrogator.C:541
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
FluidPropertiesInterrogator::_has_vapor_mixture
const bool _has_vapor_mixture
flag that user provided vapor mixture fluid properties
Definition: FluidPropertiesInterrogator.h:171
FluidPropertiesInterrogator::_json
const bool & _json
true if the output should use JSON format
Definition: FluidPropertiesInterrogator.h:156
FluidPropertiesInterrogator::compute2Phase
InputParameters compute2Phase()
Queries a 2-phase fluid properties object.
Definition: FluidPropertiesInterrogator.C:328
FluidPropertiesInterrogator::buildJSON2Phase
void buildJSON2Phase(nlohmann::json &json, const InputParameters &params)
Build 2-phase fluid properties in JSON format.
Definition: FluidPropertiesInterrogator.C:532
FluidPropertiesInterrogator::_has_2phase
const bool _has_2phase
flag that user provided 2-phase fluid properties
Definition: FluidPropertiesInterrogator.h:173
FluidPropertiesInterrogator::_fp_1phase
const SinglePhaseFluidProperties *const _fp_1phase
pointer to 1-phase fluid properties object (if provided 1-phase object)
Definition: FluidPropertiesInterrogator.h:160

◆ finalize()

void FluidPropertiesInterrogator::finalize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 184 of file FluidPropertiesInterrogator.C.

185 {
186 }

◆ getSpecifiedSetMap()

std::map< std::string, bool > FluidPropertiesInterrogator::getSpecifiedSetMap ( const std::vector< std::vector< std::string >> &  parameter_sets,
const std::string &  fp_type,
bool  throw_error_if_no_match 
) const
protected

Gets a map of a parameter set to a flag telling whether that set was provided.

Parameters
[in]parameter_setsvector of vectors of strings of parameter names. The first dimension is the parameter set, and the second dimension is a parameter within the set. If a set is a subset of another set, the subset should be after the other.
[in]fp_typestring used to identify the set of parameter sets
[in]throw_error_if_no_matchOption to throw an error if no sets match the inputs

Definition at line 600 of file FluidPropertiesInterrogator.C.

Referenced by compute1Phase(), compute2Phase(), and computeVaporMixture().

604 {
605  // get union of parameters from all sets
606  std::vector<std::string> parameter_union;
607  for (auto & parameter_set : parameter_sets)
608  parameter_union.insert(parameter_union.end(), parameter_set.begin(), parameter_set.end());
609  std::sort(parameter_union.begin(), parameter_union.end());
610  parameter_union.erase(std::unique(parameter_union.begin(), parameter_union.end()),
611  parameter_union.end());
612 
613  std::vector<std::string> parameter_set_names;
614  std::map<std::string, bool> specified;
615  bool specified_a_set = false;
616  for (const auto & parameter_set : parameter_sets)
617  {
618  // create unique string to identify parameter set
619  std::stringstream ss;
620  for (unsigned int i = 0; i < parameter_set.size(); i++)
621  if (i == 0)
622  ss << parameter_set[i];
623  else
624  ss << "," << parameter_set[i];
625  const std::string parameter_set_name = ss.str();
626  parameter_set_names.push_back(parameter_set_name);
627 
628  // check if the set parameters were provided
629  bool all_parameters_provided = true;
630  for (const auto & parameter : parameter_set)
631  if (!isParamValid(parameter))
632  all_parameters_provided = false;
633 
634  if (all_parameters_provided)
635  {
636  // exclude set if a superset (assumed to be ordered before this set) was specified
637  if (!specified_a_set)
638  {
639  specified[parameter_set_name] = true;
640 
641  // check that there are no extraneous parameters
642  std::vector<std::string> parameter_set_sorted(parameter_set);
643  std::sort(parameter_set_sorted.begin(), parameter_set_sorted.end());
644  std::vector<std::string> extraneous_parameters;
645  std::set_difference(parameter_union.begin(),
646  parameter_union.end(),
647  parameter_set_sorted.begin(),
648  parameter_set_sorted.end(),
649  std::inserter(extraneous_parameters, extraneous_parameters.end()));
650  for (const auto & parameter : extraneous_parameters)
651  if (isParamValid(parameter))
652  mooseError("(",
653  parameter_set_name,
654  ") has been specified; ",
655  parameter,
656  " cannot be specified.");
657  }
658 
659  specified_a_set = true;
660  }
661  else
662  specified[parameter_set_name] = false;
663  }
664 
665  if (!specified_a_set && throw_error_if_no_match)
666  {
667  std::stringstream ss;
668  ss << "For " << fp_type
669  << " fluid properties, you must provide one of the following\n"
670  "combinations of thermodynamic properties:\n";
671  for (const auto & parameter_set_name : parameter_set_names)
672  ss << " * (" << parameter_set_name << ")\n";
673  mooseError(ss.str());
674  }
675 
676  return specified;
677 }
GeneralUserObject::mooseError
void mooseError(Args &&... args) const
GeneralUserObject::isParamValid
bool isParamValid(const std::string &name) const

◆ initialize()

void FluidPropertiesInterrogator::initialize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 78 of file FluidPropertiesInterrogator.C.

79 {
80 }

◆ outputASCII1Phase()

void FluidPropertiesInterrogator::outputASCII1Phase ( const std::string &  description,
const InputParameters &  params 
)
protected

Output 1-phase fluid properties in plain text format.

Parameters
[in]descriptionString describing the 1-phase fluid properties
[in]paramsInput parameters with values to print

Definition at line 553 of file FluidPropertiesInterrogator.C.

Referenced by execute().

555 {
556  // output static property values
557  outputHeader(description + " STATIC properties");
558  outputStaticProperties(params);
559 
560  // output stagnation property values
561  if (params.have_parameter<Real>("vel"))
562  {
563  outputHeader(description + " STAGNATION properties");
564  outputStagnationProperties(params);
565  }
566 }
FluidPropertiesInterrogator::outputStaticProperties
void outputStaticProperties(const InputParameters &params)
Outputs static properties for a single-phase fluid properties object.
Definition: FluidPropertiesInterrogator.C:720
FluidPropertiesInterrogator::outputStagnationProperties
void outputStagnationProperties(const InputParameters &params)
Outputs stagnation properties for a single-phase fluid properties object.
Definition: FluidPropertiesInterrogator.C:740
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
FluidPropertiesInterrogator::outputHeader
void outputHeader(const std::string &header) const
Outputs a header for a section of properties.
Definition: FluidPropertiesInterrogator.C:680

◆ outputASCII2Phase()

void FluidPropertiesInterrogator::outputASCII2Phase ( const InputParameters &  params)
protected

Output 2-phase fluid properties in plain text format.

Parameters
[in]paramsInput parameters with values to print

Definition at line 569 of file FluidPropertiesInterrogator.C.

Referenced by execute().

570 {
571  outputHeader("TWO-PHASE properties");
572  outputProperty("Critical pressure", params.get<Real>("p_critical"), "Pa");
573  if (params.have_parameter<Real>("T_sat"))
574  outputProperty("Saturation temperature", params.get<Real>("T_sat"), "K");
575  if (params.have_parameter<Real>("p_sat"))
576  outputProperty("Saturation pressure", params.get<Real>("p_sat"), "Pa");
577  if (params.have_parameter<Real>("h_lat"))
578  outputProperty("Latent heat of vaporization", params.get<Real>("h_lat"), "J/kg");
579  if (params.have_parameter<Real>("sigma"))
580  outputProperty("Surface tension", params.get<Real>("sigma"), "N/m");
581  _console << std::endl;
582 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
FluidPropertiesInterrogator::outputProperty
void outputProperty(const std::string &name, const Real &value, const std::string &units)
Outputs a property value.
Definition: FluidPropertiesInterrogator.C:689
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
FluidPropertiesInterrogator::outputHeader
void outputHeader(const std::string &header) const
Outputs a header for a section of properties.
Definition: FluidPropertiesInterrogator.C:680
GeneralUserObject::_console
const ConsoleStream _console

◆ outputASCIIVaporMixture()

void FluidPropertiesInterrogator::outputASCIIVaporMixture ( const InputParameters &  params)
protected

Output vapor mixture fluid properties in plain text format.

Parameters
[in]paramsInput parameters with values to print

Definition at line 585 of file FluidPropertiesInterrogator.C.

Referenced by execute().

586 {
587  // output static property values
588  outputHeader("Vapor mixture STATIC properties");
589  outputVaporMixtureStaticProperties(params);
590 
591  // output stagnation property values
592  if (params.have_parameter<Real>("vel"))
593  {
594  outputHeader("Vapor mixture STAGNATION properties");
595  outputVaporMixtureStagnationProperties(params);
596  }
597 }
FluidPropertiesInterrogator::outputVaporMixtureStaticProperties
void outputVaporMixtureStaticProperties(const InputParameters &params)
Outputs static properties for a vapor mixture fluid properties object.
Definition: FluidPropertiesInterrogator.C:760
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
FluidPropertiesInterrogator::outputVaporMixtureStagnationProperties
void outputVaporMixtureStagnationProperties(const InputParameters &params)
Outputs stagnation properties for a vapor mixture fluid properties object.
Definition: FluidPropertiesInterrogator.C:782
FluidPropertiesInterrogator::outputHeader
void outputHeader(const std::string &header) const
Outputs a header for a section of properties.
Definition: FluidPropertiesInterrogator.C:680

◆ outputHeader()

void FluidPropertiesInterrogator::outputHeader ( const std::string &  header) const
protected

Outputs a header for a section of properties.

Definition at line 680 of file FluidPropertiesInterrogator.C.

Referenced by outputASCII1Phase(), outputASCII2Phase(), and outputASCIIVaporMixture().

681 {
682  _console << std::endl
683  << std::endl
684  << header << ":" << std::endl
685  << std::setfill('-') << std::setw(80) << "-" << std::setfill(' ') << std::endl;
686 }
GeneralUserObject::_console
const ConsoleStream _console

◆ outputProperty()

void FluidPropertiesInterrogator::outputProperty ( const std::string &  name,
const Real &  value,
const std::string &  units 
)
protected

Outputs a property value.

Definition at line 689 of file FluidPropertiesInterrogator.C.

Referenced by outputASCII2Phase(), outputStagnationProperties(), outputStaticProperties(), outputVaporMixtureStagnationProperties(), and outputVaporMixtureStaticProperties().

692 {
693  const bool use_scientific_notation = ((value < 0.001) || (value >= 10000.0));
694 
695  // check for NaN value
696  const bool is_nan = value != value;
697  if (is_nan)
698  _nan_encountered = true;
699 
700  const std::string units_printed = is_nan ? "" : units;
701 
702  // The console output is not used directly because there is no way to reset
703  // format flags. For example, if scientific format is used, there is no way
704  // to restore the general format (not fixed format); for cout, there are
705  // methods to save and restore format flags, but Console does not provide these.
706  std::stringstream ss;
707 
708  if (use_scientific_notation)
709  ss << std::setw(35) << std::left << name + ":" << std::setw(_precision + 10) << std::right
710  << std::setprecision(_precision) << std::scientific << value << " " << units_printed
711  << std::endl;
712  else
713  ss << std::setw(35) << std::left << name + ":" << std::setw(_precision + 10) << std::right
714  << std::setprecision(_precision) << value << " " << units_printed << std::endl;
715 
716  _console << ss.str();
717 }
FluidPropertiesInterrogator::_precision
const unsigned int & _precision
Precision used for printing values.
Definition: FluidPropertiesInterrogator.h:190
FluidPropertiesInterrogator::_nan_encountered
bool _nan_encountered
flag that NaN has been encountered
Definition: FluidPropertiesInterrogator.h:187
GeneralUserObject::name
const std::string & name() const
value
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
GeneralUserObject::_console
const ConsoleStream _console

◆ outputStagnationProperties()

void FluidPropertiesInterrogator::outputStagnationProperties ( const InputParameters &  params)
protected

Outputs stagnation properties for a single-phase fluid properties object.

Parameters
[in]paramsInput parameters with values to print

Definition at line 740 of file FluidPropertiesInterrogator.C.

Referenced by outputASCII1Phase().

741 {
742  outputProperty("Pressure", params.get<Real>("p0"), "Pa");
743  outputProperty("Temperature", params.get<Real>("T0"), "K");
744  outputProperty("Density", params.get<Real>("rho0"), "kg/m^3");
745  outputProperty("Specific volume", params.get<Real>("v0"), "m^3/kg");
746  outputProperty("Specific internal energy", params.get<Real>("e0"), "J/kg");
747  outputProperty("Specific enthalpy", params.get<Real>("h0"), "J/kg");
748  outputProperty("Specific entropy", params.get<Real>("s0"), "J/(kg-K)");
749  _console << std::endl;
750  outputProperty("Sound speed", params.get<Real>("c0"), "m/s");
751  outputProperty("Dynamic viscosity", params.get<Real>("mu0"), "Pa-s");
752  outputProperty("Specific heat at constant pressure", params.get<Real>("cp0"), "J/(kg-K)");
753  outputProperty("Specific heat at constant volume", params.get<Real>("cv0"), "J/(kg-K)");
754  outputProperty("Thermal conductivity", params.get<Real>("k0"), "W/(m-K)");
755  outputProperty("Volumetric expansion coefficient", params.get<Real>("beta0"), "1/K");
756  _console << std::endl;
757 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
FluidPropertiesInterrogator::outputProperty
void outputProperty(const std::string &name, const Real &value, const std::string &units)
Outputs a property value.
Definition: FluidPropertiesInterrogator.C:689
GeneralUserObject::_console
const ConsoleStream _console

◆ outputStaticProperties()

void FluidPropertiesInterrogator::outputStaticProperties ( const InputParameters &  params)
protected

Outputs static properties for a single-phase fluid properties object.

Parameters
[in]paramsInput parameters with values to print

Definition at line 720 of file FluidPropertiesInterrogator.C.

Referenced by outputASCII1Phase().

721 {
722  outputProperty("Pressure", params.get<Real>("p"), "Pa");
723  outputProperty("Temperature", params.get<Real>("T"), "K");
724  outputProperty("Density", params.get<Real>("rho"), "kg/m^3");
725  outputProperty("Specific volume", params.get<Real>("v"), "m^3/kg");
726  outputProperty("Specific internal energy", params.get<Real>("e"), "J/kg");
727  outputProperty("Specific enthalpy", params.get<Real>("h"), "J/kg");
728  outputProperty("Specific entropy", params.get<Real>("s"), "J/(kg-K)");
729  _console << std::endl;
730  outputProperty("Sound speed", params.get<Real>("c"), "m/s");
731  outputProperty("Dynamic viscosity", params.get<Real>("mu"), "Pa-s");
732  outputProperty("Specific heat at constant pressure", params.get<Real>("cp"), "J/(kg-K)");
733  outputProperty("Specific heat at constant volume", params.get<Real>("cv"), "J/(kg-K)");
734  outputProperty("Thermal conductivity", params.get<Real>("k"), "W/(m-K)");
735  outputProperty("Volumetric expansion coefficient", params.get<Real>("beta"), "1/K");
736  _console << std::endl;
737 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
FluidPropertiesInterrogator::outputProperty
void outputProperty(const std::string &name, const Real &value, const std::string &units)
Outputs a property value.
Definition: FluidPropertiesInterrogator.C:689
GeneralUserObject::_console
const ConsoleStream _console

◆ outputVaporMixtureStagnationProperties()

void FluidPropertiesInterrogator::outputVaporMixtureStagnationProperties ( const InputParameters &  params)
protected

Outputs stagnation properties for a vapor mixture fluid properties object.

Parameters
[in]paramsInput parameters with values to print

Definition at line 782 of file FluidPropertiesInterrogator.C.

Referenced by outputASCIIVaporMixture().

783 {
784  outputProperty("Specific enthalpy", params.get<Real>("h0"), "J/kg");
785  _console << std::endl;
786 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
FluidPropertiesInterrogator::outputProperty
void outputProperty(const std::string &name, const Real &value, const std::string &units)
Outputs a property value.
Definition: FluidPropertiesInterrogator.C:689
GeneralUserObject::_console
const ConsoleStream _console

◆ outputVaporMixtureStaticProperties()

void FluidPropertiesInterrogator::outputVaporMixtureStaticProperties ( const InputParameters &  params)
protected

Outputs static properties for a vapor mixture fluid properties object.

Parameters
[in]paramsInput parameters with values to print

Definition at line 760 of file FluidPropertiesInterrogator.C.

Referenced by outputASCIIVaporMixture().

761 {
762  const auto x_ncg = params.get<std::vector<Real>>("x_ncg");
763  for (unsigned int i = 0; i < x_ncg.size(); i++)
764  outputProperty("Mass fraction " + std::to_string(i), x_ncg[i], "-");
765  outputProperty("Pressure", params.get<Real>("p"), "Pa");
766  outputProperty("Temperature", params.get<Real>("T"), "K");
767  outputProperty("Density", params.get<Real>("rho"), "kg/m^3");
768  outputProperty("Specific volume", params.get<Real>("v"), "m^3/kg");
769  outputProperty("Specific internal energy", params.get<Real>("e"), "J/kg");
770  outputProperty("Specific enthalpy", params.get<Real>("h"), "J/kg");
771  outputProperty("Specific entropy", params.get<Real>("s"), "J/kg");
772  _console << std::endl;
773  outputProperty("Sound speed", params.get<Real>("c"), "m/s");
774  outputProperty("Dynamic viscosity", params.get<Real>("mu"), "Pa-s");
775  outputProperty("Specific heat at constant pressure", params.get<Real>("cp"), "J/(kg-K)");
776  outputProperty("Specific heat at constant volume", params.get<Real>("cv"), "J/(kg-K)");
777  outputProperty("Thermal conductivity", params.get<Real>("k"), "W/(m-K)");
778  _console << std::endl;
779 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
FluidPropertiesInterrogator::outputProperty
void outputProperty(const std::string &name, const Real &value, const std::string &units)
Outputs a property value.
Definition: FluidPropertiesInterrogator.C:689
GeneralUserObject::_console
const ConsoleStream _console

◆ validParams()

InputParameters FluidPropertiesInterrogator::validParams ( )
static

Definition at line 21 of file FluidPropertiesInterrogator.C.

22 {
23  InputParameters params = GeneralUserObject::validParams();
24  params.addRequiredParam<UserObjectName>("fp",
25  "The name of the fluid properties object to query.");
26  params.addParam<bool>("json", false, "Output in JSON format");
27  params.addParam<Real>("rho", "Density");
28  params.addParam<Real>("rhou", "Momentum density; rho * u");
29  params.addParam<Real>("rhoE", "Total energy density; rho * E");
30  params.addParam<Real>("e", "Specific internal energy");
31  params.addParam<Real>("p", "Pressure");
32  params.addParam<Real>("T", "Temperature");
33  params.addParam<Real>("vel", "Velocity");
34  params.addParam<std::vector<Real>>("x_ncg", "Mass fractions of NCGs");
35  params.addRequiredParam<unsigned int>("precision", "Precision for printing values");
36 
37  params.addClassDescription(
38  "User object for querying a single-phase or two-phase fluid properties object");
39 
40  return params;
41 }
GeneralUserObject::validParams
static InputParameters validParams()
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _fp

const FluidProperties* const FluidPropertiesInterrogator::_fp
protected

pointer to fluid properties object

Definition at line 158 of file FluidPropertiesInterrogator.h.

◆ _fp_1phase

const SinglePhaseFluidProperties* const FluidPropertiesInterrogator::_fp_1phase
protected

pointer to 1-phase fluid properties object (if provided 1-phase object)

Definition at line 160 of file FluidPropertiesInterrogator.h.

Referenced by execute().

◆ _fp_2phase

const TwoPhaseFluidProperties* const FluidPropertiesInterrogator::_fp_2phase
protected

pointer to 2-phase fluid properties object (if provided 2-phase object)

Definition at line 162 of file FluidPropertiesInterrogator.h.

Referenced by compute2Phase().

◆ _fp_2phase_ncg

const TwoPhaseNCGFluidProperties* const FluidPropertiesInterrogator::_fp_2phase_ncg
protected

pointer to 2-phase NCG fluid properties object (if provided 2-phase NCG object)

Definition at line 164 of file FluidPropertiesInterrogator.h.

◆ _fp_2phase_ncg_partial_pressure

const TwoPhaseNCGPartialPressureFluidProperties* const FluidPropertiesInterrogator::_fp_2phase_ncg_partial_pressure
protected

pointer to 2-phase NCG partial pressure fluid properties object (if provided)

Definition at line 166 of file FluidPropertiesInterrogator.h.

Referenced by computeVaporMixture().

◆ _fp_liquid

const SinglePhaseFluidProperties* const FluidPropertiesInterrogator::_fp_liquid
protected

pointer to liquid fluid properties object (if provided 2-phase object)

Definition at line 180 of file FluidPropertiesInterrogator.h.

Referenced by execute().

◆ _fp_vapor

const SinglePhaseFluidProperties* const FluidPropertiesInterrogator::_fp_vapor
protected

pointer to vapor fluid properties object (if provided 2-phase object)

Definition at line 182 of file FluidPropertiesInterrogator.h.

Referenced by execute().

◆ _fp_vapor_mixture

const VaporMixtureFluidProperties* const FluidPropertiesInterrogator::_fp_vapor_mixture
protected

pointer to vapor mixture fluid properties object (if provided 2-phase NCG object)

Definition at line 184 of file FluidPropertiesInterrogator.h.

Referenced by computeVaporMixture().

◆ _has_1phase

const bool FluidPropertiesInterrogator::_has_1phase
protected

flag that user provided 1-phase fluid properties

Definition at line 169 of file FluidPropertiesInterrogator.h.

Referenced by compute1Phase(), and FluidPropertiesInterrogator().

◆ _has_2phase

const bool FluidPropertiesInterrogator::_has_2phase
protected

flag that user provided 2-phase fluid properties

Definition at line 173 of file FluidPropertiesInterrogator.h.

Referenced by execute(), and FluidPropertiesInterrogator().

◆ _has_2phase_ncg

const bool FluidPropertiesInterrogator::_has_2phase_ncg
protected

flag that user provided 2-phase NCG fluid properties

Definition at line 175 of file FluidPropertiesInterrogator.h.

Referenced by execute().

◆ _has_2phase_ncg_partial_pressure

const bool FluidPropertiesInterrogator::_has_2phase_ncg_partial_pressure
protected

flag that user provided 2-phase NCG partial pressure fluid properties

Definition at line 177 of file FluidPropertiesInterrogator.h.

Referenced by computeVaporMixture().

◆ _has_vapor_mixture

const bool FluidPropertiesInterrogator::_has_vapor_mixture
protected

flag that user provided vapor mixture fluid properties

Definition at line 171 of file FluidPropertiesInterrogator.h.

Referenced by execute(), and FluidPropertiesInterrogator().

◆ _json

const bool& FluidPropertiesInterrogator::_json
protected

true if the output should use JSON format

Definition at line 156 of file FluidPropertiesInterrogator.h.

Referenced by execute().

◆ _nan_encountered

bool FluidPropertiesInterrogator::_nan_encountered
protected

flag that NaN has been encountered

Definition at line 187 of file FluidPropertiesInterrogator.h.

Referenced by compute1Phase(), compute2Phase(), computeVaporMixture(), and outputProperty().

◆ _precision

const unsigned int& FluidPropertiesInterrogator::_precision
protected

Precision used for printing values.

Definition at line 190 of file FluidPropertiesInterrogator.h.

Referenced by outputProperty().

The documentation for this class was generated from the following files:
Generated on Thu Aug 28 2025 20:23:59 for https://mooseframework.inl.gov by   doxygen 1.8.14