SolidWall Class Reference

A simple component for solid wall BC. More...

#include <SolidWall.h>

Inheritance diagram for SolidWall:

Public Types
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
	SolidWall (const InputParameters &params)
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...
virtual void	addVariables ()
virtual void	addMooseObjects ()
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 &	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...

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 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	init () override
	Initializes the component. More...
virtual void	check () const override
	Check the component integrity. More...
virtual void	setupMesh () override
	Performs mesh setup such as creating mesh or naming mesh sets. 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...
virtual void	initSecondary ()
	Perform secondary initialization, which relies on init() being called for all components. 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
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...
std::string	_connected_component_name
	Name of the connected component. More...
EEndType	_connected_component_end_type
	End type of the connected component. More...
const Elem *	_elem
	Element. More...
unsigned short int	_side
	Side ID. More...
dof_id_type	_node
	Node ID. More...
Real	_normal
	Outward normal on this boundary. More...
BoundaryName	_input
	Name of the boundary this component attaches to. 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

Detailed Description

A simple component for solid wall BC.

Deprecated

Definition at line 19 of file SolidWall.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 
  };

Constructor & Destructor Documentation

SolidWall()

SolidWall::SolidWall

(

const InputParameters &

params

)

Definition at line 23 of file SolidWall.C.

                                                   : FlowBoundary(params)
{
  logError("Deprecated component. Use SolidWall1Phase or SolidWall2Phase instead.");
}

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

addMooseObjects()

virtual void Component::addMooseObjects ( )

inlinevirtualinherited

Reimplemented in FlowChannelBase, FileMeshPhysicsComponent, JunctionOneToOne1Phase, HSBoundaryExternalAppHeatFlux, FlowChannel1Phase, HeatStructureFromFile3D, HeatTransferFromHeatStructure1Phase, HeatStructureBase, HeatTransferBase, HeatTransferFromHeatStructure3D1Phase, HSCoupler2D2DRadiation, HSCoupler2D3D, SimpleTurbine1Phase, FormLoss1PhaseBase, HeatTransferFromExternalAppHeatFlux1Phase, HSBoundaryExternalAppConvection, ShaftConnectedCompressor1Phase, ShaftConnectedMotor, ShaftConnectedPump1Phase, ShaftConnectedTurbine1Phase, FormLossFromExternalApp1Phase, FreeBoundary1Phase, GateValve1Phase, HeatSourceVolumetric1Phase, HeatTransferFromExternalAppTemperature1Phase, HeatTransferFromSpecifiedTemperature1Phase, HeatTransferFromTemperature1Phase, HSBoundaryExternalAppTemperature, Shaft, TotalPower, VolumeJunction1Phase, FormLossFromFunction1Phase, HeatSourceFromPowerDensity, HeatSourceFromTotalPower, HeatStructure2DCoupler, HeatStructure2DRadiationCouplerRZ, HeatTransfer1PhaseBase, HeatTransferFromHeatFlux1Phase, HSBoundaryAmbientConvection, HSBoundaryHeatFlux, HSBoundaryRadiation, HSBoundarySpecifiedTemperature, InletDensityVelocity1Phase, InletMassFlowRateTemperature1Phase, InletStagnationEnthalpyMomentum1Phase, InletStagnationPressureTemperature1Phase, InletVelocityTemperature1Phase, Outlet1Phase, SolidWall1Phase, SupersonicInlet, and InletFunction1Phase.

Definition at line 114 of file Component.h.

Referenced by HeatStructure2DCoupler::addMooseObjects(), and HeatStructure2DRadiationCouplerRZ::addMooseObjects().

{}

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.

{}

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

virtual void Component::addVariables ( )

inlinevirtualinherited

Reimplemented in FlowChannelBase, FileMeshPhysicsComponent, HSBoundaryExternalAppHeatFlux, HeatStructureFromFile3D, HeatTransferFromHeatStructure1Phase, HeatStructureBase, HeatTransferBase, HeatTransferFromHeatStructure3D1Phase, SimpleTurbine1Phase, HeatTransferFromExternalAppHeatFlux1Phase, HSBoundaryExternalAppConvection, ShaftConnectedCompressor1Phase, ShaftConnectedMotor, ShaftConnectedPump1Phase, ShaftConnectedTurbine1Phase, FormLossFromExternalApp1Phase, HeatTransferFromExternalAppTemperature1Phase, HeatTransferFromSpecifiedTemperature1Phase, HeatTransferFromTemperature1Phase, HSBoundaryExternalAppTemperature, Shaft, TotalPower, TotalPowerBase, and VolumeJunction1Phase.

Definition at line 112 of file Component.h.

{}

check()

void FlowBoundary::check ( ) const

overrideprotectedvirtualinherited

Check the component integrity.

Reimplemented from Component1DBoundary.

Reimplemented in InletDensityVelocity1Phase, InletMassFlowRateTemperature1Phase, InletStagnationEnthalpyMomentum1Phase, InletStagnationPressureTemperature1Phase, InletVelocityTemperature1Phase, Outlet1Phase, SupersonicInlet, and FlowBoundary1Phase.

Definition at line 43 of file FlowBoundary.C.

Referenced by FlowBoundary1Phase::check().

{
  Component1DBoundary::check();

  checkComponentOfTypeExistsByName<FlowChannelBase>(_connected_component_name);
}

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

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 ShaftConnectedCompressor1Phase::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(), InletVelocityTemperature1Phase::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), TotalPower::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), Closures1PhaseTHM::addWallFFMaterial(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::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().

{ return _mesh; }

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.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FlowModel::addCommonInitialConditions(), FlowModel::addCommonMooseObjects(), FlowChannelBase::addCommonObjects(), Simulation::addComponentScalarIC(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), Simulation::addConstantIC(), Simulation::addConstantScalarIC(), Simulation::addFunctionIC(), HeatTransferBase::addHeatedPerimeter(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1Phase::addHydraulicDiameterMaterial(), FlowModelSinglePhase::addInitialConditions(), HeatConductionModel::addMaterials(), FormLossFromFunction1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), Shaft::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HeatTransferBase::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), FlowModelSinglePhase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGMooseObjects(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), FlowChannelBase::addVariables(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), FlowBoundary1Phase::addWeakBC3Eqn(), ClosuresBase::addWeightedAverageMaterial(), ClosuresBase::addZeroMaterial(), Component2D::buildMesh(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), HeatSourceBase::HeatSourceBase(), VolumeJunction1Phase::junctionVariableName(), and Simulation::setupInitialConditionsFromFile().

  {
    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::addWeakBC3Eqn().

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

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

{ return _connections; }

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.

{ return _dependencies; }

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 & FlowBoundary::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 51 of file FlowBoundary.C.

{
  checkSetupStatus(INITIALIZED_PRIMARY);

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

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.

Referenced by Closures1PhaseBase::addAverageWallTemperatureMaterial(), FlowModel::addCommonInitialConditions(), FlowModel::addCommonMooseObjects(), FlowChannelBase::addCommonObjects(), FlowModel::addCommonVariables(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), FlowChannel1Phase::addHydraulicDiameterMaterial(), FlowModelSinglePhase::addInitialConditions(), HeatConductionModel::addInitialConditions(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), HeatConductionModel::addMaterials(), HeatSourceVolumetric1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), FlowModelSinglePhase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModelSinglePhase::addRDGMooseObjects(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), HSBoundaryExternalAppTemperature::addVariables(), FlowModelSinglePhase::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), HeatConductionModel::addVariables(), FlowChannelBase::addVariables(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), ClosuresBase::addWeightedAverageMaterial(), ClosuresBase::addZeroMaterial(), FileMeshPhysicsComponent::getBlocks(), FormLoss1PhaseBase::init(), FileMeshPhysicsComponent::init(), HeatTransferFromHeatStructure3D1Phase::init(), HeatTransferBase::init(), and Component1DConnection::init().

{
  checkSetupStatus(MESH_PREPARED);

  return _subdomain_names;
}

getTHMProblem()

THMProblem & Component::getTHMProblem ( ) const

inherited

Gets the THM problem.

Definition at line 135 of file Component.C.

Referenced by FlowChannelBase::addCommonObjects(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), HeatTransferBase::addHeatedPerimeter(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1Phase::addHydraulicDiameterMaterial(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), FormLossFromFunction1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), InletFunction1Phase::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), SolidWall1Phase::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), Shaft::addMooseObjects(), TotalPower::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedMotor::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), HeatStructureBase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), TotalPowerBase::addVariables(), VolumeJunction1Phase::addVariables(), HeatTransferFromExternalAppTemperature1Phase::addVariables(), HeatTransferFromSpecifiedTemperature1Phase::addVariables(), TotalPower::addVariables(), HeatTransferFromTemperature1Phase::addVariables(), HSBoundaryExternalAppTemperature::addVariables(), Shaft::addVariables(), FormLossFromExternalApp1Phase::addVariables(), HeatTransferFromExternalAppHeatFlux1Phase::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HeatTransferFromHeatStructure3D1Phase::addVariables(), HeatTransferFromHeatStructure1Phase::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), FlowChannelBase::addVariables(), FlowBoundary1Phase::addWeakBC3Eqn(), FlowChannel1Phase::buildFlowModel(), HeatStructureInterface::buildModel(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Shaft::check(), VolumeJunction1Phase::check(), FlowChannel1Phase::check(), HeatStructureInterface::check(), GeometricalComponent::getVariableFn(), FlowJunction1Phase::init(), FlowBoundary1Phase::init(), FlowJunction::init(), FlowBoundary::init(), FlowChannel1Phase::init(), Component1DConnection::init(), FlowChannelBase::init(), Component::problemIsTransient(), HeatStructure2DCouplerBase::setupMesh(), GateValve1Phase::setupMesh(), HSCoupler2D2DRadiation::setupMesh(), HSCoupler2D3D::setupMesh(), JunctionOneToOne1Phase::setupMesh(), HeatTransferFromHeatStructure1Phase::setupMesh(), VolumeJunction1Phase::setupMesh(), and HeatTransferFromHeatStructure3D1Phase::setupMesh().

{
  return _sim;
}

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 FlowBoundary::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 Component1DConnection.

Reimplemented in FlowBoundary1Phase.

Definition at line 26 of file FlowBoundary.C.

Referenced by FlowBoundary1Phase::init().

{
  Component1DBoundary::init();

  if (_connections.size() == 1)
    if (hasComponentByName<FlowChannelBase>(_connected_component_name))
    {
      const FlowChannelBase & comp =
          getTHMProblem().getComponentByName<FlowChannelBase>(_connected_component_name);

      _fp_name = comp.getFluidPropertiesName();
      _flow_model_id = comp.getFlowModelID();
      _flow_model = comp.getFlowModel();
    }
}

initSecondary()

virtual void Component::initSecondary ( )

inlineprotectedvirtualinherited

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

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

Definition at line 296 of file Component.h.

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

{}

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

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(), HeatStructure2DCoupler::check(), InletStagnationEnthalpyMomentum1Phase::check(), SupersonicInlet::check(), InletMassFlowRateTemperature1Phase::check(), InletVelocityTemperature1Phase::check(), HSBoundaryExternalAppHeatFlux::check(), InletDensityVelocity1Phase::check(), InletStagnationPressureTemperature1Phase::check(), Outlet1Phase::check(), HeatTransferFromExternalAppTemperature1Phase::check(), HeatStructure2DRadiationCouplerRZ::check(), GeneratedMeshComponent::check(), HeatStructure2DCouplerBase::check(), Shaft::check(), HSCoupler2D2DRadiation::check(), HSCoupler2D3D::check(), HeatTransferFromHeatStructure1Phase::check(), VolumeJunction1Phase::check(), HeatTransferFromHeatStructure3D1Phase::check(), FlowChannel1Phase::check(), HeatStructureInterface::check(), Component2D::check(), FlowChannelBase::check(), HSBoundary::checkAllComponent2DBoundariesAreExternal(), Component1DConnection::checkAllConnectionsHaveSame(), Component::checkComponentExistsByName(), Component::checkComponentOfTypeExistsByName(), Component::checkEqualSize(), 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(), FlowChannel1Phase::init(), Component1DConnection::init(), HeatTransfer1PhaseBase::initSecondary(), JunctionOneToOne::JunctionOneToOne(), LoggerTestComponent::LoggerTestComponent(), PrescribedReactorPower::PrescribedReactorPower(), Component1DConnection::setupMesh(), and 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(), FlowChannel1Phase::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(), Component1DBoundary::setupMesh(), Component1DJunction::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.

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

Referenced by HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), and FlowModelSinglePhase::addMooseObjects().

{ return getTHMProblem().isTransient(); }

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 Component1DBoundary::setupMesh ( )

overrideprotectedvirtualinherited

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

Reimplemented from Component1DConnection.

Definition at line 34 of file Component1DBoundary.C.

{
  Component1DConnection::setupMesh();

  if (_nodes.size() > 0)
  {
    _elem = _elems[0];
    _side = _sides[0];
    _node = _nodes[0];
    _normal = _normals[0];

    // create a sideset corresponding to the side of the connected component end
    const BoundaryID boundary_id = mesh().getNextBoundaryId();
    auto & binfo = mesh().getMesh().get_boundary_info();
    binfo.add_side(_elem, _side, boundary_id);
    binfo.sideset_name(boundary_id) = name();
  }
}

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 SolidWall::validParams ( )

static

Definition at line 15 of file SolidWall.C.

{
  InputParameters params = FlowBoundary::validParams();
  params.addClassDescription(
      "Adds the boundary condition for a wall. This component is deprecated.");
  return params;
}

Member Data Documentation

_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(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Component1DConnection::getBoundaryNames(), and Component1DConnection::setupMesh().

_connected_component_end_type

EEndType Component1DBoundary::_connected_component_end_type

protectedinherited

End type of the connected component.

Definition at line 29 of file Component1DBoundary.h.

Referenced by Component1DBoundary::Component1DBoundary().

_connected_component_name

std::string Component1DBoundary::_connected_component_name

protectedinherited

Name of the connected component.

Definition at line 27 of file Component1DBoundary.h.

Referenced by FlowBoundary1Phase::check(), FlowBoundary::check(), Component1DBoundary::Component1DBoundary(), FlowBoundary1Phase::init(), and FlowBoundary::init().

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

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

_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(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), and Component1DConnection::setupMesh().

_elem

const Elem* Component1DBoundary::_elem

protectedinherited

Element.

Definition at line 32 of file Component1DBoundary.h.

Referenced by Component1DBoundary::setupMesh().

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

Referenced by FlowChannelBase::addCommonObjects(), HeatStructureBase::addConstantDensitySolidPropertiesMaterial(), HeatTransferBase::addHeatedPerimeter(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1Phase::addHydraulicDiameterMaterial(), HSBoundaryRadiation::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), Outlet1Phase::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), SolidWall1Phase::addMooseObjects(), InletFunction1Phase::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), FormLossFromFunction1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), Shaft::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), ShaftConnectedMotor::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), Component::addRelationshipManager(), FlowChannelBase::addVariables(), FlowBoundary1Phase::addWeakBC3Eqn(), FlowChannel1Phase::buildFlowModel(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

_flow_model

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

protectedinherited

Flow model.

Definition at line 36 of file FlowBoundary.h.

Referenced by InletDensityVelocity1Phase::check(), Outlet1Phase::check(), InletMassFlowRateTemperature1Phase::check(), InletStagnationPressureTemperature1Phase::check(), InletVelocityTemperature1Phase::check(), and FlowBoundary::init().

_flow_model_id

THM::FlowModelID FlowBoundary::_flow_model_id

protectedinherited

Flow model ID.

Definition at line 34 of file FlowBoundary.h.

Referenced by FlowBoundary::init().

_fp_name

UserObjectName FlowBoundary::_fp_name

protectedinherited

Fluid property user object name.

Definition at line 38 of file FlowBoundary.h.

Referenced by InletDensityVelocity1Phase::addMooseObjects(), InletFunction1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), FlowBoundary::getFluidPropertiesName(), and FlowBoundary::init().

_input

BoundaryName Component1DBoundary::_input

protectedinherited

Name of the boundary this component attaches to.

Definition at line 40 of file Component1DBoundary.h.

Referenced by Component1DBoundary::Component1DBoundary().

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

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

_node

dof_id_type Component1DBoundary::_node

protectedinherited

Node ID.

Definition at line 36 of file Component1DBoundary.h.

Referenced by Component1DBoundary::setupMesh().

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

_normal

Real Component1DBoundary::_normal

protectedinherited

Outward normal on this boundary.

Definition at line 38 of file Component1DBoundary.h.

Referenced by InletDensityVelocity1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), SolidWall1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), FlowBoundary1Phase::addWeakBC3Eqn(), and Component1DBoundary::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(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Component1DBoundary::setupMesh(), and Component1DConnection::setupMesh().

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

_positions

std::vector<Point> Component1DConnection::_positions

protectedinherited

Physical positions of connected components.

Definition at line 133 of file Component1DConnection.h.

Referenced by Component1DConnection::setupMesh().

_side

unsigned short int Component1DBoundary::_side

protectedinherited

Side ID.

Definition at line 34 of file Component1DBoundary.h.

Referenced by Component1DBoundary::setupMesh().

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

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

_zero

const Real& Component::_zero

protectedinherited

Definition at line 448 of file Component.h.

---

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

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