1-phase compressor that must be connected to a Shaft component More...

#include <ShaftConnectedCompressor1Phase.h>

Inheritance diagram for ShaftConnectedCompressor1Phase:

Public Types
enum	VolumeJunction1PhaseIndices { RHOV_INDEX = 0, RHOUV_INDEX = 1, RHOVV_INDEX = 2, RHOWV_INDEX = 3, RHOEV_INDEX = 4 }
	Enumeration for junction variable/equation indices. More...

enum	EEndType { IN, OUT }
	End type. More...

enum	EComponentSetupStatus { CREATED, MESH_PREPARED, INITIALIZED_PRIMARY, INITIALIZED_SECONDARY, CHECKED }
	Component setup status type. More...

typedef DataFileName	DataFileParameterType

Public Member Functions
	ShaftConnectedCompressor1Phase (const InputParameters &params)

virtual void	addVariables () override

virtual void	addMooseObjects () override

virtual UserObjectName	getShaftConnectedUserObjectName () const override

const UserObjectName &	getFluidPropertiesName () const
	Gets the name of fluid properties used in all flow connections. More...

const std::vector< Connection > &	getConnections () const
	Returns the vector of connections of this component. More...

const std::vector< std::string > &	getConnectedComponentNames () const
	Returns a list of names of components that are connected to this component. More...

const std::vector< SubdomainName > &	getConnectedSubdomainNames () const
	Gets the vector of connected subdomain names. More...

virtual const std::vector< dof_id_type > &	getNodeIDs () const
	Gets the list of boundary nodes connected to this component. More...

const std::vector< BoundaryName > &	getBoundaryNames () const
	Gets the boundary names for this component. More...

std::string	stringify (EComponentSetupStatus status) const
	Return a string for the setup status. More...

const std::string &	cname () const
	Get the component name. More...

Component *	parent ()

const THMMesh &	constMesh () const
	Const reference to mesh, which can be called at any point. More...

THMMesh &	mesh ()
	Non-const reference to THM mesh, which can only be called before the end of mesh setup. More...

THMProblem &	getTHMProblem () const
	Gets the THM problem. More...

template<typename T >
bool	hasParam (const std::string &name) const
	Test if a parameter exists in the object's input parameters. More...

const std::vector< std::string > &	getDependencies () const
	Returns a list of names of components that this component depends upon. More...

void	executeInit ()
	Wrapper function for `init()` that marks the function as being called. More...

void	executeInitSecondary ()
	Wrapper function for `initSecondary()` that marks the function as being called. More...

void	executeCheck () const
	Wrapper function for `check()` that marks the function as being called. More...

void	executeSetupMesh ()
	Wrapper function for `setupMesh()` that marks the function as being called. More...

virtual void	addRelationshipManagers (Moose::RelationshipManagerType)
	Adds relationship managers for the component. More...

template<typename T >
const T &	getComponent (const std::string &name) const
	Return a reference to a component via a parameter name. More...

template<typename T >
const T &	getComponentByName (const std::string &cname) const
	Return a reference to a component given its name. More...

template<typename T >
bool	hasComponent (const std::string &name) const
	Check the existence and type of a component via a parameter name. More...

template<typename T >
bool	hasComponentByName (const std::string &cname) const
	Check the existence and type of a component given its name. More...

void	connectObject (const InputParameters &params, const std::string &mooseName, const std::string &name) const
	Connect with control logic. More...

void	connectObject (const InputParameters &params, const std::string &mooseName, const std::string &name, const std::string &par_name) const
	Connect with control logic. More...

void	makeFunctionControllableIfConstant (const FunctionName &fn_name, const std::string &control_name, const std::string &param="value") const
	Makes a function controllable if it is constant. More...

void	checkSetupStatus (const EComponentSetupStatus &status) const
	Throws an error if the supplied setup status of this component has not been reached. More...

void	checkComponentExistsByName (const std::string &comp_name) const
	Checks that a component exists. More...

template<typename T >
void	checkComponentOfTypeExists (const std::string &param) const
	Checks that the component of a certain type exists, where the name is given by a parameter. More...

template<typename T >
void	checkComponentOfTypeExistsByName (const std::string &comp_name) const
	Checks that the component of a certain type exists. More...

template<typename... Args>
void	logError (Args &&... args) const
	Logs an error. More...

template<typename... Args>
void	logWarning (Args &&... args) const
	Logs a warning. More...

void	addDependency (const std::string &dependency)
	Adds a component name to the list of dependencies. More...

template<typename T >
T	getEnumParam (const std::string &param) const
	Gets an enum parameter. More...

bool	problemIsTransient () const
	Whether the problem is transient. More...

const std::vector< dof_id_type > &	getElementIDs () const
	Gets the element IDs corresponding to this component. More...

virtual const std::vector< SubdomainName > &	getSubdomainNames () const
	Gets the subdomain names for this component. More...

virtual const std::vector< Moose::CoordinateSystemType > &	getCoordSysTypes () const
	Gets the coordinate system types for this component. More...

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) 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

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

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

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

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

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

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

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

void	mooseInfo (Args &&... args) 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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

template<typename... Args>
void	logComponentError (const std::string &component_name, Args &&... args) const
	Logs an error for a component. More...

template<typename... Args>
void	logComponentWarning (const std::string &component_name, Args &&... args) const
	Logs a warning for a component. More...

std::string	genName (const std::string &prefix, unsigned int id, const std::string &suffix="") const
	Build a name from a prefix, number and possible suffix. More...

std::string	genName (const std::string &prefix, unsigned int i, unsigned int j, const std::string &suffix="") const
	Build a name from a prefix, 2 numbers and possible suffix. More...

std::string	genName (const std::string &prefix, const std::string &name, unsigned int i) const
	Build a name from 2 strings and a number. More...

std::string	genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings. More...

std::string	genSafeName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings that is safe to use in input files (i.e. More...

virtual void	checkShaftConnection (const Component *const component) const

virtual VariableName	getMomentofInertiaVariableName () const

virtual VariableName	getTorqueVariableName () const

virtual void	setShaftName (const std::string &name) const

Static Public Member Functions
static InputParameters	validParams ()

static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const unsigned int	N_EQ = 5
	Number of equations for the junction. More...

static const std::map< std::string, EEndType >	_end_type_to_enum {{"IN", IN}, {"OUT", OUT}}
	Map of end type string to enum. More...

Protected Member Functions
virtual void	check () const override
	Check the component integrity. More...

virtual void	buildVolumeJunctionUserObject () override
	Builds user object for computing and storing the fluxes. More...

virtual void	setupMesh () override
	Performs mesh setup such as creating mesh or naming mesh sets. More...

std::string	junctionVariableName (const std::string &var_base) const
	Returns the name of junction variable, depending on whether scalar. More...

void	addJunctionVariable (bool is_nonlinear, const VariableName &var, Real scaling_factor=1.0)
	Adds a junction variable to the problem, as a scalar or field variable. More...

void	addJunctionIC (const VariableName &var, Real value)
	Adds a junction IC to the problem, as a scalar or field variable. More...

void	addVolumeJunctionIC (const VariableName &var, const std::string &quantity)
	Adds a VolumeJunctionIC to the problem. More...

virtual void	init () override
	Initializes the component. More...

virtual void	initSecondary () override
	Perform secondary initialization, which relies on init() being called for all components. More...

const std::vector< dof_id_type > &	getConnectedElementIDs ()
	Gets the element IDs of the connected 1D components. More...

const std::vector< processor_id_type > &	getConnectedProcessorIDs ()
	Gets the processor IDs of the connected 1D components. More...

void	addConnection (const BoundaryName &boundary_name)
	Adds a connection for this component. More...

void	checkNumberOfConnections (const unsigned int &n_connections) const
	Checks that the number of connections is equal to the supplied value. More...

template<typename T >
void	checkSizeEqualsNumberOfConnections (const std::string &param) const
	Checks that the size of a vector parameter equals the number of connections. More...

template<typename T >
void	checkAllConnectionsHaveSame (const std::vector< T > &objects, const std::string &description) const
	Checks that all connections have the same of a certain type of object. More...

void	addRelationshipManagersFromParameters (const InputParameters &moose_object_pars)
	Method to add a relationship manager for the objects being added to the system. More...

Node *	addNode (const Point &pt)

Elem *	addNodeElement (dof_id_type node)

virtual void	setSubdomainInfo (SubdomainID subdomain_id, const std::string &subdomain_name, const Moose::CoordinateSystemType &coord_system=Moose::COORD_XYZ)
	Sets the next subdomain ID, name, and coordinate system. More...

template<typename T >
void	insistParameterExists (const std::string &function_name, const std::string &param_name) const
	Runtime check to make sure that a parameter of specified type exists in the component's input parameters. More...

template<typename T >
void	checkParameterValueLessThan (const std::string &param, const T &value_max) const
	Checks that a parameter value is less than a value. More...

template<typename T >
void	checkSizeLessThan (const std::string &param, const unsigned int &n_entries) const
	Checks that the size of a vector parameter is less than a value. More...

template<typename T >
void	checkSizeGreaterThan (const std::string &param, const unsigned int &n_entries) const
	Checks that the size of a vector parameter is greater than a value. More...

template<typename T1 , typename T2 >
void	checkEqualSize (const std::string &param1, const std::string &param2) const
	Checks that the size of two vector parameters are equal. More...

template<typename T >
void	checkSizeEqualsValue (const std::string &param, const unsigned int &n_entries) const
	Checks that the size of a vector parameter equals a value. More...

template<typename T >
void	checkSizeEqualsValue (const std::string &param, const unsigned int &n_entries, const std::string &description) const
	Checks that the size of a vector parameter equals a value. More...

template<typename T1 , typename T2 >
void	checkSizeEqualsParameterValue (const std::string &param1, const std::string &param2) const
	Checks that the size of a vector parameter equals the value of another parameter. More...

void	checkMutuallyExclusiveParameters (const std::vector< std::string > &params, bool need_one_specified=true) const
	Checks that exactly one parameter out of a list is provided. More...

template<typename T >
void	passParameter (const std::string &name, const std::string &new_name, InputParameters &params) const
	Passes a parameter from this object's input parameters to another set of input parameters. More...

template<typename T >
void	passParameter (const std::string &name, InputParameters &params) const
	Passes a parameter from this object's input parameters to another set of input parameters. More...

std::string	deduceFunctorName (const std::string &name) const

const Moose::Functor< T > &	getFunctor (const std::string &name)

const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)

const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)

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

bool	isFunctor (const std::string &name, const SubProblem &subproblem) const

Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const

void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)

Protected Attributes
const BoundaryName &	_inlet
	Compressor inlet. More...

const BoundaryName &	_outlet
	Compressor outlet. More...

const Real &	_omega_rated
	Rated compressor speed. More...

const Real &	_mdot_rated
	Rated compressor mass flow rate. More...

const Real &	_rho0_rated
	Rated compressor inlet stagnation fluid density. More...

const Real &	_c0_rated
	Rated compressor inlet stagnation sound speed. More...

const Real &	_speed_cr_fr
	Compressor speed threshold for friction. More...

const Real &	_tau_fr_const
	Compressor friction constant. More...

const std::vector< Real > &	_tau_fr_coeff
	Compressor friction coefficients. More...

const Real &	_speed_cr_I
	Compressor speed threshold for inertia. More...

const Real &	_inertia_const
	Compressor inertia constant. More...

const std::vector< Real > &	_inertia_coeff
	Compressor inertia coefficients. More...

const std::vector< Real > &	_speeds
	Compressor speeds which correspond to Rp and eff function order. More...

const std::vector< FunctionName > &	_Rp_functions
	Names of the pressure ratio functions. More...

const std::vector< FunctionName > &	_eff_functions
	Names of the adiabatic efficiency functions. More...

const VariableName	_delta_p_var_name
	Name of compressor delta_p variable. More...

const VariableName	_isentropic_torque_var_name
	Name of compressor isentropic torque variable. More...

const VariableName	_dissipation_torque_var_name
	Name of compressor dissipation torque variable. More...

const VariableName	_friction_torque_var_name
	Name of compressor friction torque variable. More...

const VariableName	_moi_var_name
	Name of compressor inertia variable. More...

const Real	_volume
	Volume of the junction. More...

const Point &	_position
	Spatial position of center of the junction. More...

const Real &	_scaling_factor_rhoV
	Scaling factor for rho*V. More...

const Real &	_scaling_factor_rhouV
	Scaling factor for rhouV. More...

const Real &	_scaling_factor_rhovV
	Scaling factor for rhovV. More...

const Real &	_scaling_factor_rhowV
	Scaling factor for rhowV. More...

const Real &	_scaling_factor_rhoEV
	Scaling factor for rhoEV. More...

const VariableName	_rhoV_var_name
	rho*V variable name for junction More...

const VariableName	_rhouV_var_name
	rhouV variable name for junction More...

const VariableName	_rhovV_var_name
	rhovV variable name for junction More...

const VariableName	_rhowV_var_name
	rhowV variable name for junction More...

const VariableName	_rhoEV_var_name
	rhoEV variable name for junction More...

const VariableName	_pressure_var_name
	pressure variable name for junction More...

const VariableName	_temperature_var_name
	temperature variable name for junction More...

const VariableName	_velocity_var_name
	velocity variable name for junction More...

const Real &	_K
	Form loss coefficient. More...

const Real &	_A_ref
	Reference area. More...

std::vector< UserObjectName >	_numerical_flux_names

THM::FlowModelID	_flow_model_id
	Flow model ID. More...

std::shared_ptr< const FlowModel >	_flow_model
	Flow model. More...

UserObjectName	_fp_name
	Fluid property user object name. More...

const std::string	_junction_uo_name
	Name of junction user object name, if any. More...

std::vector< dof_id_type >	_connected_elems
	Element IDs of connected 1D components. More...

std::vector< processor_id_type >	_proc_ids
	Processor IDs of connected 1D components. More...

subdomain_id_type	_junction_subdomain_id
	Junction subdomain ID. More...

std::vector< Point >	_positions
	Physical positions of connected components. More...

std::vector< const Elem * >	_elems
	Boundary elements of connected components. More...

std::vector< unsigned short int >	_sides
	Boundary sides of connected components. More...

std::vector< dof_id_type >	_nodes
	Boundary node IDs from connected components. More...

std::vector< unsigned int >	_boundary_ids
	Boundary IDs of connected components. More...

std::vector< BoundaryName >	_boundary_names
	Boundary names of connected components. More...

std::vector< Real >	_normals
	Outward normals associated with connected components. More...

std::vector< RealVectorValue >	_directions
	Directions of connected components. More...

std::vector< Connection >	_connections
	Vector of connections of this component. More...

std::vector< std::string >	_connected_component_names
	Vector of connected component names. More...

std::vector< SubdomainName >	_connected_subdomain_names
	Vector of subdomain names of the connected components. More...

Component *	_parent
	Pointer to a parent component (used in composed components) More...

THMProblem &	_sim
	THM problem this component is part of TODO: make _sim private (applications need to switch to getters to avoid breaking). More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

const Real &	_zero

THMMesh &	_mesh
	The THM mesh TODO: make _mesh private (applications need to switch to getters to avoid breaking) More...

std::vector< dof_id_type >	_node_ids
	Node IDs of this component. More...

std::vector< dof_id_type >	_elem_ids
	Element IDs of this component. More...

std::vector< SubdomainID >	_subdomain_ids
	List of subdomain IDs this components owns. More...

std::vector< SubdomainName >	_subdomain_names
	List of subdomain names this components owns. More...

std::vector< Moose::CoordinateSystemType >	_coord_sys
	List of coordinate system for each subdomain. More...

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Logger &	_log

VariableName	_moment_of_inertia_var_name
	Moment of inertia variable name. More...

VariableName	_torque_var_name
	Torque of variable name. More...

UserObjectName	_user_object_name
	Shaft-connectable user object name. More...

std::string	_shaft_name
	Name of the shaft component. More...

bool	_connected_to_shaft
	Flag indicating that a shaft has this component connected. More...

Detailed Description

1-phase compressor that must be connected to a Shaft component

Definition at line 18 of file ShaftConnectedCompressor1Phase.h.

Member Enumeration Documentation

◆ EComponentSetupStatus

enum Component::EComponentSetupStatus

inherited

Component setup status type.

Enumerator
CREATED	only created
MESH_PREPARED	mesh set up
INITIALIZED_PRIMARY	mesh set up, called primary init
INITIALIZED_SECONDARY	mesh set up, called both inits
CHECKED	mesh set up, called both inits, checked

Definition at line 36 of file Component.h.

   {
     CREATED,               
     MESH_PREPARED,         
     INITIALIZED_PRIMARY,   
     INITIALIZED_SECONDARY, 
     CHECKED                
   };

◆ EEndType

enum Component1DConnection::EEndType

inherited

End type.

Enumerator
IN	inlet
OUT	outlet

Definition at line 23 of file Component1DConnection.h.

   {
     IN, 
     OUT 
   };

◆ VolumeJunction1PhaseIndices

enum VolumeJunction1Phase::VolumeJunction1PhaseIndices

inherited

Enumeration for junction variable/equation indices.

Enumerator
RHOV_INDEX
RHOUV_INDEX
RHOVV_INDEX
RHOWV_INDEX
RHOEV_INDEX

Definition at line 26 of file VolumeJunction1Phase.h.

   {
     RHOV_INDEX = 0,
     RHOUV_INDEX = 1,
     RHOVV_INDEX = 2,
     RHOWV_INDEX = 3,
     RHOEV_INDEX = 4
   };

Constructor & Destructor Documentation

◆ ShaftConnectedCompressor1Phase()

ShaftConnectedCompressor1Phase::ShaftConnectedCompressor1Phase ( const InputParameters & params )

Definition at line 70 of file ShaftConnectedCompressor1Phase.C.

   : VolumeJunction1Phase(parameters),
     ShaftConnectable(this),
     _inlet(getParam<BoundaryName>("inlet")),
     _outlet(getParam<BoundaryName>("outlet")),
     _omega_rated(getParam<Real>("omega_rated")),
     _mdot_rated(getParam<Real>("mdot_rated")),
     _rho0_rated(getParam<Real>("rho0_rated")),
     _c0_rated(getParam<Real>("c0_rated")),
     _speed_cr_fr(getParam<Real>("speed_cr_fr")),
     _tau_fr_const(getParam<Real>("tau_fr_const")),
     _tau_fr_coeff(getParam<std::vector<Real>>("tau_fr_coeff")),
     _speed_cr_I(getParam<Real>("speed_cr_I")),
     _inertia_const(getParam<Real>("inertia_const")),
     _inertia_coeff(getParam<std::vector<Real>>("inertia_coeff")),
     _speeds(getParam<std::vector<Real>>("speeds")),
     _Rp_functions(getParam<std::vector<FunctionName>>("Rp_functions")),
     _eff_functions(getParam<std::vector<FunctionName>>("eff_functions")),
     _delta_p_var_name(junctionVariableName("delta_p")),
     _isentropic_torque_var_name(junctionVariableName("isentropic_torque")),
     _dissipation_torque_var_name(junctionVariableName("dissipation_torque")),
     _friction_torque_var_name(junctionVariableName("friction_torque")),
     _moi_var_name(junctionVariableName("moment_of_inertia"))
 {
   // this determines connection ordering
   addConnection(_inlet);
   addConnection(_outlet);
 
   checkSizeEqualsValue<Real>("tau_fr_coeff", 4);
   checkSizeEqualsValue<Real>("inertia_coeff", 4);
 }

Member Function Documentation

◆ addConnection()

void Component1DConnection::addConnection ( const BoundaryName & boundary_name )

protectedinherited

Adds a connection for this component.

Components using this interface must call this function on all of their connection strings.

Parameters

[in] boundary_name The name of the boundary

Definition at line 100 of file Component1DConnection.C.

Referenced by Component1DBoundary::Component1DBoundary(), Component1DJunction::Component1DJunction(), ShaftConnectedCompressor1Phase(), ShaftConnectedPump1Phase::ShaftConnectedPump1Phase(), and ShaftConnectedTurbine1Phase::ShaftConnectedTurbine1Phase().

 {
   const size_t oparenthesis_pos = boundary_name.find('(');
   if (oparenthesis_pos != std::string::npos)
   {
     logError("You are using the old connection format 'comp_name(end)'. Please update your input "
              "file to the new one 'comp_name:end'.");
   }
   else
   {
     const size_t colon_pos = boundary_name.rfind(':');
     // if it has a colon, assume 'component_name:end_type' format
     if (colon_pos != std::string::npos)
     {
       const std::string connected_component_name = boundary_name.substr(0, colon_pos);
       const std::string str_end =
           boundary_name.substr(colon_pos + 1, boundary_name.length() - colon_pos - 1);
       const EEndType end_type = THM::stringToEnum<EEndType>(str_end);
 
       _connections.push_back(Connection(boundary_name, connected_component_name, end_type));
       _connected_component_names.push_back(connected_component_name);
 
       // Add dependency because the connected component's setupMesh() must be called
       // before this component's setupMesh().
       addDependency(connected_component_name);
     }
     else
     {
       logError("Incorrect connection specified '",
                boundary_name,
                "'. Valid connection format is 'component_name:end_type'.");
     }
   }
 }

◆ addDependency()

void Component::addDependency ( const std::string & dependency )

inherited

Adds a component name to the list of dependencies.

Parameters

[in] dependency name of component to add to list of dependencies

Definition at line 129 of file Component.C.

Referenced by Component1DConnection::addConnection(), HeatTransferBase::HeatTransferBase(), HeatTransferFromHeatStructure3D1Phase::HeatTransferFromHeatStructure3D1Phase(), HSCoupler2D2DRadiation::HSCoupler2D2DRadiation(), HSCoupler2D3D::HSCoupler2D3D(), and Shaft::Shaft().

 {
   _dependencies.push_back(dependency);
 }

◆ addJunctionIC()

void VolumeJunction1Phase::addJunctionIC	(	const VariableName &	var,
		Real	value
	)

protectedinherited

Adds a junction IC to the problem, as a scalar or field variable.

Parameters

[in]	var	Variable name
[in]	value	IC value

Definition at line 319 of file VolumeJunction1Phase.C.

Referenced by addVariables(), ShaftConnectedTurbine1Phase::addVariables(), and ShaftConnectedPump1Phase::addVariables().

 {
   getTHMProblem().addConstantIC(var, value, getSubdomainNames());
 }

◆ addJunctionVariable()

void VolumeJunction1Phase::addJunctionVariable	(	bool	is_nonlinear,
		const VariableName &	var,
		Real	scaling_factor = `1.0`
	)

protectedinherited

Adds a junction variable to the problem, as a scalar or field variable.

Parameters

[in]	is_nonlinear	Is the variable nonlinear?
[in]	var	Variable name
[in]	scaling_factor	Scaling factor for variable if nonlinear

Definition at line 303 of file VolumeJunction1Phase.C.

Referenced by VolumeJunction1Phase::addVariables(), ShaftConnectedPump1Phase::addVariables(), addVariables(), ShaftConnectedTurbine1Phase::addVariables(), and SimpleTurbine1Phase::addVariables().

 {
   auto & problem = getTHMProblem();
 
   const libMesh::FEType fe_type(CONSTANT, MONOMIAL);
   const auto & subdomains = getSubdomainNames();
 
   if (is_nonlinear)
     problem.addSimVariable(is_nonlinear, var, fe_type, subdomains, scaling_factor);
   else
     problem.addSimVariable(is_nonlinear, var, fe_type, subdomains);
 }

◆ addMooseObjects()

void ShaftConnectedCompressor1Phase::addMooseObjects ( )

overridevirtual

Reimplemented from VolumeJunction1Phase.

Definition at line 190 of file ShaftConnectedCompressor1Phase.C.

 {
   VolumeJunction1Phase::addMooseObjects();
 
   const std::vector<std::pair<std::string, VariableName>> quantities_aux = {
       {"delta_p", _delta_p_var_name},
       {"isentropic_torque", _isentropic_torque_var_name},
       {"dissipation_torque", _dissipation_torque_var_name},
       {"friction_torque", _friction_torque_var_name},
       {"moment_of_inertia", _moment_of_inertia_var_name}};
   for (const auto & quantity_and_name : quantities_aux)
   {
     const std::string class_name = "ShaftConnectedCompressor1PhaseAux";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<AuxVariableName>("variable") = quantity_and_name.second;
     params.set<MooseEnum>("quantity") = quantity_and_name.first;
     params.set<UserObjectName>("compressor_uo") = getShaftConnectedUserObjectName();
     const std::string obj_name = genName(name(), quantity_and_name.first + "_aux");
     params.set<std::vector<SubdomainName>>("block") = getSubdomainNames();
     getTHMProblem().addAuxKernel(class_name, obj_name, params);
   }
 
   const std::vector<std::string> quantities_pp = {
       "pressure_ratio", "efficiency", "rel_corrected_flow", "rel_corrected_speed"};
   for (const auto & quantity : quantities_pp)
   {
     const std::string class_name = "ShaftConnectedCompressor1PhasePostprocessor";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<MooseEnum>("quantity") = quantity;
     params.set<UserObjectName>("compressor_uo") = getShaftConnectedUserObjectName();
     params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_TIMESTEP_END};
     getTHMProblem().addPostprocessor(class_name, Component::genName(name(), quantity), params);
   }
 }

◆ addNode()

Node * Component::addNode ( const Point & pt )

protectedinherited

Definition at line 213 of file Component.C.

Referenced by Component2D::build2DMesh(), Component2D::build2DMesh2ndOrder(), FileMeshComponent::buildMesh(), ElbowPipe1Phase::buildMeshNodes(), Component1D::buildMeshNodes(), and VolumeJunction1Phase::setupMesh().

 {
   auto node = mesh().addNode(pt);
   _node_ids.push_back(node->id());
   return node;
 }

◆ addNodeElement()

Elem * Component::addNodeElement ( dof_id_type node )

protectedinherited

Definition at line 221 of file Component.C.

Referenced by VolumeJunction1Phase::setupMesh().

 {
   auto elem = mesh().addNodeElement(node);
   _elem_ids.push_back(elem->id());
   return elem;
 }

◆ addRelationshipManagers()

virtual void Component::addRelationshipManagers ( Moose::RelationshipManagerType )

inlinevirtualinherited

Adds relationship managers for the component.

Reimplemented in FileMeshPhysicsComponent.

Definition at line 110 of file Component.h.

110 {}

◆ addRelationshipManagersFromParameters()

void Component::addRelationshipManagersFromParameters ( const InputParameters & moose_object_pars )

protectedinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

This method was copied from Action.

Parameters

moose_object_pars The MooseObject to inspect for RelationshipManagers to add

Definition at line 158 of file Component.C.

Referenced by FileMeshPhysicsComponent::addRelationshipManagers().

 {
   const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();
 
   for (const auto & buildable_type : buildable_types)
   {
     auto & rm_name = std::get<0>(buildable_type);
     auto & rm_type = std::get<1>(buildable_type);
     auto rm_input_parameter_func = std::get<2>(buildable_type);
 
     addRelationshipManager(moose_object_pars, rm_name, rm_type, rm_input_parameter_func);
   }
 }

◆ addVariables()

void ShaftConnectedCompressor1Phase::addVariables ( )

overridevirtual

Reimplemented from VolumeJunction1Phase.

Definition at line 169 of file ShaftConnectedCompressor1Phase.C.

 {
   VolumeJunction1Phase::addVariables();
 
   addJunctionVariable(false, _delta_p_var_name);
   addJunctionVariable(false, _isentropic_torque_var_name);
   addJunctionVariable(false, _dissipation_torque_var_name);
   addJunctionVariable(false, _friction_torque_var_name);
   addJunctionVariable(false, _moment_of_inertia_var_name);
 
   if (!_app.isRestarting())
   {
     addJunctionIC(_delta_p_var_name, 0);
     addJunctionIC(_isentropic_torque_var_name, 0);
     addJunctionIC(_dissipation_torque_var_name, 0);
     addJunctionIC(_friction_torque_var_name, 0);
     addJunctionIC(_moment_of_inertia_var_name, _inertia_const);
   }
 }

◆ addVolumeJunctionIC()

void VolumeJunction1Phase::addVolumeJunctionIC	(	const VariableName &	var,
		const std::string &	quantity
	)

protectedinherited

Adds a VolumeJunctionIC to the problem.

Parameters

[in]	var	Variable name
[in]	quantity	Quantity to compute

Definition at line 325 of file VolumeJunction1Phase.C.

Referenced by VolumeJunction1Phase::addVariables().

 {
   const std::string class_name = "VolumeJunction1PhaseIC";
   InputParameters params = _factory.getValidParams(class_name);
   params.set<std::vector<SubdomainName>>("block") = getSubdomainNames();
   params.set<VariableName>("variable") = var;
   params.set<MooseEnum>("quantity") = quantity;
   params.applySpecificParameters(parameters(),
                                  {"initial_p",
                                   "initial_T",
                                   "initial_vel_x",
                                   "initial_vel_y",
                                   "initial_vel_z",
                                   "volume",
                                   "position"});
   params.set<UserObjectName>("fluid_properties") = _fp_name;
   getTHMProblem().addSimInitialCondition(class_name, genName(name(), var, "ic"), params);
 }

◆ buildVolumeJunctionUserObject()

void ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject ( )

overrideprotectedvirtual

Builds user object for computing and storing the fluxes.

Reimplemented from VolumeJunction1Phase.

Definition at line 110 of file ShaftConnectedCompressor1Phase.C.

 {
   const Component & c = getComponentByName<Component>(_shaft_name);
   const Shaft & scc = dynamic_cast<const Shaft &>(c);
   const VariableName omega_var_name = scc.getOmegaVariableName();
 
   ExecFlagEnum execute_on(MooseUtils::getDefaultExecFlagEnum());
   execute_on = {EXEC_INITIAL, EXEC_LINEAR, EXEC_NONLINEAR};
 
   {
     const std::string class_name = "ADShaftConnectedCompressor1PhaseUserObject";
     InputParameters params = _factory.getValidParams(class_name);
     params.set<bool>("use_scalar_variables") = false;
     params.set<subdomain_id_type>("junction_subdomain_id") = _junction_subdomain_id;
     params.set<std::vector<BoundaryName>>("boundary") = _boundary_names;
     params.set<std::vector<Real>>("normals") = _normals;
     params.set<std::vector<processor_id_type>>("processor_ids") = getConnectedProcessorIDs();
     params.set<std::vector<UserObjectName>>("numerical_flux_names") = _numerical_flux_names;
     params.set<Real>("volume") = _volume;
     params.set<std::vector<VariableName>>("A") = {FlowModel::AREA};
     params.set<std::vector<VariableName>>("rhoA") = {FlowModelSinglePhase::RHOA};
     params.set<std::vector<VariableName>>("rhouA") = {FlowModelSinglePhase::RHOUA};
     params.set<std::vector<VariableName>>("rhoEA") = {FlowModelSinglePhase::RHOEA};
     params.set<std::vector<VariableName>>("rhoV") = {_rhoV_var_name};
     params.set<std::vector<VariableName>>("rhouV") = {_rhouV_var_name};
     params.set<std::vector<VariableName>>("rhovV") = {_rhovV_var_name};
     params.set<std::vector<VariableName>>("rhowV") = {_rhowV_var_name};
     params.set<std::vector<VariableName>>("rhoEV") = {_rhoEV_var_name};
     // the direction of the outlet channel
     params.set<Point>("di_out") = _directions[1].unit();
     params.set<Real>("omega_rated") = _omega_rated;
     params.set<bool>("treat_as_turbine") = getParam<bool>("treat_as_turbine");
     params.set<Real>("mdot_rated") = _mdot_rated;
     params.set<Real>("rho0_rated") = _rho0_rated;
     params.set<Real>("c0_rated") = _c0_rated;
     params.set<Real>("speed_cr_fr") = _speed_cr_fr;
     params.set<Real>("tau_fr_const") = _tau_fr_const;
     params.set<std::vector<Real>>("tau_fr_coeff") = _tau_fr_coeff;
     params.set<Real>("speed_cr_I") = _speed_cr_I;
     params.set<Real>("inertia_const") = _inertia_const;
     params.set<std::vector<Real>>("inertia_coeff") = _inertia_coeff;
     params.set<std::vector<Real>>("speeds") = _speeds;
     params.set<std::vector<FunctionName>>("Rp_functions") = _Rp_functions;
     params.set<std::vector<FunctionName>>("eff_functions") = _eff_functions;
     params.set<Real>("min_pressure_ratio") = getParam<Real>("min_pressure_ratio");
     params.set<Real>("max_pressure_ratio") = getParam<Real>("max_pressure_ratio");
     params.set<std::vector<VariableName>>("omega") = {omega_var_name};
     params.set<Real>("A_ref") = getParam<Real>("A_ref");
     params.set<Real>("K") = getParam<Real>("K");
     params.set<UserObjectName>("fp") = _fp_name;
     params.set<std::string>("compressor_name") = cname();
     params.set<bool>("apply_velocity_scaling") = getParam<bool>("apply_velocity_scaling");
     params.set<ExecFlagEnum>("execute_on") = execute_on;
     getTHMProblem().addUserObject(class_name, getShaftConnectedUserObjectName(), params);
     connectObject(params, _junction_uo_name, "K");
   }
 }

◆ check()

void ShaftConnectedCompressor1Phase::check ( ) const

overrideprotectedvirtual

Check the component integrity.

Reimplemented from VolumeJunction1Phase.

Definition at line 103 of file ShaftConnectedCompressor1Phase.C.

 {
   VolumeJunction1Phase::check();
   checkShaftConnection(this);
 }

◆ checkAllConnectionsHaveSame()

template<typename T >

void Component1DConnection::checkAllConnectionsHaveSame	(	const std::vector< T > &	objects,
		const std::string &	description
	)		const

protectedinherited

Checks that all connections have the same of a certain type of object.

Template Parameters

T	type of object to check

Parameters

[in]	objects	list of objects corresponding to each connection
[in]	description	description of the obect to check

Definition at line 177 of file Component1DConnection.h.

 {
   for (const auto & obj : objects)
     if (obj != objects[0])
       logError("All connections must have the same ", description);
 }

◆ checkComponentExistsByName()

void Component::checkComponentExistsByName ( const std::string & comp_name ) const

inherited

Checks that a component exists.

Parameters

[in] comp_name name of the component

Definition at line 151 of file Component.C.

 {
   if (!_sim.hasComponent(comp_name))
     logError("The component '", comp_name, "' does not exist");
 }

◆ checkComponentOfTypeExists()

template<typename T >

void Component::checkComponentOfTypeExists ( const std::string & param ) const

inherited

Checks that the component of a certain type exists, where the name is given by a parameter.

Template Parameters

T	enforced type of component

Parameters

[in] param parameter name for component name

Definition at line 585 of file Component.h.

 {
   insistParameterExists<std::string>(__FUNCTION__, param);
 
   const std::string & comp_name = getParam<std::string>(param);
   checkComponentOfTypeExistsByName<T>(comp_name);
 }

◆ checkComponentOfTypeExistsByName()

template<typename T >

void Component::checkComponentOfTypeExistsByName ( const std::string & comp_name ) const

inherited

Checks that the component of a certain type exists.

Template Parameters

T	enforced type of component

Parameters

[in] comp_name component name

Definition at line 595 of file Component.h.

 {
   if (!_sim.hasComponentOfType<T>(comp_name))
   {
     if (_sim.hasComponent(comp_name))
       logError("The component '", comp_name, "' is not of type '", demangle(typeid(T).name()), "'");
     else
       logError("The component '", comp_name, "' does not exist");
   }
 }

◆ checkEqualSize()

template<typename T1 , typename T2 >

void Component::checkEqualSize	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Checks that the size of two vector parameters are equal.

Template Parameters

T1	type of element in the first vector parameter
T2	type of element in the second vector parameter

Parameters

[in]	param1	first parameter name
[in]	param2	second parameter name

Definition at line 651 of file Component.h.

 {
   insistParameterExists<std::vector<T1>>(__FUNCTION__, param1);
   insistParameterExists<std::vector<T2>>(__FUNCTION__, param2);
 
   const auto & value1 = getParam<std::vector<T1>>(param1);
   const auto & value2 = getParam<std::vector<T2>>(param2);
   if (value1.size() != value2.size())
     logError("The number of entries in parameter '",
              param1,
              "' (",
              value1.size(),
              ") must equal the number of entries of parameter '",
              param2,
              "' (",
              value2.size(),
              ")");
 }

◆ checkMutuallyExclusiveParameters()

void Component::checkMutuallyExclusiveParameters	(	const std::vector< std::string > &	params,
		bool	need_one_specified = `true`
	)		const

protectedinherited

Checks that exactly one parameter out of a list is provided.

Parameters

[in]	params	vector of parameter names
[in]	need_one_specified	Need one of the parameters specified?

Definition at line 246 of file Component.C.

Referenced by HeatStructureCylindrical::check(), and HeatStructurePlate::check().

 {
   unsigned int n_provided_params = 0;
   for (const auto & param : params)
     if (isParamValid(param))
       n_provided_params++;
 
   if (n_provided_params != 1)
   {
     std::string params_list_string = "{'" + params[0] + "'";
     for (unsigned int i = 1; i < params.size(); ++i)
       params_list_string += ", '" + params[i] + "'";
     params_list_string += "}";
 
     if (n_provided_params == 0 && need_one_specified)
       logError("One of the parameters ", params_list_string, " must be provided");
 
     if (n_provided_params != 0)
       logError("Only one of the parameters ", params_list_string, " can be provided");
   }
 }

◆ checkNumberOfConnections()

void Component1DConnection::checkNumberOfConnections ( const unsigned int & n_connections ) const

protectedinherited

Checks that the number of connections is equal to the supplied value.

Parameters

[in] n_connections enforced number of connections

Definition at line 136 of file Component1DConnection.C.

Referenced by GateValve1Phase::check(), Component1DBoundary::check(), and JunctionOneToOne1Phase::check().

 {
   if (_connections.size() != n_connections)
     logError("The number of connections (", _connections.size(), ") must equal ", n_connections);
 }

◆ checkParameterValueLessThan()

template<typename T >

void Component::checkParameterValueLessThan	(	const std::string &	param,
		const T &	value_max
	)		const

protectedinherited

Checks that a parameter value is less than a value.

Template Parameters

T	type of parameter

Parameters

[in]	param	parameter name
[in]	value_max	value which parameter value must be less than

Definition at line 608 of file Component.h.

 {
   insistParameterExists<T>(__FUNCTION__, param);
 
   const auto & value = getParam<T>(param);
   if (value >= value_max)
     logError("The value of parameter '", param, "' (", value, ") must be less than ", value_max);
 }

◆ checkSetupStatus()

void Component::checkSetupStatus ( const EComponentSetupStatus & status ) const

inherited

Throws an error if the supplied setup status of this component has not been reached.

This is useful for getter functions that rely on data initialized after the constructor; if an error is not thrown, then uninitialized data could be returned from these functions.

Parameters

[in] status Setup status that this component must have reached

Definition at line 117 of file Component.C.

Referenced by FlowChannelBase::getAreaFunctionName(), Component2D::getBoundaryArea(), FileMeshComponent::getBoundaryInfo(), Component2D::getBoundaryInfo(), Component1DConnection::getBoundaryNames(), Component1D::getConnections(), Component::getCoordSysTypes(), Component::getElementIDs(), Component2D::getExternalBoundaryName(), Component2D::getExternalBoundaryType(), FlowChannelBase::getFlowModel(), FlowBoundary::getFluidPropertiesName(), FlowJunction::getFluidPropertiesName(), HeatTransferBase::getFluidPropertiesName(), HeatTransferBase::getHeatedPerimeterName(), FlowChannelBase::getHeatTransferNames(), FlowChannelBase::getHeatTransferNamesSuffix(), Component1DConnection::getNodeIDs(), Component::getNodeIDs(), Component1D::getNodesetID(), Component1D::getNodesetName(), Component::getSubdomainNames(), HeatTransfer1PhaseBase::getWallHeatTransferCoefficient1PhaseName(), HeatTransferBase::getWallTemperatureMatName(), HeatTransferBase::getWallTemperatureName(), FileMeshComponent::hasBoundary(), Component2D::hasBoundary(), Component2D::hasExternalBoundary(), and HeatStructureFromFile3D::hasRegion().

 {
   if (_component_setup_status < status)
     mooseError(name(),
                ": The component setup status (",
                stringify(_component_setup_status),
                ") is less than the required status (",
                stringify(status),
                ")");
 }

◆ checkShaftConnection()

void ShaftConnectable::checkShaftConnection ( const Component *const component ) const

virtualinherited

Definition at line 29 of file ShaftConnectable.C.

Referenced by ShaftConnectedMotor::check(), check(), ShaftConnectedPump1Phase::check(), and ShaftConnectedTurbine1Phase::check().

 {
   if (!_connected_to_shaft)
     component->logError("This component must be connected to a shaft.");
 }

◆ checkSizeEqualsNumberOfConnections()

template<typename T >

void Component1DConnection::checkSizeEqualsNumberOfConnections ( const std::string & param ) const

protectedinherited

Checks that the size of a vector parameter equals the number of connections.

Template Parameters

T	type of element in the vector parameter

Parameters

[in] param vector parameter name

Definition at line 162 of file Component1DConnection.h.

 {
   const auto & value = getParam<std::vector<T>>(param);
   if (value.size() != _connections.size())
     logError("The number of entries in '",
              param,
              "' (",
              value.size(),
              ") must equal the number of connections (",
              _connections.size(),
              ")");
 }

◆ checkSizeEqualsParameterValue()

template<typename T1 , typename T2 >

void Component::checkSizeEqualsParameterValue	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Checks that the size of a vector parameter equals the value of another parameter.

Template Parameters

T1	type of element in the vector parameter
T2	type of the parameter whose value is compared to size

Parameters

[in]	param1	vector parameter name
[in]	param2	name of parameter whose value is compared to size

Definition at line 709 of file Component.h.

 {
   insistParameterExists<std::vector<T1>>(__FUNCTION__, param1);
   insistParameterExists<T2>(__FUNCTION__, param2);
 
   const auto & value1 = getParam<std::vector<T1>>(param1);
   const auto & value2 = getParam<T2>(param2);
   if (value1.size() != value2)
     logError("The number of entries in parameter '",
              param1,
              "' (",
              value1.size(),
              ") must be equal to the value of parameter '",
              param2,
              "' (",
              value2,
              ")");
 }

◆ checkSizeEqualsValue() [1/2]

template<typename T >

void Component::checkSizeEqualsValue	(	const std::string &	param,
		const unsigned int &	n_entries
	)		const

protectedinherited

Checks that the size of a vector parameter equals a value.

This version does not supply a description to the value.

Template Parameters

T	type of element in the vector parameter

Parameters

[in]	param	parameter name
[in]	n_entries	value which parameter size must be equal to

Definition at line 672 of file Component.h.

 {
   insistParameterExists<std::vector<T>>(__FUNCTION__, param);
 
   const auto & param_value = getParam<std::vector<T>>(param);
   if (param_value.size() != n_entries)
     logError("The number of entries in parameter '",
              param,
              "' (",
              param_value.size(),
              ") must be equal to ",
              n_entries);
 }

◆ checkSizeEqualsValue() [2/2]

template<typename T >

void Component::checkSizeEqualsValue	(	const std::string &	param,
		const unsigned int &	n_entries,
		const std::string &	description
	)		const

protectedinherited

Checks that the size of a vector parameter equals a value.

This version supplies a description to the value.

Template Parameters

T	type of element in the vector parameter

Parameters

[in]	param	parameter name
[in]	n_entries	value which parameter size must be equal to
[in]	description	description of the value that size must be equal to

Definition at line 688 of file Component.h.

 {
   insistParameterExists<std::vector<T>>(__FUNCTION__, param);
 
   const auto & param_value = getParam<std::vector<T>>(param);
   if (param_value.size() != n_entries)
     logError("The number of entries in parameter '",
              param,
              "' (",
              param_value.size(),
              ") must be equal to ",
              description,
              " (",
              n_entries,
              ")");
 }

◆ checkSizeGreaterThan()

template<typename T >

void Component::checkSizeGreaterThan	(	const std::string &	param,
		const unsigned int &	n_entries
	)		const

protectedinherited

Checks that the size of a vector parameter is greater than a value.

Template Parameters

T	type of element in the vector parameter

Parameters

[in]	param	parameter name
[in]	n_entries	value which parameter size must be greater than

Definition at line 635 of file Component.h.

 {
   insistParameterExists<std::vector<T>>(__FUNCTION__, param);
 
   const auto & value = getParam<std::vector<T>>(param);
   if (value.size() <= n_entries)
     logError("The number of entries in the parameter '",
              param,
              "' (",
              value.size(),
              ") must be greater than ",
              n_entries);
 }

◆ checkSizeLessThan()

template<typename T >

void Component::checkSizeLessThan	(	const std::string &	param,
		const unsigned int &	n_entries
	)		const

protectedinherited

Checks that the size of a vector parameter is less than a value.

Template Parameters

T	type of element in the vector parameter

Parameters

[in]	param	parameter name
[in]	n_entries	value which parameter size must be less than

Definition at line 619 of file Component.h.

 {
   insistParameterExists<std::vector<T>>(__FUNCTION__, param);
 
   const auto & value = getParam<std::vector<T>>(param);
   if (value.size() >= n_entries)
     logError("The number of entries in the parameter '",
              param,
              "' (",
              value.size(),
              ") must be less than ",
              n_entries);
 }

◆ cname()

const std::string & Component::cname ( ) const

inherited

Get the component name.

Returns: The name of the component. For composite component, return its parent name

Definition at line 51 of file Component.C.

Referenced by buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), Closures1PhaseSimple::checkFlowChannel(), Closures1PhaseSimple::checkHeatTransfer(), Component::cname(), Component::logError(), and Component::logWarning().

 {
   if (_parent)
     return _parent->cname();
   else
     return name();
 }

◆ connectObject() [1/2]

void Component::connectObject	(	const InputParameters &	params,
		const std::string &	mooseName,
		const std::string &	name
	)		const

inherited

Connect with control logic.

Definition at line 98 of file Component.C.

Referenced by HeatSourceFromTotalPower::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), TotalPower::addMooseObjects(), GateValve1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), Closures1PhaseTHM::addWallFFMaterial(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), GeometricalComponent::getVariableFn(), FlowModel::getVariableFn(), and Component::makeFunctionControllableIfConstant().

 {
   connectObject(params, mooseName, name, name);
 }

◆ connectObject() [2/2]

void Component::connectObject	(	const InputParameters &	params,
		const std::string &	mooseName,
		const std::string &	name,
		const std::string &	par_name
	)		const

inherited

Connect with control logic.

Definition at line 106 of file Component.C.

 {
   MooseObjectParameterName alias("component", this->name(), name, "::");
   MooseObjectParameterName par_value(params.get<std::string>("_moose_base"), mooseName, par_name);
   _app.getInputParameterWarehouse().addControllableParameterAlias(alias, par_value);
 }

◆ constMesh()

const THMMesh& Component::constMesh ( ) const

inlineinherited

Const reference to mesh, which can be called at any point.

Note that overloading mesh() was not possible due to the need to call this const version, even when the component is not const.

Definition at line 62 of file Component.h.

Referenced by FileMeshPhysicsComponent::getMesh(), and Component1DJunction::initSecondary().

62 { return _mesh; }

Component::_mesh

THMMesh & _mesh

The THM mesh TODO: make _mesh private (applications need to switch to getters to avoid breaking) ...

Definition: Component.h:452

◆ executeCheck()

void Component::executeCheck ( ) const

inherited

Wrapper function for check() that marks the function as being called.

Definition at line 84 of file Component.C.

 {
   check();
   _component_setup_status = CHECKED;
 }

◆ executeInit()

void Component::executeInit ( )

inherited

Wrapper function for init() that marks the function as being called.

Definition at line 70 of file Component.C.

 {
   init();
   _component_setup_status = INITIALIZED_PRIMARY;
 }

◆ executeInitSecondary()

void Component::executeInitSecondary ( )

inherited

Wrapper function for initSecondary() that marks the function as being called.

Definition at line 77 of file Component.C.

 {
   initSecondary();
   _component_setup_status = INITIALIZED_SECONDARY;
 }

◆ executeSetupMesh()

void Component::executeSetupMesh ( )

inherited

Wrapper function for setupMesh() that marks the function as being called.

Definition at line 91 of file Component.C.

 {
   setupMesh();
   _component_setup_status = MESH_PREPARED;
 }

◆ genName() [1/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		unsigned int	id,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from a prefix, number and possible suffix.

Definition at line 29 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << id;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genName() [2/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		unsigned int	i,
		unsigned int	j,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from a prefix, 2 numbers and possible suffix.

Definition at line 41 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << i << ":" << j;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genName() [3/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		const std::string &	name,
		unsigned int	i
	)		const

inlineinherited

Build a name from 2 strings and a number.

Definition at line 56 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << name << ":" << i;
     return ss.str();
   }

◆ genName() [4/4]

std::string NamingInterface::genName	(	const std::string &	prefix,
		const std::string &	middle,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from strings.

Definition at line 66 of file NamingInterface.h.

   {
     std::stringstream ss;
     ss << prefix << ":" << middle;
     if (!suffix.empty())
       ss << ":" << suffix;
     return ss.str();
   }

◆ genSafeName()

std::string NamingInterface::genSafeName	(	const std::string &	prefix,
		const std::string &	middle,
		const std::string &	suffix = `""`
	)		const

inlineinherited

Build a name from strings that is safe to use in input files (i.e.

can be exposed to users)

Definition at line 80 of file NamingInterface.h.

Referenced by HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), and HSBoundaryExternalAppHeatFlux::addMooseObjects().

   {
     std::stringstream ss;
     ss << prefix << "_" << middle;
     if (!suffix.empty())
       ss << "_" << suffix;
     return ss.str();
   }

◆ getBoundaryNames()

const std::vector< BoundaryName > & Component1DConnection::getBoundaryNames ( ) const

inherited

Gets the boundary names for this component.

Returns: boundary names for this component

Definition at line 151 of file Component1DConnection.C.

Referenced by FlowBoundary1Phase::addWeakBCs(), and FlowBoundaryGasMix::addWeakBCs().

 {
   checkSetupStatus(MESH_PREPARED);
 
   return _boundary_names;
 }

◆ getComponent()

template<typename T >

const T & Component::getComponent ( const std::string & name ) const

inherited

Return a reference to a component via a parameter name.

Template Parameters

T	the type of the component we are requesting

Parameters

name	The parameter name that has the component name

Definition at line 506 of file Component.h.

 {
   const std::string & comp_name = getParam<std::string>(pname);
   return getComponentByName<T>(comp_name);
 }

◆ getComponentByName()

template<typename T >

const T & Component::getComponentByName ( const std::string & cname ) const

inherited

Return a reference to a component given its name.

Template Parameters

T	the type of the component we are requesting

Parameters

cname The name of the component

Definition at line 514 of file Component.h.

 {
   return _sim.getComponentByName<T>(comp_name);
 }

◆ getConnectedComponentNames()

const std::vector<std::string>& Component1DConnection::getConnectedComponentNames ( ) const

inlineinherited

Returns a list of names of components that are connected to this component.

Returns: list of names of components that are connected to this component

Definition at line 63 of file Component1DConnection.h.

Referenced by Simulation::identifyLoops().

   {
     return _connected_component_names;
   }

◆ getConnectedElementIDs()

const std::vector<dof_id_type>& Component1DJunction::getConnectedElementIDs ( )

inlineprotectedinherited

Gets the element IDs of the connected 1D components.

Definition at line 28 of file Component1DJunction.h.

Referenced by GateValve1Phase::setupMesh(), JunctionOneToOne1Phase::setupMesh(), and VolumeJunction1Phase::setupMesh().

28 { return _connected_elems; }

Component1DJunction::_connected_elems

std::vector< dof_id_type > _connected_elems

Element IDs of connected 1D components.

Definition: Component1DJunction.h:35

◆ getConnectedProcessorIDs()

const std::vector<processor_id_type>& Component1DJunction::getConnectedProcessorIDs ( )

inlineprotectedinherited

Gets the processor IDs of the connected 1D components.

Definition at line 30 of file Component1DJunction.h.

Referenced by GateValve1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

30 { return _proc_ids; }

Component1DJunction::_proc_ids

std::vector< processor_id_type > _proc_ids

Processor IDs of connected 1D components.

Definition: Component1DJunction.h:37

◆ getConnectedSubdomainNames()

const std::vector<SubdomainName>& Component1DConnection::getConnectedSubdomainNames ( ) const

inlineinherited

Gets the vector of connected subdomain names.

Definition at line 71 of file Component1DConnection.h.

   {
     return _connected_subdomain_names;
   }

◆ getConnections()

const std::vector<Connection>& Component1DConnection::getConnections ( ) const

inlineinherited

Returns the vector of connections of this component.

Returns: vector of connections of this component

Definition at line 56 of file Component1DConnection.h.

Referenced by GateValve1Phase::check(), Component1DBoundary::Component1DBoundary(), JunctionOneToOne1Phase::init(), and Component1DJunction::setupMesh().

56 { return _connections; }

Component1DConnection::_connections

std::vector< Connection > _connections

Vector of connections of this component.

Definition: Component1DConnection.h:150

◆ getCoordSysTypes()

const std::vector< Moose::CoordinateSystemType > & Component::getCoordSysTypes ( ) const

virtualinherited

Gets the coordinate system types for this component.

Returns: vector of coordinate system types for this component

Definition at line 315 of file Component.C.

 {
   checkSetupStatus(MESH_PREPARED);
 
   return _coord_sys;
 }

◆ getDependencies()

const std::vector<std::string>& Component::getDependencies ( ) const

inlineinherited

Returns a list of names of components that this component depends upon.

Definition at line 85 of file Component.h.

85 { return _dependencies; }

Component::_dependencies

std::vector< std::string > _dependencies

List of names of components that this component depends upon.

Definition: Component.h:491

◆ getElementIDs()

const std::vector< dof_id_type > & Component::getElementIDs ( ) const

inherited

Gets the element IDs corresponding to this component.

Definition at line 299 of file Component.C.

Referenced by HeatTransferFromHeatStructure3D1Phase::setupMesh().

 {
   checkSetupStatus(MESH_PREPARED);
 
   return _elem_ids;
 }

◆ getEnumParam()

template<typename T >

T Component::getEnumParam ( const std::string & param ) const

inherited

Gets an enum parameter.

This function takes the name of a MooseEnum parameter that is tied to an enum defined in THM. If the value is invalid, an error will be logged, and a negative integer will be cast into the enum type.

Template Parameters

T enum type

Parameters

[in] param name of the MooseEnum parameter

Definition at line 539 of file Component.h.

 {
   const MooseEnum & moose_enum = getParam<MooseEnum>(param);
   const T value = THM::stringToEnum<T>(moose_enum);
   if (static_cast<int>(value) < 0) // cast necessary for scoped enums
   {
     // Get the keys from the MooseEnum. Unfortunately, this returns a list of
     // *all* keys, including the invalid key that was supplied. Thus, that key
     // needs to be manually excluded below.
     const std::vector<std::string> & keys = moose_enum.getNames();
 
     // Create the string of keys to go in the error message. The last element of
     // keys is skipped because the invalid key should always be last.
     std::string keys_string = "{";
     for (unsigned int i = 0; i < keys.size() - 1; ++i)
     {
       if (i != 0)
         keys_string += ",";
       keys_string += "'" + keys[i] + "'";
     }
     keys_string += "}";
 
     logError("The parameter '" + param + "' was given an invalid value ('" +
              std::string(moose_enum) + "'). Valid values (case-insensitive) are " + keys_string);
   }
 
   return value;
 }

◆ getFluidPropertiesName()

const UserObjectName & FlowJunction::getFluidPropertiesName ( ) const

inherited

Gets the name of fluid properties used in all flow connections.

Returns: name of fluid properties used in all flow connections

Definition at line 78 of file FlowJunction.C.

 {
   checkSetupStatus(INITIALIZED_PRIMARY);
 
   return _fp_name;
 }

◆ getMomentofInertiaVariableName()

VariableName ShaftConnectable::getMomentofInertiaVariableName ( ) const

virtualinherited

Definition at line 36 of file ShaftConnectable.C.

 {
   return _moment_of_inertia_var_name;
 }

◆ getNodeIDs()

const std::vector< dof_id_type > & Component1DConnection::getNodeIDs ( ) const

virtualinherited

Gets the list of boundary nodes connected to this component.

Returns: list of connected boundary nodes

Definition at line 143 of file Component1DConnection.C.

 {
   checkSetupStatus(MESH_PREPARED);
 
   return _nodes;
 }

◆ getShaftConnectedUserObjectName()

virtual UserObjectName ShaftConnectedCompressor1Phase::getShaftConnectedUserObjectName ( ) const

inlineoverridevirtual

Reimplemented from ShaftConnectable.

Definition at line 25 of file ShaftConnectedCompressor1Phase.h.

Referenced by addMooseObjects(), and buildVolumeJunctionUserObject().

   {
     return _junction_uo_name;
   }

◆ getSubdomainNames()

const std::vector< SubdomainName > & Component::getSubdomainNames ( ) const

virtualinherited

Gets the subdomain names for this component.

Returns: vector of subdomain names for this component

Definition at line 307 of file Component.C.

 {
   checkSetupStatus(MESH_PREPARED);
 
   return _subdomain_names;
 }

◆ getTHMProblem()

THMProblem & Component::getTHMProblem ( ) const

inherited

Gets the THM problem.

Definition at line 135 of file Component.C.

 {
   return _sim;
 }

◆ getTorqueVariableName()

VariableName ShaftConnectable::getTorqueVariableName ( ) const

virtualinherited

Definition at line 42 of file ShaftConnectable.C.

 {
   return _torque_var_name;
 }

◆ hasComponent()

template<typename T >

bool Component::hasComponent ( const std::string & name ) const

inherited

Check the existence and type of a component via a parameter name.

Template Parameters

T	the type of the component we are requesting

Parameters

name	The parameter name that has the component name

Returns: true if the component with given name and type exists, otherwise false

Definition at line 521 of file Component.h.

 {
   const std::string & comp_name = getParam<std::string>(pname);
   return hasComponentByName<T>(comp_name);
 }

◆ hasComponentByName()

template<typename T >

bool Component::hasComponentByName ( const std::string & cname ) const

inherited

Check the existence and type of a component given its name.

Template Parameters

T	the type of the component we are requesting

Parameters

cname The name of the component

Returns: true if the component with given name and type exists, otherwise false

Definition at line 529 of file Component.h.

 {
   if (_sim.hasComponentOfType<T>(comp_name))
     return true;
   else
     return false;
 }

◆ hasParam()

template<typename T >

bool Component::hasParam ( const std::string & name ) const

inherited

Test if a parameter exists in the object's input parameters.

Parameters

name	The name of the parameter

Returns: true if the parameter exists, false otherwise

Definition at line 499 of file Component.h.

 {
   return parameters().have_parameter<T>(name);
 }

◆ init()

void FlowJunction1Phase::init ( )

overrideprotectedvirtualinherited

Initializes the component.

The reason this function exists (as opposed to just having everything in the constructor) is because some initialization depends on all components existing, since many components couple to other components. Therefore, when deciding whether code should go into the constructor or this function, one should use the following reasoning: if an operation does not require the existence of other components, then put that operation in the constructor; otherwise, put it in this function.

Reimplemented from FlowJunction.

Reimplemented in JunctionOneToOne1Phase.

Definition at line 23 of file FlowJunction1Phase.C.

Referenced by JunctionOneToOne1Phase::init().

 {
   FlowJunction::init();
 
   for (const auto & connection : _connections)
   {
     const std::string comp_name = connection._component_name;
     if (hasComponentByName<FlowChannel1Phase>(comp_name))
     {
       const FlowChannel1Phase & comp =
           getTHMProblem().getComponentByName<FlowChannel1Phase>(comp_name);
 
       _numerical_flux_names.push_back(comp.getNumericalFluxUserObjectName());
     }
   }
 }

◆ initSecondary()

void Component1DJunction::initSecondary ( )

overrideprotectedvirtualinherited

Perform secondary initialization, which relies on init() being called for all components.

Reimplemented from Component.

Definition at line 71 of file Component1DJunction.C.

 {
   Component1DConnection::initSecondary();
 
   for (auto & eid : _connected_elems)
   {
     const Elem * elem = constMesh().queryElemPtr(eid);
     if (elem != nullptr && elem->processor_id() == processor_id())
       _proc_ids.push_back(elem->processor_id());
     else
       _proc_ids.push_back(0);
   }
   comm().sum(_proc_ids);
 }

◆ insistParameterExists()

template<typename T >

void Component::insistParameterExists	(	const std::string &	function_name,
		const std::string &	param_name
	)		const

protectedinherited

Runtime check to make sure that a parameter of specified type exists in the component's input parameters.

This is intended to help developers write code. The idea is to provide a useful message when developers make typos, etc. If this check fails, the code execution will be stopped.

Template Parameters

T	The type of the parameter to be checked

Parameters

function_name	The name of the function calling this method
param_name	The name of the parameter to be checked

Definition at line 570 of file Component.h.

 {
   if (!hasParam<T>(param_name))
     mooseError(name(),
                ": Calling ",
                function_name,
                " failed, parameter '",
                param_name,
                "' does not exist or does not have the type you requested. Double check your "
                "spelling and/or type of the parameter.");
 }

◆ junctionVariableName()

std::string VolumeJunction1Phase::junctionVariableName ( const std::string & var_base ) const

protectedinherited

Returns the name of junction variable, depending on whether scalar.

Parameters

[in] var_base Base variable name

Definition at line 297 of file VolumeJunction1Phase.C.

 {
   return var_base;
 }

◆ logComponentError()

template<typename... Args>

void LoggingInterface::logComponentError	(	const std::string &	component_name,
		Args &&...	args
	)		const

inlineinherited

Logs an error for a component.

Parameters

[in] component_name Name of the component

Definition at line 47 of file LoggingInterface.h.

Referenced by Closures1PhaseSimple::checkFlowChannel(), Closures1PhaseSimple::checkHeatTransfer(), and Component::logError().

   {
     _log.add(Logger::ERROR, component_name, ": ", std::forward<Args>(args)...);
   }

◆ logComponentWarning()

template<typename... Args>

void LoggingInterface::logComponentWarning	(	const std::string &	component_name,
		Args &&...	args
	)		const

inlineinherited

Logs a warning for a component.

Parameters

[in] component_name Name of the component

Definition at line 67 of file LoggingInterface.h.

Referenced by Component::logWarning().

   {
     _log.add(Logger::WARNING, component_name, ": ", std::forward<Args>(args)...);
   }

◆ logError()

template<typename... Args>

void Component::logError ( Args &&... args ) const

inlineinherited

Logs an error.

Definition at line 215 of file Component.h.

Referenced by Component1DConnection::addConnection(), HSBoundary::check(), HeatSourceBase::check(), Component1DJunction::check(), SupersonicInlet::check(), HSBoundaryExternalAppHeatFlux::check(), Outlet1Phase::check(), HeatStructure2DCoupler::check(), InletStagnationEnthalpyMomentum1Phase::check(), InletMassFlowRateTemperature1Phase::check(), InletVelocityTemperature1Phase::check(), InletDensityVelocity1Phase::check(), InletStagnationPressureTemperature1Phase::check(), HeatStructure2DRadiationCouplerRZ::check(), HeatTransferFromExternalAppTemperature1Phase::check(), GeneratedMeshComponent::check(), HeatStructure2DCouplerBase::check(), Shaft::check(), HSCoupler2D2DRadiation::check(), HSCoupler2D3D::check(), HeatTransferFromHeatStructure1Phase::check(), VolumeJunction1Phase::check(), HeatTransferFromHeatStructure3D1Phase::check(), FlowChannel1PhaseBase::check(), HeatStructureInterface::check(), Component2D::check(), FlowChannelBase::check(), HSBoundary::checkAllComponent2DBoundariesAreExternal(), Component1DConnection::checkAllConnectionsHaveSame(), Component::checkComponentExistsByName(), Component::checkComponentOfTypeExistsByName(), Component::checkEqualSize(), FlowChannel1Phase::checkFluidProperties(), FlowChannelGasMix::checkFluidProperties(), Component::checkMutuallyExclusiveParameters(), Component1DConnection::checkNumberOfConnections(), Component::checkParameterValueLessThan(), Component1DConnection::checkSizeEqualsNumberOfConnections(), Component::checkSizeEqualsParameterValue(), Component::checkSizeEqualsValue(), Component::checkSizeGreaterThan(), Component::checkSizeLessThan(), ElbowPipe1Phase::ElbowPipe1Phase(), FreeBoundary::FreeBoundary(), GateValve::GateValve(), Component::getEnumParam(), HeatTransferFromHeatStructure3D1Phase::getFlowChannelAxisAlignment(), HeatGeneration::HeatGeneration(), HeatSourceVolumetric::HeatSourceVolumetric(), HeatStructureFromFile3D::HeatStructureFromFile3D(), HeatTransferFromHeatStructure3D1Phase::init(), Component1DConnection::init(), HeatTransfer1PhaseBase::initSecondary(), JunctionOneToOne::JunctionOneToOne(), LoggerTestComponent::LoggerTestComponent(), PrescribedReactorPower::PrescribedReactorPower(), Component1DConnection::setupMesh(), and SolidWall::SolidWall().

   {
     logComponentError(cname(), std::forward<Args>(args)...);
   }

◆ logWarning()

template<typename... Args>

void Component::logWarning ( Args &&... args ) const

inlineinherited

Logs a warning.

Definition at line 224 of file Component.h.

Referenced by GateValve1Phase::check(), LoggerTestComponent::LoggerTestComponent(), and VolumeJunction1Phase::VolumeJunction1Phase().

   {
     logComponentWarning(cname(), std::forward<Args>(args)...);
   }

◆ makeFunctionControllableIfConstant()

void Component::makeFunctionControllableIfConstant	(	const FunctionName &	fn_name,
		const std::string &	control_name,
		const std::string &	param = `"value"`
	)		const

inherited

Makes a function controllable if it is constant.

Parameters

[in]	fn_name	name of the function
[in]	control_name	name of control parameter
[in]	param	name of controlled parameter

Definition at line 141 of file Component.C.

Referenced by FlowModel::addCommonInitialConditions(), FlowChannelBase::addCommonObjects(), HeatTransferBase::addHeatedPerimeter(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), HSBoundarySpecifiedTemperature::addMooseObjects(), ShaftConnectedMotor::addMooseObjects(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), HeatTransferFromSpecifiedTemperature1Phase::addVariables(), and Closures1PhaseBase::addWallFrictionFunctionMaterial().

 {
   const Function & fn = _sim.getFunction(fn_name);
   if (dynamic_cast<const ConstantFunction *>(&fn) != nullptr)
     connectObject(fn.parameters(), fn_name, control_name, param);
 }

◆ mesh()

THMMesh & Component::mesh ( )

inherited

Non-const reference to THM mesh, which can only be called before the end of mesh setup.

Definition at line 60 of file Component.C.

Referenced by GeometricalComponent::addElement(), GeometricalComponent::addElementEdge2(), GeometricalComponent::addElementEdge3(), GeometricalComponent::addElementQuad4(), GeometricalComponent::addElementQuad9(), Component::addNode(), Component::addNodeElement(), Component2D::build2DMesh(), Component2D::build2DMesh2ndOrder(), Component2D::buildMesh(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), Component::setSubdomainInfo(), Component1DJunction::setupMesh(), Component1DBoundary::setupMesh(), GeneratedMeshComponent::setupMesh(), VolumeJunction1Phase::setupMesh(), and FileMeshComponent::setupMesh().

 {
   if (_component_setup_status >= MESH_PREPARED)
     mooseError(
         "A non-const reference to the THM mesh cannot be obtained after mesh setup is complete.");
   else
     return _mesh;
 }

◆ parent()

Component* Component::parent ( )

inlineinherited

Definition at line 54 of file Component.h.

54 { return _parent; }

Component::_parent

Component * _parent

Pointer to a parent component (used in composed components)

Definition: Component.h:438

◆ passParameter() [1/2]

template<typename T >

void THMObject::passParameter	(	const std::string &	name,
		const std::string &	new_name,
		InputParameters &	params
	)		const

protectedinherited

Passes a parameter from this object's input parameters to another set of input parameters.

Template Parameters

T	the type of the parameter to be passed

Parameters

name[in]	name the name of this object's parameter
new_name[in]	new_name the name of the corresponding parameters in `params`
params[in,out]	params the parameters to which the parameter will be passed

Definition at line 54 of file THMObject.h.

 {
   if (isParamValid(name))
     params.set<T>(new_name) = _pars.get<T>(name);
 }

◆ passParameter() [2/2]

template<typename T >

void THMObject::passParameter	(	const std::string &	name,
		InputParameters &	params
	)		const

protectedinherited

Passes a parameter from this object's input parameters to another set of input parameters.

This version overloads the other by assuming that the parameter has the same name.

Template Parameters

T	the type of the parameter to be passed

Parameters

name[in]	name the name of the parameter
params[in,out]	params the parameters to which the parameter will be passed

Definition at line 64 of file THMObject.h.

 {
   passParameter<T>(name, name, params);
 }

◆ problemIsTransient()

bool Component::problemIsTransient ( ) const

inlineinherited

Whether the problem is transient.

Definition at line 252 of file Component.h.

Referenced by HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), and FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient().

252 { return getTHMProblem().isTransient(); }

Component::getTHMProblem

THMProblem & getTHMProblem() const

Gets the THM problem.

Definition: Component.C:135

FEProblem::isTransient

virtual bool isTransient() const override

◆ setShaftName()

void ShaftConnectable::setShaftName ( const std::string & name ) const

virtualinherited

Definition at line 54 of file ShaftConnectable.C.

Referenced by Shaft::init().

 {
   _shaft_name = name;
   _connected_to_shaft = true;
 }

◆ setSubdomainInfo()

void Component::setSubdomainInfo	(	SubdomainID	subdomain_id,
		const std::string &	subdomain_name,
		const Moose::CoordinateSystemType &	coord_system = `Moose::COORD_XYZ`
	)

protectedvirtualinherited

Sets the next subdomain ID, name, and coordinate system.

Parameters

[in]	subdomain_id	subdomain index
[in]	subdomain_name	name of the new subdomain
[in]	coord_system	type of coordinate system

Definition at line 229 of file Component.C.

Referenced by Component2D::buildMesh(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), and VolumeJunction1Phase::setupMesh().

 {
   _subdomain_ids.push_back(subdomain_id);
   _subdomain_names.push_back(subdomain_name);
   _coord_sys.push_back(coord_system);
   if (_parent)
   {
     _parent->_subdomain_ids.push_back(subdomain_id);
     _parent->_subdomain_names.push_back(subdomain_name);
     _parent->_coord_sys.push_back(coord_system);
   }
   mesh().setSubdomainName(subdomain_id, subdomain_name);
 }

◆ setupMesh()

void VolumeJunction1Phase::setupMesh ( )

overrideprotectedvirtualinherited

Performs mesh setup such as creating mesh or naming mesh sets.

Reimplemented from Component1DJunction.

Definition at line 90 of file VolumeJunction1Phase.C.

 {
   FlowJunction1Phase::setupMesh();
 
   // Add a NodeElem to the mesh
   auto * node = addNode(_position);
   auto * elem = addNodeElement(node->id());
   _junction_subdomain_id = mesh().getNextSubdomainId();
   elem->subdomain_id() = _junction_subdomain_id;
   setSubdomainInfo(_junction_subdomain_id, name());
 
   // Add coupling between the flow channel end elements and the NodeElem
   const auto & elem_ids = getConnectedElementIDs();
   for (unsigned int i = 0; i < elem_ids.size(); i++)
     getTHMProblem().augmentSparsity(elem_ids[i], elem->id());
 }

◆ stringify()

std::string Component::stringify ( EComponentSetupStatus status ) const

inherited

Return a string for the setup status.

Definition at line 271 of file Component.C.

Referenced by Component::checkSetupStatus().

 {
   switch (status)
   {
     case CREATED:
       return "component created";
     case MESH_PREPARED:
       return "component mesh set up";
     case INITIALIZED_PRIMARY:
       return "primary initialization completed";
     case INITIALIZED_SECONDARY:
       return "secondary initialization completed";
     case CHECKED:
       return "component fully set up and checked";
     default:
       mooseError("Should not reach here");
   }
 }

◆ validParams()

InputParameters ShaftConnectedCompressor1Phase::validParams ( )

static

Definition at line 23 of file ShaftConnectedCompressor1Phase.C.

 {
   InputParameters params = VolumeJunction1Phase::validParams();
   params += ShaftConnectable::validParams();
   params.makeParamRequired<Real>("A_ref");
   params.addRequiredParam<BoundaryName>("inlet", "Compressor inlet");
   params.addRequiredParam<BoundaryName>("outlet", "Compressor outlet");
   params.set<std::vector<BoundaryName>>("connections") = {};
   params.suppressParameter<std::vector<BoundaryName>>("connections");
   params.addParam<bool>("treat_as_turbine", false, "Treat the compressor as a turbine?");
   params.addRequiredParam<Real>("omega_rated", "Rated compressor speed [rad/s]");
   params.addRequiredParam<Real>("mdot_rated", "Rated compressor mass flow rate [kg/s]");
   params.addRequiredParam<Real>("rho0_rated", "Rated compressor stagnation fluid density [kg/m^3]");
   params.addRequiredParam<Real>("c0_rated", "Rated compressor stagnation sound speed [m/s]");
   params.addRequiredParam<Real>("speed_cr_fr", "Compressor speed threshold for friction [-]");
   params.addRequiredParam<Real>("tau_fr_const", "Compressor friction constant [N-m]");
   params.addRequiredParam<std::vector<Real>>("tau_fr_coeff",
                                              "Compressor friction coefficients [N-m]");
   params.addRequiredParam<Real>("speed_cr_I", "Compressor speed threshold for inertia [-]");
   params.addRequiredParam<Real>("inertia_const", "Compressor inertia constant [kg-m^2]");
   params.addRequiredParam<std::vector<Real>>("inertia_coeff",
                                              "Compressor inertia coefficients [kg-m^2]");
   params.addRequiredParam<std::vector<Real>>(
       "speeds",
       "Relative corrected speeds. Order of speeds needs correspond to the "
       "orders of `Rp_functions` and `eff_functions` [-]");
   params.addRequiredParam<std::vector<FunctionName>>(
       "Rp_functions",
       "Functions of pressure ratio versus relative corrected flow. Each function is for a "
       "different, constant relative corrected speed. The order of function names should correspond "
       "to the order of speeds in the `speeds` parameter [-]");
   params.addRequiredParam<std::vector<FunctionName>>(
       "eff_functions",
       "Functions of adiabatic efficiency versus relative corrected flow. Each function is for a "
       "different, constant relative corrected speed. The order of function names should correspond "
       "to the order of speeds in the `speeds` parameter [-]");
   params.addParam<Real>("min_pressure_ratio", 0.0, "Minimum pressure ratio");
   params.addParam<Real>("max_pressure_ratio", 50.0, "Maximum pressure ratio");
 
   params.addClassDescription(
       "1-phase compressor that must be connected to a Shaft component. Compressor speed "
       "is controlled by the connected shaft; Isentropic/Dissipation torque and delta_p are "
       "computed by user input functions of inlet flow rate and shaft speed");
 
   return params;
 }

Member Data Documentation

◆ _A_ref

const Real& VolumeJunction1Phase::_A_ref

protectedinherited

Reference area.

Definition at line 115 of file VolumeJunction1Phase.h.

Referenced by JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _boundary_ids

std::vector<unsigned int> Component1DConnection::_boundary_ids

protectedinherited

Boundary IDs of connected components.

Definition at line 141 of file Component1DConnection.h.

Referenced by Component1DConnection::setupMesh().

◆ _boundary_names

std::vector<BoundaryName> Component1DConnection::_boundary_names

protectedinherited

Boundary names of connected components.

Definition at line 143 of file Component1DConnection.h.

Referenced by GateValve1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Component1DConnection::getBoundaryNames(), and Component1DConnection::setupMesh().

◆ _c0_rated

const Real& ShaftConnectedCompressor1Phase::_c0_rated

protected

Rated compressor inlet stagnation sound speed.

Definition at line 45 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _connected_component_names

std::vector<std::string> Component1DConnection::_connected_component_names

protectedinherited

Vector of connected component names.

Definition at line 152 of file Component1DConnection.h.

Referenced by Component1DConnection::addConnection(), FlowJunction1Phase::check(), FlowJunction::check(), Component1DConnection::check(), and Component1DConnection::getConnectedComponentNames().

◆ _connected_elems

std::vector<dof_id_type> Component1DJunction::_connected_elems

protectedinherited

Element IDs of connected 1D components.

Definition at line 35 of file Component1DJunction.h.

Referenced by Component1DJunction::getConnectedElementIDs(), Component1DJunction::initSecondary(), and Component1DJunction::setupMesh().

◆ _connected_subdomain_names

std::vector<SubdomainName> Component1DConnection::_connected_subdomain_names

protectedinherited

Vector of subdomain names of the connected components.

Definition at line 154 of file Component1DConnection.h.

Referenced by Component1DConnection::getConnectedSubdomainNames(), and Component1DConnection::init().

◆ _connected_to_shaft

bool ShaftConnectable::_connected_to_shaft

mutableprotectedinherited

Flag indicating that a shaft has this component connected.

Definition at line 40 of file ShaftConnectable.h.

Referenced by ShaftConnectable::checkShaftConnection(), and ShaftConnectable::setShaftName().

◆ _connections

std::vector<Connection> Component1DConnection::_connections

protectedinherited

Vector of connections of this component.

Definition at line 150 of file Component1DConnection.h.

Referenced by Component1DConnection::addConnection(), Component1DJunction::check(), Component1DConnection::checkNumberOfConnections(), Component1DConnection::checkSizeEqualsNumberOfConnections(), Component1DConnection::getConnections(), FlowJunction1Phase::init(), FlowJunction::init(), FlowBoundary::init(), Component1DConnection::init(), and Component1DConnection::setupMesh().

◆ _coord_sys

std::vector<Moose::CoordinateSystemType> Component::_coord_sys

protectedinherited

List of coordinate system for each subdomain.

Definition at line 464 of file Component.h.

Referenced by Component::getCoordSysTypes(), and Component::setSubdomainInfo().

◆ _delta_p_var_name

const VariableName ShaftConnectedCompressor1Phase::_delta_p_var_name

protected

Name of compressor delta_p variable.

Definition at line 66 of file ShaftConnectedCompressor1Phase.h.

Referenced by addMooseObjects(), and addVariables().

◆ _directions

std::vector<RealVectorValue> Component1DConnection::_directions

protectedinherited

Directions of connected components.

Definition at line 147 of file Component1DConnection.h.

Referenced by JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and Component1DConnection::setupMesh().

◆ _dissipation_torque_var_name

const VariableName ShaftConnectedCompressor1Phase::_dissipation_torque_var_name

protected

Name of compressor dissipation torque variable.

Definition at line 70 of file ShaftConnectedCompressor1Phase.h.

Referenced by addMooseObjects(), and addVariables().

◆ _eff_functions

const std::vector<FunctionName>& ShaftConnectedCompressor1Phase::_eff_functions

protected

Names of the adiabatic efficiency functions.

Definition at line 64 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _elem_ids

std::vector<dof_id_type> Component::_elem_ids

protectedinherited

Element IDs of this component.

Definition at line 457 of file Component.h.

Referenced by GeometricalComponent::addElement(), GeometricalComponent::addElementEdge2(), GeometricalComponent::addElementEdge3(), GeometricalComponent::addElementQuad4(), GeometricalComponent::addElementQuad9(), Component::addNodeElement(), Component1D::buildMesh(), and Component::getElementIDs().

◆ _elems

std::vector<const Elem *> Component1DConnection::_elems

protectedinherited

Boundary elements of connected components.

Definition at line 135 of file Component1DConnection.h.

Referenced by Component1DBoundary::setupMesh(), and Component1DConnection::setupMesh().

◆ _end_type_to_enum

const std::map< std::string, Component1DConnection::EEndType > Component1DConnection::_end_type_to_enum {{"IN", IN}, {"OUT", OUT}}

staticinherited

Map of end type string to enum.

Definition at line 29 of file Component1DConnection.h.

Referenced by THM::stringToEnum().

◆ _factory

Factory& Component::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 446 of file Component.h.

◆ _flow_model

std::shared_ptr<const FlowModel> FlowJunction::_flow_model

protectedinherited

Flow model.

Definition at line 36 of file FlowJunction.h.

Referenced by FlowJunction::init().

◆ _flow_model_id

THM::FlowModelID FlowJunction::_flow_model_id

protectedinherited

Flow model ID.

Definition at line 34 of file FlowJunction.h.

Referenced by FlowJunction::init().

◆ _fp_name

UserObjectName FlowJunction::_fp_name

protectedinherited

Fluid property user object name.

Definition at line 38 of file FlowJunction.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), VolumeJunction1Phase::addVolumeJunctionIC(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), FlowJunction::getFluidPropertiesName(), and FlowJunction::init().

◆ _friction_torque_var_name

const VariableName ShaftConnectedCompressor1Phase::_friction_torque_var_name

protected

Name of compressor friction torque variable.

Definition at line 72 of file ShaftConnectedCompressor1Phase.h.

Referenced by addMooseObjects(), and addVariables().

◆ _inertia_coeff

const std::vector<Real>& ShaftConnectedCompressor1Phase::_inertia_coeff

protected

Compressor inertia coefficients.

Definition at line 57 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _inertia_const

const Real& ShaftConnectedCompressor1Phase::_inertia_const

protected

Compressor inertia constant.

Definition at line 55 of file ShaftConnectedCompressor1Phase.h.

Referenced by addVariables(), and buildVolumeJunctionUserObject().

◆ _inlet

const BoundaryName& ShaftConnectedCompressor1Phase::_inlet

protected

Compressor inlet.

Definition at line 35 of file ShaftConnectedCompressor1Phase.h.

Referenced by ShaftConnectedCompressor1Phase().

◆ _isentropic_torque_var_name

const VariableName ShaftConnectedCompressor1Phase::_isentropic_torque_var_name

protected

Name of compressor isentropic torque variable.

Definition at line 68 of file ShaftConnectedCompressor1Phase.h.

Referenced by addMooseObjects(), and addVariables().

◆ _junction_subdomain_id

subdomain_id_type Component1DJunction::_junction_subdomain_id

protectedinherited

Junction subdomain ID.

Definition at line 40 of file Component1DJunction.h.

Referenced by Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::setupMesh().

◆ _junction_uo_name

const std::string FlowJunction::_junction_uo_name

protectedinherited

Name of junction user object name, if any.

Definition at line 40 of file FlowJunction.h.

Referenced by GateValve1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), getShaftConnectedUserObjectName(), ShaftConnectedTurbine1Phase::getShaftConnectedUserObjectName(), and ShaftConnectedPump1Phase::getShaftConnectedUserObjectName().

◆ _K

const Real& VolumeJunction1Phase::_K

protectedinherited

Form loss coefficient.

Definition at line 113 of file VolumeJunction1Phase.h.

Referenced by JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _log

Logger& LoggingInterface::_log

protectedinherited

Definition at line 73 of file LoggingInterface.h.

Referenced by LoggingInterface::logComponentError(), LoggingInterface::logComponentWarning(), LoggingInterface::logError(), and LoggingInterface::logWarning().

◆ _mdot_rated

const Real& ShaftConnectedCompressor1Phase::_mdot_rated

protected

Rated compressor mass flow rate.

Definition at line 41 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _mesh

THMMesh& Component::_mesh

protectedinherited

The THM mesh TODO: make _mesh private (applications need to switch to getters to avoid breaking)

Definition at line 452 of file Component.h.

Referenced by Component::addRelationshipManager(), Component::constMesh(), and Component::mesh().

◆ _moi_var_name

const VariableName ShaftConnectedCompressor1Phase::_moi_var_name

protected

Name of compressor inertia variable.

Definition at line 74 of file ShaftConnectedCompressor1Phase.h.

◆ _moment_of_inertia_var_name

VariableName ShaftConnectable::_moment_of_inertia_var_name

protectedinherited

Moment of inertia variable name.

Definition at line 32 of file ShaftConnectable.h.

Referenced by addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), addVariables(), ShaftConnectedTurbine1Phase::addVariables(), ShaftConnectedPump1Phase::addVariables(), and ShaftConnectable::getMomentofInertiaVariableName().

◆ _node_ids

std::vector<dof_id_type> Component::_node_ids

protectedinherited

Node IDs of this component.

Definition at line 455 of file Component.h.

Referenced by Component::addNode(), Component1D::buildMesh(), Component::getNodeIDs(), GeneratedMeshComponent::setupMesh(), and FileMeshComponent::setupMesh().

◆ _nodes

std::vector<dof_id_type> Component1DConnection::_nodes

protectedinherited

Boundary node IDs from connected components.

Definition at line 139 of file Component1DConnection.h.

Referenced by Component1DConnection::getNodeIDs(), Component1DJunction::setupMesh(), Component1DBoundary::setupMesh(), and Component1DConnection::setupMesh().

◆ _normals

std::vector<Real> Component1DConnection::_normals

protectedinherited

Outward normals associated with connected components.

Definition at line 145 of file Component1DConnection.h.

Referenced by GateValve1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Component1DBoundary::setupMesh(), and Component1DConnection::setupMesh().

◆ _numerical_flux_names

std::vector<UserObjectName> FlowJunction1Phase::_numerical_flux_names

protectedinherited

Definition at line 27 of file FlowJunction1Phase.h.

Referenced by GateValve1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), and FlowJunction1Phase::init().

◆ _omega_rated

const Real& ShaftConnectedCompressor1Phase::_omega_rated

protected

Rated compressor speed.

Definition at line 39 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _outlet

const BoundaryName& ShaftConnectedCompressor1Phase::_outlet

protected

Compressor outlet.

Definition at line 37 of file ShaftConnectedCompressor1Phase.h.

Referenced by ShaftConnectedCompressor1Phase().

◆ _parent

Component* Component::_parent

protectedinherited

Pointer to a parent component (used in composed components)

Definition at line 438 of file Component.h.

Referenced by HeatStructureBase::addMooseObjects(), Component::cname(), Component::parent(), and Component::setSubdomainInfo().

◆ _position

const Point& VolumeJunction1Phase::_position

protectedinherited

Spatial position of center of the junction.

Definition at line 82 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::setupMesh().

◆ _positions

std::vector<Point> Component1DConnection::_positions

protectedinherited

Physical positions of connected components.

Definition at line 133 of file Component1DConnection.h.

Referenced by Component1DConnection::setupMesh().

◆ _pressure_var_name

const VariableName VolumeJunction1Phase::_pressure_var_name

protectedinherited

pressure variable name for junction

Definition at line 106 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), and VolumeJunction1Phase::addVariables().

◆ _proc_ids

std::vector<processor_id_type> Component1DJunction::_proc_ids

protectedinherited

Processor IDs of connected 1D components.

Definition at line 37 of file Component1DJunction.h.

Referenced by Component1DJunction::getConnectedProcessorIDs(), and Component1DJunction::initSecondary().

◆ _rho0_rated

const Real& ShaftConnectedCompressor1Phase::_rho0_rated

protected

Rated compressor inlet stagnation fluid density.

Definition at line 43 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _rhoEV_var_name

const VariableName VolumeJunction1Phase::_rhoEV_var_name

protectedinherited

rho*E*V variable name for junction

Definition at line 104 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), VolumeJunction1Phase::addVariables(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _rhouV_var_name

const VariableName VolumeJunction1Phase::_rhouV_var_name

protectedinherited

rho*u*V variable name for junction

Definition at line 98 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), VolumeJunction1Phase::addVariables(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _rhoV_var_name

const VariableName VolumeJunction1Phase::_rhoV_var_name

protectedinherited

rho*V variable name for junction

Definition at line 96 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), VolumeJunction1Phase::addVariables(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _rhovV_var_name

const VariableName VolumeJunction1Phase::_rhovV_var_name

protectedinherited

rho*v*V variable name for junction

Definition at line 100 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), VolumeJunction1Phase::addVariables(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _rhowV_var_name

const VariableName VolumeJunction1Phase::_rhowV_var_name

protectedinherited

rho*w*V variable name for junction

Definition at line 102 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), VolumeJunction1Phase::addVariables(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _Rp_functions

const std::vector<FunctionName>& ShaftConnectedCompressor1Phase::_Rp_functions

protected

Names of the pressure ratio functions.

Definition at line 62 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _scaling_factor_rhoEV

const Real& VolumeJunction1Phase::_scaling_factor_rhoEV

protectedinherited

Scaling factor for rho*E*V.

Definition at line 93 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addVariables().

◆ _scaling_factor_rhouV

const Real& VolumeJunction1Phase::_scaling_factor_rhouV

protectedinherited

Scaling factor for rho*u*V.

Definition at line 87 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addVariables().

◆ _scaling_factor_rhoV

const Real& VolumeJunction1Phase::_scaling_factor_rhoV

protectedinherited

Scaling factor for rho*V.

Definition at line 85 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addVariables().

◆ _scaling_factor_rhovV

const Real& VolumeJunction1Phase::_scaling_factor_rhovV

protectedinherited

Scaling factor for rho*v*V.

Definition at line 89 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addVariables().

◆ _scaling_factor_rhowV

const Real& VolumeJunction1Phase::_scaling_factor_rhowV

protectedinherited

Scaling factor for rho*w*V.

Definition at line 91 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addVariables().

◆ _shaft_name

std::string ShaftConnectable::_shaft_name

mutableprotectedinherited

Name of the shaft component.

Definition at line 38 of file ShaftConnectable.h.

Referenced by ShaftConnectedMotor::addMooseObjects(), buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and ShaftConnectable::setShaftName().

◆ _sides

std::vector<unsigned short int> Component1DConnection::_sides

protectedinherited

Boundary sides of connected components.

Definition at line 137 of file Component1DConnection.h.

Referenced by Component1DBoundary::setupMesh(), and Component1DConnection::setupMesh().

◆ _sim

THMProblem& Component::_sim

protectedinherited

THM problem this component is part of TODO: make _sim private (applications need to switch to getters to avoid breaking).

Also, rename to "_thm_problem" at that point.

Definition at line 443 of file Component.h.

Referenced by Component::checkComponentExistsByName(), Component::checkComponentOfTypeExistsByName(), Component::getComponentByName(), Component::getTHMProblem(), Component::hasComponentByName(), and Component::makeFunctionControllableIfConstant().

◆ _speed_cr_fr

const Real& ShaftConnectedCompressor1Phase::_speed_cr_fr

protected

Compressor speed threshold for friction.

Definition at line 47 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _speed_cr_I

const Real& ShaftConnectedCompressor1Phase::_speed_cr_I

protected

Compressor speed threshold for inertia.

Definition at line 53 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _speeds

const std::vector<Real>& ShaftConnectedCompressor1Phase::_speeds

protected

Compressor speeds which correspond to Rp and eff function order.

Definition at line 60 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _subdomain_ids

std::vector<SubdomainID> Component::_subdomain_ids

protectedinherited

List of subdomain IDs this components owns.

Definition at line 460 of file Component.h.

Referenced by Component2D::build2DMesh(), Component2D::build2DMesh2ndOrder(), and Component::setSubdomainInfo().

◆ _subdomain_names

std::vector<SubdomainName> Component::_subdomain_names

protectedinherited

List of subdomain names this components owns.

Definition at line 462 of file Component.h.

Referenced by Component::getSubdomainNames(), and Component::setSubdomainInfo().

◆ _tau_fr_coeff

const std::vector<Real>& ShaftConnectedCompressor1Phase::_tau_fr_coeff

protected

Compressor friction coefficients.

Definition at line 51 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _tau_fr_const

const Real& ShaftConnectedCompressor1Phase::_tau_fr_const

protected

Compressor friction constant.

Definition at line 49 of file ShaftConnectedCompressor1Phase.h.

Referenced by buildVolumeJunctionUserObject().

◆ _temperature_var_name

const VariableName VolumeJunction1Phase::_temperature_var_name

protectedinherited

temperature variable name for junction

Definition at line 108 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), and VolumeJunction1Phase::addVariables().

◆ _torque_var_name

VariableName ShaftConnectable::_torque_var_name

protectedinherited

Torque of variable name.

Definition at line 34 of file ShaftConnectable.h.

Referenced by ShaftConnectable::getTorqueVariableName().

◆ _user_object_name

UserObjectName ShaftConnectable::_user_object_name

protectedinherited

Shaft-connectable user object name.

Definition at line 36 of file ShaftConnectable.h.

Referenced by ShaftConnectable::getShaftConnectedUserObjectName().

◆ _velocity_var_name

const VariableName VolumeJunction1Phase::_velocity_var_name

protectedinherited

velocity variable name for junction

Definition at line 110 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), and VolumeJunction1Phase::addVariables().

◆ _volume

const Real VolumeJunction1Phase::_volume

protectedinherited

Volume of the junction.

Definition at line 79 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

◆ _zero

const Real& Component::_zero

protectedinherited

Definition at line 448 of file Component.h.

◆ N_EQ

const unsigned int VolumeJunction1Phase::N_EQ = 5

staticinherited

Number of equations for the junction.

Definition at line 35 of file VolumeJunction1Phase.h.

Referenced by VolumeJunction1Phase::addMooseObjects(), and ADVolumeJunction1PhaseUserObject::ADVolumeJunction1PhaseUserObject().

The documentation for this class was generated from the following files:

thermal_hydraulics/include/components/ShaftConnectedCompressor1Phase.h
thermal_hydraulics/src/components/ShaftConnectedCompressor1Phase.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ EComponentSetupStatus

◆ EEndType

◆ VolumeJunction1PhaseIndices

Constructor & Destructor Documentation

◆ ShaftConnectedCompressor1Phase()

Member Function Documentation

◆ addConnection()

◆ addDependency()

◆ addJunctionIC()

◆ addJunctionVariable()

◆ addMooseObjects()

◆ addNode()

◆ addNodeElement()

◆ addRelationshipManagers()

◆ addRelationshipManagersFromParameters()

◆ addVariables()

◆ addVolumeJunctionIC()

◆ buildVolumeJunctionUserObject()

◆ check()

◆ checkAllConnectionsHaveSame()

◆ checkComponentExistsByName()

◆ checkComponentOfTypeExists()

◆ checkComponentOfTypeExistsByName()

◆ checkEqualSize()

◆ checkMutuallyExclusiveParameters()

◆ checkNumberOfConnections()

◆ checkParameterValueLessThan()

◆ checkSetupStatus()

◆ checkShaftConnection()

◆ checkSizeEqualsNumberOfConnections()

◆ checkSizeEqualsParameterValue()

◆ checkSizeEqualsValue() [1/2]

◆ checkSizeEqualsValue() [2/2]

◆ checkSizeGreaterThan()

◆ checkSizeLessThan()

◆ cname()

◆ connectObject() [1/2]

◆ connectObject() [2/2]

◆ constMesh()

◆ executeCheck()

◆ executeInit()

◆ executeInitSecondary()

◆ executeSetupMesh()

◆ genName() [1/4]

◆ genName() [2/4]

◆ genName() [3/4]

◆ genName() [4/4]

◆ genSafeName()

◆ getBoundaryNames()

◆ getComponent()

◆ getComponentByName()

◆ getConnectedComponentNames()

◆ getConnectedElementIDs()

◆ getConnectedProcessorIDs()

◆ getConnectedSubdomainNames()

◆ getConnections()

◆ getCoordSysTypes()

◆ getDependencies()

◆ getElementIDs()

◆ getEnumParam()

◆ getFluidPropertiesName()

◆ getMomentofInertiaVariableName()

◆ getNodeIDs()

◆ getShaftConnectedUserObjectName()

◆ getSubdomainNames()

◆ getTHMProblem()

◆ getTorqueVariableName()

◆ hasComponent()

◆ hasComponentByName()

◆ hasParam()

◆ init()