ShaftConnectedMotor Class Reference

Motor to drive a shaft component. More...

#include <ShaftConnectedMotor.h>

Inheritance diagram for ShaftConnectedMotor:

Public Types
enum	EComponentSetupStatus {   CREATED , MESH_PREPARED , INITIALIZED_PRIMARY , INITIALIZED_SECONDARY ,   CHECKED }
	Component setup status type. More...
typedef DataFileName	DataFileParameterType

Public Member Functions
	ShaftConnectedMotor (const InputParameters &params)
virtual void	addVariables () override
virtual void	addMooseObjects () override
std::string	stringify (EComponentSetupStatus status) const
	Return a string for the setup status.
const std::string &	cname () const
	Get the component name.
Component *	parent ()
const THMMesh &	constMesh () const
	Const reference to mesh, which can be called at any point.
THMMesh &	mesh ()
	Non-const reference to THM mesh, which can only be called before the end of mesh setup.
THMProblem &	getTHMProblem () const
	Gets the THM problem.
template<typename T >
bool	hasParam (const std::string &name) const
	Test if a parameter exists in the object's input parameters.
const std::vector< std::string > &	getDependencies () const
	Returns a list of names of components that this component depends upon.
void	executeInit ()
	Wrapper function for init() that marks the function as being called.
void	executeInitSecondary ()
	Wrapper function for initSecondary() that marks the function as being called.
void	executeCheck () const
	Wrapper function for check() that marks the function as being called.
void	executeSetupMesh ()
	Wrapper function for setupMesh() that marks the function as being called.
virtual void	addRelationshipManagers (Moose::RelationshipManagerType)
	Adds relationship managers for the component.
virtual Convergence *	getNonlinearConvergence () const
	Gets the Component's nonlinear Convergence object if it has one.
template<typename T >
const T &	getComponent (const std::string &name) const
	Return a reference to a component via a parameter name.
template<typename T >
const T &	getComponentByName (const std::string &cname) const
	Return a reference to a component given its name.
template<typename T >
bool	hasComponent (const std::string &name) const
	Check the existence and type of a component via a parameter name.
template<typename T >
bool	hasComponentByName (const std::string &cname) const
	Check the existence and type of a component given its name.
void	connectObject (const InputParameters &obj_params, const std::string &obj_name, const std::string &param) const
	Connects a controllable parameter of the component to a controllable parameter of a constituent object.
void	connectObject (const InputParameters &obj_params, const std::string &obj_name, const std::string &comp_param, const std::string &obj_param) const
	Connects a controllable parameter of the component to a controllable parameter of a constituent object.
void	checkSetupStatus (const EComponentSetupStatus &status) const
	Throws an error if the supplied setup status of this component has not been reached.
void	checkComponentExistsByName (const std::string &comp_name) const
	Checks that a component exists.
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.
template<typename T >
void	checkComponentOfTypeExistsByName (const std::string &comp_name) const
	Checks that the component of a certain type exists.
template<typename... Args>
void	logError (Args &&... args) const
	Logs an error.
template<typename... Args>
void	logWarning (Args &&... args) const
	Logs a warning.
void	addDependency (const std::string &dependency)
	Adds a component name to the list of dependencies.
template<typename T >
T	getEnumParam (const std::string &param, bool log_error=true) const
	Gets an enum parameter.
bool	problemIsTransient () const
	Whether the problem is transient.
const std::vector< dof_id_type > &	getNodeIDs () const
	Gets the node IDs corresponding to this component.
const std::vector< dof_id_type > &	getElementIDs () const
	Gets the element IDs corresponding to this component.
virtual const std::vector< SubdomainName > &	getSubdomainNames () const
	Gets the subdomain names for this component.
virtual const std::vector< Moose::CoordinateSystemType > &	getCoordSysTypes () const
	Gets the coordinate system types for this component.
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.
template<typename T >
void	checkParameterValueLessThan (const std::string &param, const T &value_max) const
	Checks that a parameter value is less than a value.
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.
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.
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.
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.
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.
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.
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.
virtual bool	enabled () const
std::shared_ptr< MooseObject >	getSharedPtr ()
std::shared_ptr< const MooseObject >	getSharedPtr () const
bool	isKokkosObject () const
MooseApp &	getMooseApp () const
const std::string &	type () const
const std::string &	name () const
std::string	typeAndName () const
MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
MooseObjectName	uniqueName () const
const InputParameters &	parameters () const
const hit::Node *	getHitNode () const
bool	hasBase () const
const std::string &	getBase () const
const T &	getParam (const std::string &name) const
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
const T *	queryParam (const std::string &name) const
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
bool	isParamValid (const std::string &name) const
bool	isParamSetByUser (const std::string &name) const
void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
void	paramError (const std::string &param, Args... args) const
void	paramWarning (const std::string &param, Args... args) const
void	paramWarning (const std::string &param, Args... args) const
void	paramInfo (const std::string &param, Args... args) const
std::string	messagePrefix (const bool hit_prefix=true) const
std::string	errorPrefix (const std::string &) const
void	mooseError (Args &&... args) const
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
void	mooseErrorNonPrefixed (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseDeprecatedNoTrace (Args &&... args) const
void	mooseInfo (Args &&... args) const
void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
std::string	getDataFileName (const std::string &param) const
std::string	getDataFileNameByName (const std::string &relative_path) const
std::string	getDataFilePath (const std::string &relative_path) const
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.
template<typename... Args>
void	logComponentWarning (const std::string &component_name, Args &&... args) const
	Logs a warning for a component.
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.
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.
std::string	genName (const std::string &prefix, const std::string &name, unsigned int i) const
	Build a name from 2 strings and a number.
std::string	genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings.
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.
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)
virtual void	checkShaftConnection (const Component *const component) const
virtual VariableName	getMomentofInertiaVariableName () const
virtual VariableName	getTorqueVariableName () const
virtual UserObjectName	getShaftConnectedUserObjectName () const
virtual void	setShaftName (const std::string &name) const

Static Public Member Functions
static InputParameters	validParams ()
static void	callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings
const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param
static const std::string	name_param
static const std::string	unique_name_param
static const std::string	app_param
static const std::string	moose_base_param
static const std::string	kokkos_object_param

Protected Member Functions
virtual void	check () const override
	Check the component integrity.
virtual void	init ()
	Initializes the component.
virtual void	initSecondary ()
	Perform secondary initialization, which relies on init() being called for all components.
virtual void	setupMesh ()
	Performs mesh setup such as creating mesh or naming mesh sets.
void	addRelationshipManagersFromParameters (const InputParameters &moose_object_pars)
	Method to add a relationship manager for the objects being added to the system.
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.
void	addNonlinearStepFunctorMaterial (const std::string &functor_name, const std::string &property, bool functor_is_ad)
	Adds a functor material to compute the absolute value of the change (step) of some functor between nonlinear iterations.
void	addMaximumFunctorPostprocessor (const std::string &functor_name, const std::string &pp_name, const Real normalization, const std::vector< SubdomainName > &subdomains)
	Adds a Postprocessor to compute the maximum of a functor over some domain.
void	addMultiPostprocessorConvergence (const std::vector< PostprocessorName > &postprocessors, const std::vector< std::string > &descriptions, const std::vector< Real > &tolerances)
	Adds a MultiPostprocessorConvergence for nonlinear convergence for the component.
std::string	nonlinearConvergenceName () const
	Nonlinear Convergence name.
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.
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.
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const
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)
const Moose::Functor< T > &	getFunctorByName (const std::string &name)

Protected Attributes
const FunctionName &	_torque_fn_name
	Torque function name.
const FunctionName &	_inertia_fn_name
	Moment of inertia function name.
Component *	_parent
	Pointer to a parent component (used in composed components)
THMProblem &	_sim
	THM problem this component is part of TODO: make _sim private (applications need to switch to getters to avoid breaking).
Factory &	_factory
	The Factory associated with the MooseApp.
const Real &	_zero
THMMesh &	_mesh
	The THM mesh TODO: make _mesh private (applications need to switch to getters to avoid breaking)
std::vector< dof_id_type >	_node_ids
	Node IDs of this component.
std::vector< dof_id_type >	_elem_ids
	Element IDs of this component.
std::vector< SubdomainID >	_subdomain_ids
	List of subdomain IDs this components owns.
std::vector< SubdomainName >	_subdomain_names
	List of subdomain names this components owns.
std::vector< Moose::CoordinateSystemType >	_coord_sys
	List of coordinate system for each subdomain.
const bool &	_enabled
MooseApp &	_app
ActionFactory &	_action_factory
const std::string &	_type
const std::string &	_name
const InputParameters &	_pars
const Parallel::Communicator &	_communicator
Logger &	_log
VariableName	_moment_of_inertia_var_name
	Moment of inertia variable name.
VariableName	_torque_var_name
	Torque of variable name.
UserObjectName	_user_object_name
	Shaft-connectable user object name.
std::string	_shaft_name
	Name of the shaft component.
bool	_connected_to_shaft
	Flag indicating that a shaft has this component connected.

Private Member Functions
void	addRelationshipManager (const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)
	Method for adding a single relationship manager.
const Moose::Functor< T > *	defaultFunctor (const std::string &name)
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)
const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
virtual bool	isADObject () const override

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
EComponentSetupStatus	_component_setup_status
	Component setup status.
std::vector< std::string >	_dependencies
	List of names of components that this component depends upon.
const MooseBase &	_si_moose_base
const FEProblemBase *	_si_problem
const InputParameters &	_fi_params
const std::string	_fi_name
SubProblem *const	_fi_subproblem
const THREAD_ID	_fi_tid
std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors
std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors

Detailed Description

Motor to drive a shaft component.

Definition at line 18 of file ShaftConnectedMotor.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 37 of file Component.h.

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

Constructor & Destructor Documentation

ShaftConnectedMotor()

ShaftConnectedMotor::ShaftConnectedMotor

(

const InputParameters &

params

)

Definition at line 27 of file ShaftConnectedMotor.C.

  : Component(parameters),
    ShaftConnectable(this),
    _torque_fn_name(getParam<FunctionName>("torque")),
    _inertia_fn_name(getParam<FunctionName>("inertia"))
{
}

Member Function Documentation

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.

{
  _dependencies.push_back(dependency);
}

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

addMaximumFunctorPostprocessor()

void Component::addMaximumFunctorPostprocessor ( const std::string &  functor_name, const std::string &  pp_name, const Real  normalization, const std::vector< SubdomainName > &  subdomains  )

protectedinherited

Adds a Postprocessor to compute the maximum of a functor over some domain.

Parameters

[in]	functor_name	Functor for which to compute maximum
[in]	pp_name	Name of new Postprocessor
[in]	normalization	Factor by which to divide quantity
[in]	subdomains	Subdomains over which to compute maximum

Definition at line 252 of file Component.C.

{
  const std::string class_name = "ElementExtremeFunctorValue";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = subdomains;
  params.set<MooseEnum>("value_type") = "max";
  params.set<MooseFunctorName>("functor") = functor_name;
  params.set<Real>("scale") = 1.0 / normalization;
  params.set<ExecFlagEnum>("execute_on") = EXEC_NONLINEAR_CONVERGENCE;
  params.set<std::vector<OutputName>>("outputs") = {"none"};
  getTHMProblem().addPostprocessor(class_name, pp_name, params);
}

Referenced by FlowChannel1Phase::addMooseObjects(), and HeatStructureBase::addMooseObjects().

addMooseObjects()

void ShaftConnectedMotor::addMooseObjects ( )

overridevirtual

Reimplemented from Component.

Definition at line 47 of file ShaftConnectedMotor.C.

{
  const Shaft & shaft = getComponentByName<Shaft>(_shaft_name);
  const VariableName shaft_speed_var_name = shaft.getOmegaVariableName();
 
  const UserObjectName & uo_name = getShaftConnectedUserObjectName();
  if (getParam<bool>("ad"))
  {
    std::string class_name = "ADShaftConnectedMotorUserObject";
    InputParameters params = _factory.getValidParams(class_name);
    params.set<FunctionName>("torque") = _torque_fn_name;
    params.set<FunctionName>("inertia") = _inertia_fn_name;
    params.set<std::vector<VariableName>>("shaft_speed") = {shaft_speed_var_name};
    getTHMProblem().addUserObject(class_name, uo_name, params);
  }
  else
  {
    std::string class_name = "ShaftConnectedMotorUserObject";
    InputParameters params = _factory.getValidParams(class_name);
    params.set<FunctionName>("torque") = _torque_fn_name;
    params.set<FunctionName>("inertia") = _inertia_fn_name;
    params.set<std::vector<VariableName>>("shaft_speed") = {shaft_speed_var_name};
    getTHMProblem().addUserObject(class_name, uo_name, params);
  }
}

addMultiPostprocessorConvergence()

void Component::addMultiPostprocessorConvergence ( const std::vector< PostprocessorName > &  postprocessors, const std::vector< std::string > &  descriptions, const std::vector< Real > &  tolerances  )

protectedinherited

Adds a MultiPostprocessorConvergence for nonlinear convergence for the component.

Parameters

[in]	postprocessors	Postprocessors to compare
[in]	descriptions	Description of each Postprocessor
[in]	tolerances	Tolerance for each check

Definition at line 269 of file Component.C.

{
  const std::string class_name = "MultiPostprocessorConvergence";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<PostprocessorName>>("postprocessors") = postprocessors;
  params.set<std::vector<std::string>>("descriptions") = descriptions;
  params.set<std::vector<Real>>("tolerances") = tolerances;
  params.set<unsigned int>("min_iterations") = 1;
  params.set<unsigned int>("max_iterations") = std::numeric_limits<unsigned int>::max();
  getTHMProblem().addConvergence(class_name, nonlinearConvergenceName(), params);
}

Referenced by FlowChannel1Phase::addMooseObjects(), and HeatStructureBase::addMooseObjects().

addNode()

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

protectedinherited

Definition at line 203 of file Component.C.

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

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

addNodeElement()

Elem * Component::addNodeElement ( dof_id_type  node )

protectedinherited

Definition at line 211 of file Component.C.

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

Referenced by VolumeJunction1Phase::setupMesh().

addNonlinearStepFunctorMaterial()

void Component::addNonlinearStepFunctorMaterial ( const std::string &  functor_name, const std::string &  property, bool  functor_is_ad  )

protectedinherited

Adds a functor material to compute the absolute value of the change (step) of some functor between nonlinear iterations.

Parameters

[in]	functor_name	Functor for which to compute step
[in]	property	Name of new step functor material property
[in]	functor_is_ad	Is the functor for which to compute the step AD?

Definition at line 236 of file Component.C.

{
  const std::string class_name =
      functor_is_ad ? "ADFunctorChangeFunctorMaterial" : "FunctorChangeFunctorMaterial";
  InputParameters params = _factory.getValidParams(class_name);
  params.set<std::vector<SubdomainName>>("block") = getSubdomainNames();
  params.set<MooseFunctorName>("functor") = functor_name;
  params.set<MooseEnum>("change_over") = "nonlinear";
  params.set<std::string>("prop_name") = property;
  params.set<bool>("take_absolute_value") = true;
  getTHMProblem().addFunctorMaterial(class_name, genName(name(), property + "_fmat"), params);
}

Referenced by FlowChannel1Phase::addMooseObjects(), and HeatStructureBase::addMooseObjects().

addRelationshipManager()

void Component::addRelationshipManager ( const InputParameters &  moose_object_pars, std::string  rm_name, Moose::RelationshipManagerType  rm_type, Moose::RelationshipManagerInputParameterCallback  rm_input_parameter_func, Moose::RMSystemType  sys_type = Moose::RMSystemType::NONE  )

privateinherited

Method for adding a single relationship manager.

This method was copied from Action.

Parameters

moose_object_pars	The parameters of the MooseObject that requested the RM
rm_name	The class type of the RM, e.g. ElementSideNeighborLayers
rm_type	The RelationshipManagerType, e.g. geometric, algebraic, coupling
rm_input_parameter_func	The RM callback function, typically a lambda defined in the requesting MooseObject's validParams function
sys_type	A RMSystemType that can be used to limit the systems and consequent dof_maps that the RM can be attached to

Definition at line 163 of file Component.C.

{
  // These need unique names
  static unsigned int unique_object_id = 0;
 
  auto new_name = moose_object_pars.getBase() + '_' + name() + '_' + rm_name + "_" +
                  Moose::stringify(rm_type) + " " + std::to_string(unique_object_id);
 
  auto rm_params = _factory.getValidParams(rm_name);
  rm_params.set<Moose::RelationshipManagerType>("rm_type") = rm_type;
 
  rm_params.set<std::string>("for_whom") = name();
 
  // If there is a callback for setting the RM parameters let's use it
  if (rm_input_parameter_func)
    rm_input_parameter_func(moose_object_pars, rm_params);
 
  rm_params.set<MooseMesh *>("mesh") = &_mesh;
 
  if (!rm_params.areAllRequiredParamsValid())
    mooseError("Missing required parameters for RelationshipManager " + rm_name + " for object " +
               name());
 
  auto rm_obj = _factory.create<RelationshipManager>(rm_name, new_name, rm_params);
 
  const bool added = _app.addRelationshipManager(rm_obj);
 
  // Delete the resources created on behalf of the RM if it ends up not being added to the App.
  if (!added)
    _factory.releaseSharedObjects(*rm_obj);
  else // we added it
    unique_object_id++;
}

Referenced by Component::addRelationshipManagersFromParameters().

addRelationshipManagers()

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

inlinevirtualinherited

Adds relationship managers for the component.

Reimplemented in FileMeshPhysicsComponent.

Definition at line 111 of file Component.h.

{}

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 148 of file Component.C.

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

Referenced by FileMeshPhysicsComponent::addRelationshipManagers().

addVariables()

void ShaftConnectedMotor::addVariables ( )

overridevirtual

Reimplemented from Component.

Definition at line 42 of file ShaftConnectedMotor.C.

{
}

check()

void ShaftConnectedMotor::check ( ) const

overrideprotectedvirtual

Check the component integrity.

Reimplemented from Component.

Definition at line 36 of file ShaftConnectedMotor.C.

{
  checkShaftConnection(this);
}

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 141 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 636 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 646 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

inherited

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 702 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

inherited

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 284 of file Component.C.

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

checkParameterValueLessThan()

template<typename T >

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

inherited

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

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

Referenced by FlowChannelBase::getAreaFunctionName(), Component2D::getBoundaryArea(), Component2D::getBoundaryInfo(), 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(), Component::getNodeIDs(), Component1DConnection::getNodeIDs(), Component1D::getNodesetID(), Component1D::getNodesetName(), Component::getSubdomainNames(), HeatTransfer1PhaseBase::getWallHeatTransferCoefficient1PhaseName(), HeatTransferBase::getWallTemperatureMatName(), HeatTransferBase::getWallTemperatureName(), Component2D::hasBoundary(), FileMeshComponent::hasBoundary(), Component2D::hasExternalBoundary(), and HeatStructureFromFile3D::hasRegion().

checkShaftConnection()

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

virtualinherited

Definition at line 29 of file ShaftConnectable.C.

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

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

checkSizeEqualsParameterValue()

template<typename T1 , typename T2 >

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

inherited

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 760 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

inherited

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 723 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

inherited

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 739 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

inherited

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 686 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

inherited

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

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

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

connectObject() [1/2]

void Component::connectObject ( const InputParameters &  obj_params, const std::string &  obj_name, const std::string &  comp_param, const std::string &  obj_param  ) const

inherited

Connects a controllable parameter of the component to a controllable parameter of a constituent object.

This is achieved by creating a "controllable parameter alias".

Parameters

[in]	obj_params	Constituent object input parameters object
[in]	obj_name	Constituent object name
[in]	comp_param	Controllable component parameter
[in]	obj_param	Constituent object parameter

Definition at line 106 of file Component.C.

{
  MooseObjectParameterName alias("component", this->name(), comp_param, "::");
  MooseObjectParameterName obj_controlled_param(obj_params.getBase(), obj_name, obj_param);
  _app.getInputParameterWarehouse().addControllableParameterAlias(alias, obj_controlled_param);
}

connectObject() [2/2]

void Component::connectObject ( const InputParameters &  obj_params, const std::string &  obj_name, const std::string &  param  ) const

inherited

Connects a controllable parameter of the component to a controllable parameter of a constituent object.

This version assumes that the component and object have the same control parameter name.

Parameters

[in]	obj_params	Constituent object input parameters object
[in]	obj_name	Constituent object name
[in]	param	Controllable parameter name (same in both component and constituent object)

Definition at line 98 of file Component.C.

{
  connectObject(obj_params, obj_name, param, param);
}

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

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 63 of file Component.h.

{ return _mesh; }

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

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

Referenced by Simulation::integrityCheck().

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, 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();
  }

genName() [2/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() [3/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() [4/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();
  }

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FlowModel::addCommonInitialConditions(), FlowModel::addCommonMooseObjects(), FlowChannelBase::addCommonObjects(), Simulation::addComponentScalarIC(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), Simulation::addConstantIC(), Simulation::addConstantScalarIC(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowChannel1Phase::addFlowChannel1PhaseFunctorMaterial(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), VolumeJunctionCoupledFlux1Phase::addFluxTransfer(), FlowModel1PhaseBase::addFunctionIC(), Simulation::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), HeatTransferBase::addHeatedPerimeter(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowChannel1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Shaft::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), Component::addNonlinearStepFunctorMaterial(), FlowChannel1Phase::addNormalized1PhaseResidualNorm(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), VolumeJunctionCoupledFlux1Phase::addPropertyTransfer(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowChannelBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), VolumeJunctionCoupledFlux1Phase::addVolumeJunctionKernel(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), ClosuresBase::addWeightedAverageMaterial(), FlowModelGasMix::addXiRhoAIC(), ClosuresBase::addZeroMaterial(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), Component2D::buildMesh(), HeatSourceBase::HeatSourceBase(), Component::nonlinearConvergenceName(), and Simulation::setupInitialConditionsFromFile().

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.

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

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

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 557 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 565 of file Component.h.

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

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 353 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 86 of file Component.h.

{ return _dependencies; }

getElementIDs()

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

inherited

Gets the element IDs corresponding to this component.

Definition at line 337 of file Component.C.

{
  checkSetupStatus(MESH_PREPARED);
 
  return _elem_ids;
}

Referenced by HeatTransferFromHeatStructure1Phase::setupMesh(), and HeatTransferFromHeatStructure3D1Phase::setupMesh().

getEnumParam()

template<typename T >

T Component::getEnumParam ( const std::string &  param, bool  log_error = true  ) 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
[in]	log_error	If true, log an error if the valid is invalid

Definition at line 590 of file Component.h.

{
  const MooseEnum & moose_enum = getParam<MooseEnum>(param);
  const T value = THM::stringToEnum<T>(moose_enum);
  if (log_error && 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;
}

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 > & Component::getNodeIDs ( ) const

inherited

Gets the node IDs corresponding to this component.

Definition at line 329 of file Component.C.

{
  checkSetupStatus(MESH_PREPARED);
 
  return _node_ids;
}

getNonlinearConvergence()

Convergence * Component::getNonlinearConvergence ( ) const

virtualinherited

Gets the Component's nonlinear Convergence object if it has one.

Reimplemented in BoundaryBase, Component1DBoundary, FlowChannel1Phase, HeatSourceBase, HeatStructureBase, HeatTransferBase, JunctionOneToOne1Phase, and TotalPower.

Definition at line 361 of file Component.C.

{
  mooseError("getNonlinearConvergence() not implemented.");
}

getShaftConnectedUserObjectName()

UserObjectName ShaftConnectable::getShaftConnectedUserObjectName ( ) const

virtualinherited

Reimplemented in ShaftConnectedCompressor1Phase, ShaftConnectedPump1Phase, and ShaftConnectedTurbine1Phase.

Definition at line 48 of file ShaftConnectable.C.

{
  return _user_object_name;
}

Referenced by Shaft::addMooseObjects(), and addMooseObjects().

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 345 of file Component.C.

{
  checkSetupStatus(MESH_PREPARED);
 
  return _subdomain_names;
}

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FlowModel::addCommonInitialConditions(), FlowModel::addCommonMooseObjects(), FlowChannelBase::addCommonObjects(), FlowModel::addCommonVariables(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), FlowModel1PhaseBase::addDensityAux(), FlowModelGasMix::addDensityIC(), FlowModelSinglePhase::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowChannel1Phase::addFlowChannel1PhaseFunctorMaterial(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), FlowModel1PhaseBase::addHeatConductionDGKernel(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), HeatConductionModel::addInitialConditions(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FlowChannel1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatStructureBase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), Component::addNonlinearStepFunctorMaterial(), FlowChannel1Phase::addNormalized1PhaseResidualNorm(), FlowChannel1Phase::addNumericalFluxVectorPostprocessor(), FlowModelSinglePhase::addPassiveTransportIC(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelGasMix::addRhoEAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelGasMix::addTemperatureAux(), FlowModelSinglePhase::addTemperatureAux(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), HeatConductionModel::addVariables(), FlowModel1PhaseBase::addVariables(), FlowModelGasMix::addVariables(), FlowModelSinglePhase::addVariables(), FlowChannelBase::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), HSBoundaryExternalAppTemperature::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), ClosuresBase::addWeightedAverageMaterial(), FlowModelGasMix::addXiRhoAIC(), ClosuresBase::addZeroMaterial(), FileMeshPhysicsComponent::getBlocks(), Component1DConnection::init(), FileMeshPhysicsComponent::init(), FormLoss1PhaseBase::init(), HeatTransferBase::init(), and HeatTransferFromHeatStructure3D1Phase::init().

getTHMProblem()

THMProblem & Component::getTHMProblem ( ) const

inherited

Gets the THM problem.

Definition at line 135 of file Component.C.

{
  return _sim;
}

Referenced by HeatStructureBase::addAverageElementSizePostprocessor(), FlowChannelBase::addCommonObjects(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), FlowChannel1Phase::addFlowChannel1PhaseFunctorMaterial(), VolumeJunctionCoupledFlux1Phase::addFluxPostprocessor(), VolumeJunctionCoupledFlux1Phase::addFluxTransfer(), HeatTransferBase::addHeatedPerimeter(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), Component::addMaximumFunctorPostprocessor(), FlowChannelBase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), Shaft::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), SolidWall1Phase::addMooseObjects(), SolidWallGasMix::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), InletFunction1Phase::addMooseObjects(), Component::addMultiPostprocessorConvergence(), Component::addNonlinearStepFunctorMaterial(), FlowChannel1Phase::addNormalized1PhaseResidualNorm(), FlowChannel1Phase::addNumericalFluxVectorPostprocessor(), VolumeJunctionCoupledFlux1Phase::addPropertyPostprocessor(), VolumeJunctionCoupledFlux1Phase::addPropertyTransfer(), HeatStructureBase::addResidualNormPostprocessor(), FlowChannelBase::addVariables(), FormLossFromExternalApp1Phase::addVariables(), HeatTransferFromExternalAppHeatFlux1Phase::addVariables(), HeatTransferFromExternalAppTemperature1Phase::addVariables(), HeatTransferFromHeatStructure1Phase::addVariables(), HeatTransferFromHeatStructure3D1Phase::addVariables(), HeatTransferFromSpecifiedTemperature1Phase::addVariables(), HeatTransferFromTemperature1Phase::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), HSBoundaryExternalAppTemperature::addVariables(), Shaft::addVariables(), TotalPower::addVariables(), TotalPowerBase::addVariables(), VolumeJunction1Phase::addVolumeJunctionIC(), VolumeJunctionCoupledFlux1Phase::addVolumeJunctionKernel(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), FlowChannel1PhaseBase::buildFlowModel(), HeatStructureInterface::buildModel(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), Pump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), HeatStructureInterface::check(), FlowChannel1PhaseBase::check(), Shaft::check(), VolumeJunction1Phase::check(), FlowChannel1Phase::checkFluidProperties(), FlowChannelGasMix::checkFluidProperties(), FlowChannel1Phase::getNonlinearConvergence(), HeatStructureBase::getNonlinearConvergence(), GeometricalComponent::getVariableFn(), Component1DConnection::init(), FlowBoundary::init(), FlowBoundary1PhaseBase::init(), FlowChannelBase::init(), FlowJunction::init(), FlowJunction1Phase::init(), Component::problemIsTransient(), GateValve1Phase::setupMesh(), HeatStructure2DCouplerBase::setupMesh(), HeatTransferFromHeatStructure1Phase::setupMesh(), HeatTransferFromHeatStructure3D1Phase::setupMesh(), HSCoupler2D2DRadiation::setupMesh(), HSCoupler2D3D::setupMesh(), JunctionOneToOne1Phase::setupMesh(), and VolumeJunction1Phase::setupMesh().

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 572 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 580 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 550 of file Component.h.

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

init()

virtual void Component::init ( )

inlineprotectedvirtualinherited

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 in Component1DConnection, FileMeshPhysicsComponent, FlowBoundary, FlowBoundary1Phase, FlowBoundary1PhaseBase, FlowChannel1PhaseBase, FlowChannelBase, FlowJunction, FlowJunction1Phase, FormLoss1PhaseBase, HeatSourceFromTotalPower, HeatStructure2DCouplerBase, HeatStructure2DRadiationCouplerRZ, HeatStructureBase, HeatStructureFromFile3D, HeatTransfer1PhaseBase, HeatTransferBase, HeatTransferFromHeatStructure3D1Phase, JunctionOneToOne1Phase, Shaft, and TestSetupStatusComponent.

Definition at line 405 of file Component.h.

{}

Referenced by Component::executeInit(), Component1DConnection::init(), FileMeshPhysicsComponent::init(), FlowBoundary::init(), FlowChannelBase::init(), FlowJunction::init(), FormLoss1PhaseBase::init(), HeatSourceFromTotalPower::init(), HeatStructure2DCouplerBase::init(), HeatStructureBase::init(), HeatStructureFromFile3D::init(), HeatTransferBase::init(), HeatTransferFromHeatStructure3D1Phase::init(), and Shaft::init().

initSecondary()

virtual void Component::initSecondary ( )

inlineprotectedvirtualinherited

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

Reimplemented in Component1DJunction, FlowChannelBase, HeatTransfer1PhaseBase, HeatTransferBase, HeatTransferFromExternalAppTemperature1Phase, and HeatTransferFromHeatStructure3D1Phase.

Definition at line 411 of file Component.h.

{}

Referenced by Component::executeInitSecondary(), Component1DJunction::initSecondary(), FlowChannelBase::initSecondary(), HeatTransferBase::initSecondary(), HeatTransferFromExternalAppTemperature1Phase::initSecondary(), and HeatTransferFromHeatStructure3D1Phase::initSecondary().

insistParameterExists()

template<typename T >

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

inherited

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

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.

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

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

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.

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

Referenced by Component::logWarning().

logError()

template<typename... Args>

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

inlineinherited

Logs an error.

Definition at line 226 of file Component.h.

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

Referenced by Component1DConnection::addConnection(), HeatStructureInterface::check(), Component1DJunction::check(), Component2D::check(), FlowBoundary1Phase::check(), FlowChannel1PhaseBase::check(), FlowChannelBase::check(), FlowJunction1Phase::check(), GeneratedMeshComponent::check(), HeatSourceBase::check(), HeatStructure2DCoupler::check(), HeatStructure2DCouplerBase::check(), HeatStructure2DRadiationCouplerRZ::check(), HeatTransferFromExternalAppTemperature1Phase::check(), HeatTransferFromHeatStructure3D1Phase::check(), HSBoundary::check(), HSBoundaryExternalAppHeatFlux::check(), HSCoupler2D2DRadiation::check(), HSCoupler2D3D::check(), InletDensityVelocity1Phase::check(), InletMassFlowRateTemperature1Phase::check(), InletStagnationEnthalpyMomentum1Phase::check(), InletStagnationPressureTemperature1Phase::check(), InletVelocityTemperature1Phase::check(), Outlet1Phase::check(), Shaft::check(), VolumeJunction1Phase::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::checkSizeEqualsValue(), Component::checkSizeGreaterThan(), Component::checkSizeLessThan(), ElbowPipe1Phase::ElbowPipe1Phase(), Component::getEnumParam(), HeatTransferFromHeatStructure3D1Phase::getFlowChannelAxisAlignment(), HeatStructureFromFile3D::HeatStructureFromFile3D(), Component1DConnection::init(), FlowJunction1Phase::init(), HeatTransferFromHeatStructure3D1Phase::init(), HeatTransfer1PhaseBase::initSecondary(), LoggerTestComponent::LoggerTestComponent(), Component1DConnection::setupMesh(), and HeatTransferFromHeatStructure1Phase::setupMesh().

logWarning()

template<typename... Args>

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

inlineinherited

Logs a warning.

Definition at line 235 of file Component.h.

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

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

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.

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

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

nonlinearConvergenceName()

std::string Component::nonlinearConvergenceName ( ) const

inlineprotectedinherited

Nonlinear Convergence name.

Definition at line 486 of file Component.h.

{ return genName(name(), "nlconv"); }

Referenced by Component::addMultiPostprocessorConvergence(), FlowChannel1Phase::getNonlinearConvergence(), and HeatStructureBase::getNonlinearConvergence().

parent()

Component * Component::parent ( )

inlineinherited

Definition at line 55 of file Component.h.

{ return _parent; }

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 264 of file Component.h.

{ return getTHMProblem().isTransient(); }

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

setShaftName()

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

virtualinherited

Definition at line 54 of file ShaftConnectable.C.

{
  _shaft_name = name;
  _connected_to_shaft = true;
}

Referenced by Shaft::init().

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 219 of file Component.C.

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

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

setupMesh()

virtual void Component::setupMesh ( )

inlineprotectedvirtualinherited

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

Reimplemented in Component1DBoundary, Component1DConnection, Component1DJunction, FileMeshComponent, GateValve1Phase, GeneratedMeshComponent, HeatStructure2DCouplerBase, HeatStructureCylindricalBase, HeatStructureFromFile3D, HeatTransferFromHeatStructure1Phase, HeatTransferFromHeatStructure3D1Phase, HSCoupler2D2DRadiation, HSCoupler2D3D, JunctionOneToOne1Phase, and VolumeJunction1Phase.

Definition at line 421 of file Component.h.

{}

Referenced by Component::executeSetupMesh(), GateValve1Phase::setupMesh(), HeatStructure2DCouplerBase::setupMesh(), HeatStructureCylindricalBase::setupMesh(), HSCoupler2D2DRadiation::setupMesh(), HSCoupler2D3D::setupMesh(), JunctionOneToOne1Phase::setupMesh(), and VolumeJunction1Phase::setupMesh().

stringify()

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

inherited

Return a string for the setup status.

Definition at line 309 of file Component.C.

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

Referenced by Component::checkSetupStatus().

validParams()

InputParameters ShaftConnectedMotor::validParams ( )

static

Definition at line 16 of file ShaftConnectedMotor.C.

{
  InputParameters params = Component::validParams();
  params += ShaftConnectable::validParams();
  params.addRequiredParam<FunctionName>("torque", "Driving torque supplied by the motor [kg-m^2]");
  params.addRequiredParam<FunctionName>("inertia", "Moment of inertia from the motor [N-m]");
  params.addParam<bool>("ad", true, "Use AD version or not");
  params.addClassDescription("Motor to drive a shaft component");
  return params;
}

Member Data Documentation

_component_setup_status

EComponentSetupStatus Component::_component_setup_status

mutableprivateinherited

Component setup status.

Definition at line 539 of file Component.h.

Referenced by Component::checkSetupStatus(), Component::executeCheck(), Component::executeInit(), Component::executeInitSecondary(), Component::executeSetupMesh(), and Component::mesh().

_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().

_coord_sys

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

protectedinherited

List of coordinate system for each subdomain.

Definition at line 515 of file Component.h.

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

_dependencies

std::vector<std::string> Component::_dependencies

privateinherited

List of names of components that this component depends upon.

Definition at line 542 of file Component.h.

Referenced by Component::addDependency(), and Component::getDependencies().

_elem_ids

std::vector<dof_id_type> Component::_elem_ids

protectedinherited

Element IDs of this component.

Definition at line 508 of file Component.h.

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

_factory

Factory& Component::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 497 of file Component.h.

Referenced by HeatStructureBase::addAverageElementSizePostprocessor(), FlowChannelBase::addCommonObjects(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), FlowChannel1Phase::addFlowChannel1PhaseFunctorMaterial(), VolumeJunctionCoupledFlux1Phase::addFluxPostprocessor(), VolumeJunctionCoupledFlux1Phase::addFluxTransfer(), HeatTransferBase::addHeatedPerimeter(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), Component::addMaximumFunctorPostprocessor(), FlowChannelBase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), Shaft::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), SolidWall1Phase::addMooseObjects(), SolidWallGasMix::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), InletFunction1Phase::addMooseObjects(), Component::addMultiPostprocessorConvergence(), Component::addNonlinearStepFunctorMaterial(), FlowChannel1Phase::addNormalized1PhaseResidualNorm(), FlowChannel1Phase::addNumericalFluxVectorPostprocessor(), VolumeJunctionCoupledFlux1Phase::addPropertyPostprocessor(), VolumeJunctionCoupledFlux1Phase::addPropertyTransfer(), Component::addRelationshipManager(), HeatStructureBase::addResidualNormPostprocessor(), FlowChannelBase::addVariables(), VolumeJunction1Phase::addVolumeJunctionIC(), VolumeJunctionCoupledFlux1Phase::addVolumeJunctionKernel(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), FlowChannel1PhaseBase::buildFlowModel(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), Pump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and SimpleTurbine1Phase::buildVolumeJunctionUserObject().

_inertia_fn_name

const FunctionName& ShaftConnectedMotor::_inertia_fn_name

protected

Moment of inertia function name.

Definition at line 32 of file ShaftConnectedMotor.h.

Referenced by addMooseObjects().

_log

Logger& LoggingInterface::_log

protectedinherited

Definition at line 73 of file LoggingInterface.h.

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

_mesh

THMMesh& Component::_mesh

protectedinherited

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

Definition at line 503 of file Component.h.

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

_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 ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addVariables(), ShaftConnectedPump1Phase::addVariables(), ShaftConnectedTurbine1Phase::addVariables(), and ShaftConnectable::getMomentofInertiaVariableName().

_node_ids

std::vector<dof_id_type> Component::_node_ids

protectedinherited

Node IDs of this component.

Definition at line 506 of file Component.h.

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

_parent

Component* Component::_parent

protectedinherited

Pointer to a parent component (used in composed components)

Definition at line 489 of file Component.h.

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

_shaft_name

std::string ShaftConnectable::_shaft_name

mutableprotectedinherited

Name of the shaft component.

Definition at line 38 of file ShaftConnectable.h.

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

_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 494 of file Component.h.

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

_subdomain_ids

std::vector<SubdomainID> Component::_subdomain_ids

protectedinherited

List of subdomain IDs this components owns.

Definition at line 511 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 513 of file Component.h.

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

_torque_fn_name

const FunctionName& ShaftConnectedMotor::_torque_fn_name

protected

Torque function name.

Definition at line 30 of file ShaftConnectedMotor.h.

Referenced by addMooseObjects().

_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().

_zero

const Real& Component::_zero

protectedinherited

Definition at line 499 of file Component.h.

---

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

• thermal_hydraulics/include/components/ShaftConnectedMotor.h
• thermal_hydraulics/src/components/ShaftConnectedMotor.C