Component2D Class Reference

#include <Component2D.h>

Inheritance diagram for Component2D:

Public Types
enum	ExternalBoundaryType { ExternalBoundaryType::INNER = 0, ExternalBoundaryType::OUTER = 1, ExternalBoundaryType::START = 2, ExternalBoundaryType::END = 3 }
	External boundary type. More...
enum	EComponentSetupStatus {   CREATED, MESH_PREPARED, INITIALIZED_PRIMARY, INITIALIZED_SECONDARY,   CHECKED }
	Component setup status type. More...
typedef DataFileName	DataFileParameterType

Public Member Functions
	Component2D (const InputParameters &params)
virtual void	buildMesh () override
const Real &	getTotalWidth () const
	Gets the total width of all transverse regions. More...
unsigned int	getNumRegions () const
	Gets the number of transverse regions. More...
bool	hasBlock (const std::string &name) const
	Returns true if there is a transverse region of a given name. More...
const std::vector< std::string > &	getNames () const
	Gets the names of the transverse regions. More...
const std::vector< Real > &	getVolumes () const
	Gets the volumes of the transverse regions. More...
bool	isBoundaryInVector (const BoundaryName &boundary_name, const std::vector< BoundaryName > &boundary_name_vector) const
	Returns true if the supplied boundary is in the given vector. More...
bool	hasBoundary (const BoundaryName &boundary_name) const
	Returns true if this component has the supplied boundary. More...
bool	hasExternalBoundary (const BoundaryName &boundary_name) const
	Returns true if this component has the supplied external boundary. More...
const std::vector< std::tuple< dof_id_type, unsigned short int > > &	getBoundaryInfo (const BoundaryName &boundary_name) const
	Gets boundary info associated with the component boundary. More...
const std::vector< std::tuple< dof_id_type, unsigned short int > > &	getBoundaryInfo (const ExternalBoundaryType &boundary_type) const
	Gets boundary info associated with a external boundary type. More...
ExternalBoundaryType	getExternalBoundaryType (const BoundaryName &boundary_name) const
	Gets the external boundary type of the given boundary. More...
Real	getAxialOffset () const
	Gets the axial offset for the mesh. More...
const BoundaryName &	getExternalBoundaryName (const ExternalBoundaryType &boundary_type) const
	Gets the name of an external boundary by type. More...
const Real &	getBoundaryArea (const BoundaryName &boundary_name) const
	Gets the area for a boundary. More...
virtual Real	computeRadialBoundaryArea (const Real &length, const Real &y) const =0
	Computes the area of a radial boundary. More...
virtual Real	computeAxialBoundaryArea (const Real &y_min, const Real &y_max) const =0
	Computes the area of an axial boundary. 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 > &	getNodeIDs () const
	Gets the node IDs corresponding to this component. More...
const std::vector< dof_id_type > &	getElementIDs () const
	Gets the element IDs corresponding to this component. More...
virtual const std::vector< SubdomainName > &	getSubdomainNames () const
	Gets the subdomain names for this component. More...
virtual const std::vector< Moose::CoordinateSystemType > &	getCoordSysTypes () const
	Gets the coordinate system types for this component. More...
virtual bool	enabled () const
std::shared_ptr< MooseObject >	getSharedPtr ()
std::shared_ptr< const MooseObject >	getSharedPtr () const
MooseApp &	getMooseApp () const
const std::string &	type () const
virtual const std::string &	name () const
std::string	typeAndName () const
std::string	errorPrefix (const std::string &error_type) const
void	callMooseError (std::string msg, const bool with_prefix) const
MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
const InputParameters &	parameters () const
MooseObjectName	uniqueName () const
const T &	getParam (const std::string &name) const
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
const T *	queryParam (const std::string &name) const
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
bool	isParamValid (const std::string &name) const
bool	isParamSetByUser (const std::string &nm) const
void	paramError (const std::string &param, Args... args) const
void	paramWarning (const std::string &param, Args... args) const
void	paramInfo (const std::string &param, Args... args) const
void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
void	mooseError (Args &&... args) const
void	mooseErrorNonPrefixed (Args &&... args) const
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
void	mooseWarning (Args &&... args) const
void	mooseWarningNonPrefixed (Args &&... args) const
void	mooseDeprecated (Args &&... args) const
void	mooseInfo (Args &&... args) const
std::string	getDataFileName (const std::string &param) const
std::string	getDataFileNameByName (const std::string &relative_path) const
std::string	getDataFilePath (const std::string &relative_path) const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const
template<typename... Args>
void	logComponentError (const std::string &component_name, Args &&... args) const
	Logs an error for a component. More...
template<typename... Args>
void	logComponentWarning (const std::string &component_name, Args &&... args) const
	Logs a warning for a component. More...
std::string	genName (const std::string &prefix, unsigned int id, const std::string &suffix="") const
	Build a name from a prefix, number and possible suffix. More...
std::string	genName (const std::string &prefix, unsigned int i, unsigned int j, const std::string &suffix="") const
	Build a name from a prefix, 2 numbers and possible suffix. More...
std::string	genName (const std::string &prefix, const std::string &name, unsigned int i) const
	Build a name from 2 strings and a number. More...
std::string	genName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings. More...
std::string	genSafeName (const std::string &prefix, const std::string &middle, const std::string &suffix="") const
	Build a name from strings that is safe to use in input files (i.e. More...
virtual Point	getPosition () const
virtual RealVectorValue	getDirection () const
virtual Real	getRotation () const
virtual Real	getNumElems () const
virtual Real	getLength () const
Real	computeAxialCoordinate (const Point &p) const
Real	computeRadialCoordinate (const Point &p) const
unsigned int	getAxialSectionIndex (const Point &p) const
unsigned int	getAxialElementIndex (const Point &p_center) const
Point	computeRealPointFromReferencePoint (const Point &p) const
	Computes point in 3-D space from a point in reference space. More...
Point	computeReferencePointFromRealPoint (const Point &p) const
	Computes point in reference space from a point in 3-D space. More...
MooseEnum	getAlignmentAxis () const
	Gets an axis MooseEnum for the axis the component is aligned with. More...
std::vector< Real >	getElementBoundaryCoordinates () const
	Gets the element boundary coordinates for the aligned axis. More...

Static Public Member Functions
static InputParameters	validParams ()
static MooseEnum	getExternalBoundaryTypeMooseEnum (const std::string &default_value="")
	Gets the MooseEnum corresponding to ExternalBoundaryType. More...
static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)
static Point	computeRealPointFromReferencePoint (const Point &p, const RealVectorValue &position, const RealTensorValue &R, const RealTensorValue &Rx)
	Computes point in 3-D space from a point in reference space. More...
static Point	computeReferencePointFromRealPoint (const Point &p, const RealVectorValue &position, const RealTensorValue &R_inv, const RealTensorValue &Rx_inv)
	Computes point in reference space from a point in 3-D space. More...
static MooseEnum	getAlignmentAxis (const RealVectorValue &dir)
	Gets an axis MooseEnum for the axis the component is aligned with. More...
static std::vector< Real >	getElementBoundaryCoordinates (const RealVectorValue &position, const RealVectorValue &orientation, const Real &rotation, const std::vector< Real > &lengths, const std::vector< unsigned int > &n_elems)
	Gets the element boundary coordinates for the aligned axis. More...
static RealTensorValue	computeDirectionTransformationTensor (const RealVectorValue &dir)
	Computes the direction transformation tensor. More...
static RealTensorValue	computeXRotationTransformationTensor (const Real &rotation)
	Computes the rotation transformation tensor. More...

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const std::map< std::string, ExternalBoundaryType >	_external_boundary_type_to_enum
	map of external boundary type string to enum More...

Protected Member Functions
virtual void	check () const override
	Check the component integrity. More...
void	build2DMesh ()
	Builds a 2D, first-order mesh. More...
void	build2DMesh2ndOrder ()
	Builds a 2D, second-order mesh. More...
virtual void	setupMesh () override
	Performs mesh setup such as creating mesh or naming mesh sets. More...
virtual bool	usingSecondOrderMesh () const =0
	Check if second order mesh is being used by this geometrical component. More...
Elem *	addElement (libMesh::ElemType elem_type, const std::vector< dof_id_type > &node_ids)
Elem *	addElementEdge2 (dof_id_type node0, dof_id_type node1)
Elem *	addElementEdge3 (dof_id_type node0, dof_id_type node1, dof_id_type node2)
Elem *	addElementQuad4 (dof_id_type node0, dof_id_type node1, dof_id_type node2, dof_id_type node3)
Elem *	addElementQuad9 (dof_id_type node0, dof_id_type node1, dof_id_type node2, dof_id_type node3, dof_id_type node4, dof_id_type node5, dof_id_type node6, dof_id_type node7, dof_id_type node8)
const FunctionName &	getVariableFn (const FunctionName &fn_param_name)
	Makes a constant function parameter controllable and returns its name. More...
virtual void	init ()
	Initializes the component. 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
unsigned int	_n_regions
	Number of transverse regions. More...
std::vector< std::string >	_names
	Names of each transverse region. More...
std::vector< Real >	_width
	Width of each transverse region. More...
Real	_total_width
	Total width of all transverse regions. More...
std::vector< Real >	_volume
	Volume of each transverse region. More...
std::vector< unsigned int >	_n_part_elems
	Number of elements in each transverse region. More...
unsigned int	_total_elem_number
	Total number of transverse elements. More...
unsigned int	_outer_bc_id
	BC ID of the component (outer) More...
unsigned int	_inner_bc_id
	BC ID of the component (inner) More...
unsigned int	_start_bc_id
	BC ID of the component (start) More...
unsigned int	_end_bc_id
	BC ID of the component (end) More...
std::vector< unsigned int >	_interior_axial_per_radial_section_bc_id
	BC ID of the interior axial boundaries (per radial section) of the component. More...
std::vector< unsigned int >	_axial_outer_bc_id
	BC ID of the axial regions of the outer boundary of the component. More...
std::vector< unsigned int >	_axial_inner_bc_id
	BC ID of the axial regions of the inner boundary of the component. More...
std::vector< unsigned int >	_radial_start_bc_id
	BC ID of the radial regions of the start boundary of the component. More...
std::vector< unsigned int >	_radial_end_bc_id
	BC ID of the radial regions of the end boundary of the component. More...
std::vector< unsigned int >	_inner_radial_bc_id
	BC ID of the inner radial boundary regions of the component. More...
BoundaryName	_boundary_name_outer
	Boundary name of the outer side of the component. More...
BoundaryName	_boundary_name_inner
	Boundary name of the inner side of the component. More...
BoundaryName	_boundary_name_start
	Boundary name of the start side of the component. More...
BoundaryName	_boundary_name_end
	Boundary name of the end side of the component. More...
std::vector< BoundaryName >	_boundary_names_interior_axial_per_radial_section
	Boundary names of the interior axial boundaries (per radial section) of the component. More...
std::vector< BoundaryName >	_boundary_names_axial_outer
	Boundary names of the axial regions of the outer side of the component. More...
std::vector< BoundaryName >	_boundary_names_axial_inner
	Boundary names of the axial regions of the inner side of the component. More...
std::vector< BoundaryName >	_boundary_names_radial_start
	Boundary names of the radial regions of the start side of the component. More...
std::vector< BoundaryName >	_boundary_names_radial_end
	Boundary names of the radial regions of the end side of the component. More...
std::vector< BoundaryName >	_boundary_names_inner_radial
	Boundary names of the inner radial boundary regions of the component. More...
std::map< BoundaryName, Real >	_boundary_name_to_area
	Map of boundary name to boundary area. More...
std::map< BoundaryName, std::vector< std::tuple< dof_id_type, unsigned short int > > >	_boundary_info
	Map of boundary name to list of tuples of element and side IDs for that boundary. More...
Real	_axial_offset
	Distance by which to offset the mesh from the component axis. More...
const std::vector< std::string > &	_axial_region_names
	Axial region names. More...
std::vector< Real >	_node_locations
	Node locations along the main axis. 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
const Point &	_position
	Start position of axis in 3-D space. More...
const RealVectorValue &	_dir_unnormalized
	Unnormalized direction of axis from start position to end position. More...
const RealVectorValue	_dir
	Normalized direction of axis from start position to end position. More...
const Real &	_rotation
	Angle of rotation about the x-axis. More...
std::vector< Real >	_lengths
	Length of each axial section. More...
Real	_length
	Total axial length. More...
const std::vector< unsigned int > &	_n_elems
	Number of elements in each axial section. More...
const unsigned int	_n_elem
	Total number of axial elements. More...
const unsigned int	_n_sections
	Number of axial sections. More...
std::vector< Real >	_section_end
	Axial coordinate of the end of each axial section using the line 'position' as the origin. More...
std::vector< Real >	_x_centers
	Center axial coordinate of each axial element. More...
const RealTensorValue	_R
	Direction transformation tensor. More...
const RealTensorValue	_Rx
	Rotational transformation tensor about x-axis. More...
const RealTensorValue	_R_inv
	Inverse direction transformation tensor. More...
const RealTensorValue	_Rx_inv
	Inverse rotational transformation tensor about x-axis. More...
const std::string	_moose_object_name_dlsi
	Name of the MOOSE object. More...

Detailed Description

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

ExternalBoundaryType

enum Component2D::ExternalBoundaryType

strong

External boundary type.

Enumerator
INNER
OUTER
START
END

Definition at line 18 of file Component2D.h.

  {
    INNER = 0,
    OUTER = 1,
    START = 2,
    END = 3
  };

Constructor & Destructor Documentation

Component2D()

Component2D::Component2D

(

const InputParameters &

params

)

Definition at line 41 of file Component2D.C.

  : GeneratedMeshComponent(params), _n_regions(0), _total_elem_number(0), _axial_offset(0.0)
{
}

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.

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

{
  _dependencies.push_back(dependency);
}

addElement()

Elem * GeometricalComponent::addElement ( libMesh::ElemType  elem_type, const std::vector< dof_id_type > &  node_ids  )

protectedinherited

Definition at line 27 of file GeometricalComponent.C.

Referenced by FileMeshComponent::buildMesh().

{
  auto elem = mesh().addElement(elem_type, node_ids);
  _elem_ids.push_back(elem->id());
  return elem;
}

addElementEdge2()

Elem * GeometricalComponent::addElementEdge2 ( dof_id_type  node0, dof_id_type  node1  )

protectedinherited

Definition at line 36 of file GeometricalComponent.C.

Referenced by Component1D::buildMesh().

{
  auto elem = mesh().addElementEdge2(node0, node1);
  _elem_ids.push_back(elem->id());
  return elem;
}

addElementEdge3()

Elem * GeometricalComponent::addElementEdge3 ( dof_id_type  node0, dof_id_type  node1, dof_id_type  node2  )

protectedinherited

Definition at line 44 of file GeometricalComponent.C.

Referenced by Component1D::buildMesh().

{
  auto elem = mesh().addElementEdge3(node0, node1, node2);
  _elem_ids.push_back(elem->id());
  return elem;
}

addElementQuad4()

Elem * GeometricalComponent::addElementQuad4 ( dof_id_type  node0, dof_id_type  node1, dof_id_type  node2, dof_id_type  node3  )

protectedinherited

Definition at line 52 of file GeometricalComponent.C.

Referenced by build2DMesh().

{
  auto elem = mesh().addElementQuad4(node0, node1, node2, node3);
  _elem_ids.push_back(elem->id());
  return elem;
}

addElementQuad9()

Elem * GeometricalComponent::addElementQuad9 ( dof_id_type  node0, dof_id_type  node1, dof_id_type  node2, dof_id_type  node3, dof_id_type  node4, dof_id_type  node5, dof_id_type  node6, dof_id_type  node7, dof_id_type  node8  )

protectedinherited

Definition at line 63 of file GeometricalComponent.C.

Referenced by build2DMesh2ndOrder().

{
  auto elem = mesh().addElementQuad9(node0, node1, node2, node3, node4, node5, node6, node7, node8);
  _elem_ids.push_back(elem->id());
  return elem;
}

addMooseObjects()

virtual void Component::addMooseObjects ( )

inlinevirtualinherited

Reimplemented in FlowChannelBase, FileMeshPhysicsComponent, JunctionOneToOne1Phase, HSBoundaryExternalAppHeatFlux, HeatStructureFromFile3D, HeatTransferFromHeatStructure1Phase, HeatStructureBase, HeatTransferBase, HeatTransferFromHeatStructure3D1Phase, HSCoupler2D2DRadiation, HSCoupler2D3D, SimpleTurbine1Phase, FlowChannel1PhaseBase, FormLoss1PhaseBase, HeatTransferFromExternalAppHeatFlux1Phase, HSBoundaryExternalAppConvection, ShaftConnectedCompressor1Phase, ShaftConnectedMotor, ShaftConnectedPump1Phase, ShaftConnectedTurbine1Phase, SolidWallGasMix, 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 build2DMesh(), 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.

{}

build2DMesh()

void Component2D::build2DMesh ( )

protected

Builds a 2D, first-order mesh.

Definition at line 65 of file Component2D.C.

Referenced by buildMesh().

{
  unsigned int n_axial_positions = _node_locations.size();
  std::vector<std::vector<unsigned int>> node_ids(
      n_axial_positions, std::vector<unsigned int>(_total_elem_number + 1));

  // loop over axial positions
  for (unsigned int i = 0; i < n_axial_positions; i++)
  {
    Point p(_node_locations[i], _axial_offset, 0);

    Node * nd = addNode(p);
    node_ids[i][0] = nd->id();

    // loop over regions
    unsigned int l = 1;
    for (unsigned int j = 0; j < _n_regions; j++)
    {
      Real elem_length = _width[j] / _n_part_elems[j];
      for (unsigned int k = 0; k < _n_part_elems[j]; k++, l++)
      {
        p(1) += elem_length;
        nd = addNode(p);
        node_ids[i][l] = nd->id();
      }
    }
  }

  auto & boundary_info = mesh().getMesh().get_boundary_info();

  // create elements from nodes
  unsigned int i = 0;
  for (unsigned int i_section = 0; i_section < _n_sections; i_section++)
  {
    // element axial index for end of axial section
    unsigned int i_section_end = 0;
    for (unsigned int ii_section = 0; ii_section <= i_section; ++ii_section)
      i_section_end += _n_elems[ii_section];
    i_section_end -= 1;

    for (unsigned int i_local = 0; i_local < _n_elems[i_section]; i_local++)
    {
      unsigned int j = 0;
      for (unsigned int j_section = 0; j_section < _n_regions; j_section++)
        for (unsigned int j_local = 0; j_local < _n_part_elems[j_section]; j_local++)
        {
          Elem * elem = addElementQuad4(
              node_ids[i][j + 1], node_ids[i][j], node_ids[i + 1][j], node_ids[i + 1][j + 1]);
          elem->subdomain_id() = _subdomain_ids[j_section];

          // exterior axial boundaries (all radial sections)
          if (i == 0)
          {
            boundary_info.add_side(elem, 0, _start_bc_id);
            _boundary_info[_boundary_name_start].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 0));
          }
          if (i == _n_elem - 1)
          {
            boundary_info.add_side(elem, 2, _end_bc_id);
            _boundary_info[_boundary_name_end].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 2));
          }

          // exterior axial boundaries (per radial section)
          if (_names.size() > 1)
          {
            if (i == 0)
            {
              boundary_info.add_side(elem, 0, _radial_start_bc_id[j_section]);
              _boundary_info[_boundary_names_radial_start[j_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 0));
            }
            if (i == _n_elem - 1)
            {
              boundary_info.add_side(elem, 2, _radial_end_bc_id[j_section]);
              _boundary_info[_boundary_names_radial_end[j_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 2));
            }
          }

          // interior axial boundaries (per radial section)
          if (_n_sections > 1 && _axial_region_names.size() == _n_sections &&
              i_section != _n_sections - 1 && i == i_section_end)
          {
            const unsigned int k = i_section * _n_regions + j_section;
            boundary_info.add_side(elem, 2, _interior_axial_per_radial_section_bc_id[k]);
            _boundary_info[_boundary_names_interior_axial_per_radial_section[k]].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 2));
          }

          // exterior radial boundaries (all axial sections)
          if (j == 0)
          {
            boundary_info.add_side(elem, 1, _inner_bc_id);
            _boundary_info[_boundary_name_inner].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
          }
          if (j == _total_elem_number - 1)
          {
            boundary_info.add_side(elem, 3, _outer_bc_id);
            _boundary_info[_boundary_name_outer].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 3));
          }

          // exterior radial boundaries (per axial section)
          if (_n_sections > 1 && _axial_region_names.size() == _n_sections)
          {
            if (j == 0)
            {
              boundary_info.add_side(elem, 1, _axial_inner_bc_id[i_section]);
              _boundary_info[_boundary_names_axial_inner[i_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
            }
            if (j == _total_elem_number - 1)
            {
              boundary_info.add_side(elem, 3, _axial_outer_bc_id[i_section]);
              _boundary_info[_boundary_names_axial_outer[i_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 3));
            }
          }

          // interior radial boundaries (all axial sections)
          if (_n_regions > 1 && _names.size() == _n_regions && j_section != 0)
          {
            unsigned int j_section_begin = 0;
            for (unsigned int jj_section = 0; jj_section < j_section; ++jj_section)
              j_section_begin += _n_part_elems[jj_section];

            if (j == j_section_begin)
            {
              boundary_info.add_side(elem, 1, _inner_radial_bc_id[j_section - 1]);
              _boundary_info[_boundary_names_inner_radial[j_section - 1]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
            }
          }

          j++;
        }

      i++;
    }
  }
}

build2DMesh2ndOrder()

void Component2D::build2DMesh2ndOrder ( )

protected

Builds a 2D, second-order mesh.

Definition at line 211 of file Component2D.C.

Referenced by buildMesh().

{
  unsigned int n_axial_positions = _node_locations.size();
  std::vector<std::vector<unsigned int>> node_ids(
      n_axial_positions, std::vector<unsigned int>(2 * _total_elem_number + 1));

  // loop over axial positions
  for (unsigned int i = 0; i < n_axial_positions; i++)
  {
    Point p(_node_locations[i], _axial_offset, 0);

    const Node * nd = addNode(p);
    node_ids[i][0] = nd->id();

    // loop over regions
    unsigned int l = 1;
    for (unsigned int j = 0; j < _n_regions; j++)
    {
      Real elem_length = _width[j] / (2. * _n_part_elems[j]);
      for (unsigned int k = 0; k < 2. * _n_part_elems[j]; k++, l++)
      {
        p(1) += elem_length;
        nd = addNode(p);
        node_ids[i][l] = nd->id();
      }
    }
  }

  auto & boundary_info = mesh().getMesh().get_boundary_info();

  // create elements from nodes
  unsigned int i = 0;
  for (unsigned int i_section = 0; i_section < _n_sections; i_section++)
    for (unsigned int i_local = 0; i_local < _n_elems[i_section]; i_local++)
    {
      unsigned int j = 0;
      for (unsigned int j_section = 0; j_section < _n_regions; j_section++)
        for (unsigned int j_local = 0; j_local < _n_part_elems[j_section]; j_local++)
        {
          Elem * elem = addElementQuad9(node_ids[2 * i][2 * j],
                                        node_ids[2 * i][2 * (j + 1)],
                                        node_ids[2 * (i + 1)][2 * (j + 1)],
                                        node_ids[2 * (i + 1)][2 * j],
                                        node_ids[2 * i][(2 * j) + 1],
                                        node_ids[(2 * i) + 1][2 * (j + 1)],
                                        node_ids[2 * (i + 1)][(2 * j) + 1],
                                        node_ids[(2 * i) + 1][(2 * j)],
                                        node_ids[(2 * i) + 1][(2 * j) + 1]);
          elem->subdomain_id() = _subdomain_ids[j_section];

          if (i == 0)
          {
            boundary_info.add_side(elem, 0, _start_bc_id);
            _boundary_info[_boundary_name_start].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 0));
          }
          if (i == _n_elem - 1)
          {
            boundary_info.add_side(elem, 2, _end_bc_id);
            _boundary_info[_boundary_name_end].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 2));
          }
          if (_names.size() > 1)
          {
            if (i == 0)
            {
              boundary_info.add_side(elem, 0, _radial_start_bc_id[j_section]);
              _boundary_info[_boundary_names_radial_start[j_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 0));
            }
            if (i == _n_elem - 1)
            {
              boundary_info.add_side(elem, 2, _radial_end_bc_id[j_section]);
              _boundary_info[_boundary_names_radial_end[j_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 2));
            }
          }

          if (j == 0)
          {
            boundary_info.add_side(elem, 3, _inner_bc_id);
            _boundary_info[_boundary_name_inner].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 3));
          }
          if (j == _total_elem_number - 1)
          {
            boundary_info.add_side(elem, 1, _outer_bc_id);
            _boundary_info[_boundary_name_outer].push_back(
                std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
          }

          if (_n_sections > 1 && _axial_region_names.size() == _n_sections)
          {
            if (j == 0)
            {
              boundary_info.add_side(elem, 1, _axial_inner_bc_id[i_section]);
              _boundary_info[_boundary_names_axial_inner[i_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
            }
            if (j == _total_elem_number - 1)
            {
              boundary_info.add_side(elem, 3, _axial_outer_bc_id[i_section]);
              _boundary_info[_boundary_names_axial_outer[i_section]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 3));
            }
          }

          // interior radial boundaries
          if (_n_regions > 1 && _names.size() == _n_regions && j_section != 0)
          {
            unsigned int j_section_begin = 0;
            for (unsigned int jj_section = 0; jj_section < j_section; ++jj_section)
              j_section_begin += _n_part_elems[jj_section];

            if (j == j_section_begin)
            {
              boundary_info.add_side(elem, 1, _inner_radial_bc_id[j_section - 1]);
              _boundary_info[_boundary_names_inner_radial[j_section - 1]].push_back(
                  std::tuple<dof_id_type, unsigned short int>(elem->id(), 1));
            }
          }

          j++;
        }

      i++;
    }
}

buildMesh()

void Component2D::buildMesh ( )

overridevirtual

Implements GeneratedMeshComponent.

Definition at line 341 of file Component2D.C.

{
  if (_n_part_elems.size() != _n_regions || _width.size() != _n_regions)
    return;

  // Assign subdomain to each transverse region
  for (unsigned int i = 0; i < _n_regions; i++)
  {
    // The coordinate system for MOOSE is always XYZ, even for axisymmetric
    // components, since we do the RZ integration ourselves until we can set
    // arbitrary number of axis symmetries in MOOSE.
    setSubdomainInfo(mesh().getNextSubdomainId(), genName(_name, _names[i]), Moose::COORD_XYZ);
  }

  // Create boundary IDs and associated boundary names
  _inner_bc_id = mesh().getNextBoundaryId();
  _outer_bc_id = mesh().getNextBoundaryId();
  _boundary_name_inner = genName(name(), "inner");
  _boundary_name_outer = genName(name(), "outer");
  _boundary_name_to_area[_boundary_name_inner] = computeRadialBoundaryArea(_length, 0.0);
  _boundary_name_to_area[_boundary_name_outer] =
      computeRadialBoundaryArea(_length, getTotalWidth());
  if (_n_sections > 1 && _axial_region_names.size() == _n_sections)
    for (unsigned int i = 0; i < _n_sections; i++)
    {
      _axial_inner_bc_id.push_back(mesh().getNextBoundaryId());
      _axial_outer_bc_id.push_back(mesh().getNextBoundaryId());
      const BoundaryName boundary_name_axial_inner =
          genName(name(), _axial_region_names[i], "inner");
      const BoundaryName boundary_name_axial_outer =
          genName(name(), _axial_region_names[i], "outer");
      _boundary_names_axial_inner.push_back(boundary_name_axial_inner);
      _boundary_names_axial_outer.push_back(boundary_name_axial_outer);
      _boundary_name_to_area[boundary_name_axial_inner] =
          computeRadialBoundaryArea(_lengths[i], 0.0);
      _boundary_name_to_area[boundary_name_axial_outer] =
          computeRadialBoundaryArea(_lengths[i], getTotalWidth());
    }

  // exterior axial boundaries
  _start_bc_id = mesh().getNextBoundaryId();
  _end_bc_id = mesh().getNextBoundaryId();
  _boundary_name_start = genName(name(), "start");
  _boundary_name_end = genName(name(), "end");
  _boundary_name_to_area[_boundary_name_start] = computeAxialBoundaryArea(0.0, getTotalWidth());
  _boundary_name_to_area[_boundary_name_end] = computeAxialBoundaryArea(0.0, getTotalWidth());
  if (_names.size() > 1)
  {
    Real y1 = 0.0;
    for (unsigned int i = 0; i < _names.size(); i++)
    {
      const Real y2 = y1 + _width[i];

      _radial_start_bc_id.push_back(mesh().getNextBoundaryId());
      _radial_end_bc_id.push_back(mesh().getNextBoundaryId());
      const BoundaryName boundary_name_radial_start = genName(name(), _names[i], "start");
      const BoundaryName boundary_name_radial_end = genName(name(), _names[i], "end");
      _boundary_names_radial_start.push_back(boundary_name_radial_start);
      _boundary_names_radial_end.push_back(boundary_name_radial_end);
      _boundary_name_to_area[boundary_name_radial_start] = computeAxialBoundaryArea(y1, y2);
      _boundary_name_to_area[boundary_name_radial_end] = computeAxialBoundaryArea(y1, y2);
      if (i != _names.size() - 1)
      {
        _inner_radial_bc_id.push_back(mesh().getNextBoundaryId());
        const BoundaryName boundary_name_inner_radial = genName(name(), _names[i], _names[i + 1]);
        _boundary_names_inner_radial.push_back(boundary_name_inner_radial);
        _boundary_name_to_area[boundary_name_inner_radial] = computeRadialBoundaryArea(_length, y2);
      }
      y1 = y2;
    }
  }

  // interior axial boundaries
  if (_n_sections > 1 && _axial_region_names.size() == _n_sections)
    for (unsigned int i = 0; i < _n_sections - 1; i++)
    {
      Real y1 = 0.0;
      for (unsigned int j = 0; j < _names.size(); j++)
      {
        const Real y2 = y1 + _width[j];

        _interior_axial_per_radial_section_bc_id.push_back(mesh().getNextBoundaryId());
        const BoundaryName boundary_name_interior_axial_per_radial_section =
            genName(name(), _names[j], _axial_region_names[i] + ":" + _axial_region_names[i + 1]);
        _boundary_names_interior_axial_per_radial_section.push_back(
            boundary_name_interior_axial_per_radial_section);
        _boundary_name_to_area[boundary_name_interior_axial_per_radial_section] =
            computeAxialBoundaryArea(y1, y2);
        y1 = y2;
      }
    }

  // Build the mesh
  if (usingSecondOrderMesh())
    build2DMesh2ndOrder();
  else
    build2DMesh();

  // Set boundary names
  auto & binfo = mesh().getMesh().get_boundary_info();
  binfo.sideset_name(_inner_bc_id) = _boundary_name_inner;
  binfo.sideset_name(_outer_bc_id) = _boundary_name_outer;
  if (_n_sections > 1 && _axial_region_names.size() == _n_sections)
    for (unsigned int i = 0; i < _n_sections; i++)
    {
      binfo.sideset_name(_axial_inner_bc_id[i]) = _boundary_names_axial_inner[i];
      binfo.sideset_name(_axial_outer_bc_id[i]) = _boundary_names_axial_outer[i];
    }
  binfo.sideset_name(_start_bc_id) = _boundary_name_start;
  binfo.sideset_name(_end_bc_id) = _boundary_name_end;
  if (_names.size() > 1)
    for (unsigned int i = 0; i < _names.size(); i++)
    {
      binfo.sideset_name(_radial_start_bc_id[i]) = _boundary_names_radial_start[i];
      binfo.sideset_name(_radial_end_bc_id[i]) = _boundary_names_radial_end[i];
      if (i != _names.size() - 1)
        binfo.sideset_name(_inner_radial_bc_id[i]) = _boundary_names_inner_radial[i];
    }
  for (unsigned int k = 0; k < _interior_axial_per_radial_section_bc_id.size(); k++)
    binfo.sideset_name(_interior_axial_per_radial_section_bc_id[k]) =
        _boundary_names_interior_axial_per_radial_section[k];
}

check()

void Component2D::check ( ) const

overrideprotectedvirtual

Check the component integrity.

Reimplemented from GeneratedMeshComponent.

Reimplemented in HeatStructureBase, HeatStructurePlate, and HeatStructureCylindrical.

Definition at line 47 of file Component2D.C.

Referenced by HeatStructureBase::check().

{
  GeneratedMeshComponent::check();

  if (getParam<std::vector<std::string>>("axial_region_names").size())
    checkEqualSize<std::string, Real>("axial_region_names", "length");
  else if (_n_sections > 1)
    logError("If there is more than 1 axial region, then the parameter 'axial_region_names' must "
             "be specified.");
}

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

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(), getBoundaryArea(), FileMeshComponent::getBoundaryInfo(), getBoundaryInfo(), Component1DConnection::getBoundaryNames(), Component1D::getConnections(), Component::getCoordSysTypes(), Component::getElementIDs(), getExternalBoundaryName(), 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(), hasBoundary(), 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),
               ")");
}

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

computeAxialBoundaryArea()

virtual Real Component2D::computeAxialBoundaryArea ( const Real &  y_min, const Real &  y_max  ) const

pure virtual

Computes the area of an axial boundary.

Parameters

[in]	y_min	Minimum transverse position of the surface, which ranges from 0 (inner) to total width (outer).
[in]	y_max	Maximum transverse position of the surface, which ranges from 0 (inner) to total width (outer).

Implemented in HeatStructureCylindricalBase, and HeatStructurePlate.

Referenced by buildMesh().

computeAxialCoordinate()

Real DiscreteLineSegmentInterface::computeAxialCoordinate ( const Point &  p ) const

inherited

Definition at line 107 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterfaceTestAux::computeValue(), DiscreteLineSegmentInterface::getAxialElementIndex(), and DiscreteLineSegmentInterface::getAxialSectionIndex().

{
  const Real ax_coord = _dir * (p - _position);
  if (MooseUtils::absoluteFuzzyLessThan(ax_coord, 0.0) ||
      MooseUtils::absoluteFuzzyGreaterThan(ax_coord, _length))
    mooseError(_moose_object_name_dlsi,
               ": The point ",
               p,
               " has an invalid axial coordinate (",
               ax_coord,
               "). Valid axial coordinates are in the range (0,",
               _length,
               ").");
  else
    return ax_coord;
}

computeDirectionTransformationTensor()

RealTensorValue DiscreteLineSegmentInterface::computeDirectionTransformationTensor ( const RealVectorValue &  dir )

staticinherited

Computes the direction transformation tensor.

Parameters

[in]

dir

Direction vector

Definition at line 82 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

{
  if (MooseUtils::absoluteFuzzyEqual(dir.norm(), 0.0))
    mooseError("The direction vector must not be the zero vector.");

  const auto dir_normalized = dir / dir.norm();
  const Real theta = acos(dir_normalized(2));
  const Real aphi = atan2(dir_normalized(1), dir_normalized(0));
  return RealTensorValue(
      RealVectorValue(cos(aphi) * sin(theta), -sin(aphi), -cos(aphi) * cos(theta)),
      RealVectorValue(sin(aphi) * sin(theta), cos(aphi), -sin(aphi) * cos(theta)),
      RealVectorValue(cos(theta), 0.0, sin(theta)));
}

computeRadialBoundaryArea()

virtual Real Component2D::computeRadialBoundaryArea ( const Real &  length, const Real &  y  ) const

pure virtual

Computes the area of a radial boundary.

Parameters

[in]	length	Length of the radial boundary
[in]	y	Transverse position of the surface, which ranges from 0 (inner) to total width (outer).

Implemented in HeatStructureCylindricalBase, and HeatStructurePlate.

Referenced by buildMesh().

computeRadialCoordinate()

Real DiscreteLineSegmentInterface::computeRadialCoordinate ( const Point &  p ) const

inherited

Definition at line 125 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterfaceTestAux::computeValue().

{
  const RealVectorValue v = (p - _position);
  return v.cross(_dir).norm();
}

computeRealPointFromReferencePoint() [1/2]

Point DiscreteLineSegmentInterface::computeRealPointFromReferencePoint ( const Point &  p ) const

inherited

Computes point in 3-D space from a point in reference space.

Parameters

[in]

p

Point in reference space

Definition at line 163 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterface::getElementBoundaryCoordinates(), and GeneratedMeshComponent::setupMesh().

{
  return computeRealPointFromReferencePoint(p, _position, _R, _Rx);
}

computeRealPointFromReferencePoint() [2/2]

Point DiscreteLineSegmentInterface::computeRealPointFromReferencePoint ( const Point &  p, const RealVectorValue &  position, const RealTensorValue &  R, const RealTensorValue &  Rx  )

staticinherited

Computes point in 3-D space from a point in reference space.

Parameters

[in]

p

Point in reference space

Definition at line 154 of file DiscreteLineSegmentInterface.C.

{
  return R * (Rx * p) + position;
}

computeReferencePointFromRealPoint() [1/2]

Point DiscreteLineSegmentInterface::computeReferencePointFromRealPoint ( const Point &  p ) const

inherited

Computes point in reference space from a point in 3-D space.

Parameters

[in]

p

Point in 3-D space

Definition at line 178 of file DiscreteLineSegmentInterface.C.

{
  return computeReferencePointFromRealPoint(p, _position, _R_inv, _Rx_inv);
}

computeReferencePointFromRealPoint() [2/2]

Point DiscreteLineSegmentInterface::computeReferencePointFromRealPoint ( const Point &  p, const RealVectorValue &  position, const RealTensorValue &  R_inv, const RealTensorValue &  Rx_inv  )

staticinherited

Computes point in reference space from a point in 3-D space.

Parameters

[in]

p

Point in 3-D space

Definition at line 169 of file DiscreteLineSegmentInterface.C.

{
  return Rx_inv * R_inv * (p - position);
}

computeXRotationTransformationTensor()

RealTensorValue DiscreteLineSegmentInterface::computeXRotationTransformationTensor ( const Real &  rotation )

staticinherited

Computes the rotation transformation tensor.

Parameters

[in]

rotation

Rotation about the x-axis, in degrees

Definition at line 97 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

{
  const Real rotation_rad = M_PI * rotation / 180.;
  const RealVectorValue Rx_x(1., 0., 0.);
  const RealVectorValue Rx_y(0., cos(rotation_rad), -sin(rotation_rad));
  const RealVectorValue Rx_z(0., sin(rotation_rad), cos(rotation_rad));
  return RealTensorValue(Rx_x, Rx_y, Rx_z);
}

connectObject() [1/2]

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

inherited

Connect with control logic.

Definition at line 98 of file Component.C.

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

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

connectObject() [2/2]

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

inherited

Connect with control logic.

Definition at line 106 of file Component.C.

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

constMesh()

const THMMesh& Component::constMesh ( ) const

inlineinherited

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

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

Definition at line 62 of file Component.h.

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

{ 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(), FlowModel1PhaseBase::addDensityAux(), FlowModelSinglePhase::addDensityIC(), FlowModelGasMix::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), Simulation::addFunctionIC(), HeatTransferBase::addHeatedPerimeter(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), HeatTransferFromTemperature1Phase::addHeatTransferKernels(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), HeatConductionModel::addMaterials(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), FormLossFromFunction1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), Shaft::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferBase::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModelGasMix::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelSinglePhase::addTemperatureAux(), FlowModelGasMix::addTemperatureAux(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), FlowChannelBase::addVariables(), FlowModel1PhaseBase::addVelocityAux(), FlowModel1PhaseBase::addVelocityIC(), VolumeJunction1Phase::addVolumeJunctionIC(), Closures1PhaseTHM::addWallFFMaterial(), Closures1PhaseBase::addWallFrictionFunctionMaterial(), Closures1PhaseTHM::addWallHTCMaterial(), ClosuresBase::addWallTemperatureFromAuxMaterial(), Closures1PhaseSimple::addWallTemperatureFromHeatFluxMaterial(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), ClosuresBase::addWeightedAverageMaterial(), FlowModelGasMix::addXiRhoAIC(), ClosuresBase::addZeroMaterial(), buildMesh(), FileMeshComponent::buildMesh(), Component1D::buildMesh(), HeatSourceBase::HeatSourceBase(), 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();
  }

getAlignmentAxis() [1/2]

MooseEnum DiscreteLineSegmentInterface::getAlignmentAxis ( ) const

inherited

Gets an axis MooseEnum for the axis the component is aligned with.

If the axis does not align with the x, y, or z axis, then an invalid MooseEnum is returned.

Definition at line 198 of file DiscreteLineSegmentInterface.C.

Referenced by CoupledHeatTransferAction::addUserObjects(), CoupledHeatTransferAction::CoupledHeatTransferAction(), and DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

{
  return getAlignmentAxis(_dir);
}

getAlignmentAxis() [2/2]

MooseEnum DiscreteLineSegmentInterface::getAlignmentAxis ( const RealVectorValue &  dir )

staticinherited

Gets an axis MooseEnum for the axis the component is aligned with.

If the axis does not align with the x, y, or z axis, then an invalid MooseEnum is returned.

Definition at line 184 of file DiscreteLineSegmentInterface.C.

{
  MooseEnum axis("x y z");
  if (THM::areParallelVectors(dir, RealVectorValue(1, 0, 0)))
    axis = "x";
  else if (THM::areParallelVectors(dir, RealVectorValue(0, 1, 0)))
    axis = "y";
  else if (THM::areParallelVectors(dir, RealVectorValue(0, 0, 1)))
    axis = "z";

  return axis;
}

getAxialElementIndex()

unsigned int DiscreteLineSegmentInterface::getAxialElementIndex ( const Point &  p_center ) const

inherited

Definition at line 143 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterfaceTestAux::computeValue().

{
  const Real axial_coordinate = computeAxialCoordinate(p_center);
  for (unsigned int i = 0; i < _n_elem; ++i)
    if (MooseUtils::absoluteFuzzyEqual(axial_coordinate, _x_centers[i]))
      return i;

  mooseError("No axial element index was found.");
}

getAxialOffset()

Real Component2D::getAxialOffset ( ) const

inline

Gets the axial offset for the mesh.

Definition at line 110 of file Component2D.h.

{ return _axial_offset; }

getAxialSectionIndex()

unsigned int DiscreteLineSegmentInterface::getAxialSectionIndex ( const Point &  p ) const

inherited

Definition at line 132 of file DiscreteLineSegmentInterface.C.

Referenced by DiscreteLineSegmentInterfaceTestAux::computeValue().

{
  const Real axial_coordinate = computeAxialCoordinate(p);
  for (unsigned int i = 0; i < _n_sections; ++i)
    if (MooseUtils::absoluteFuzzyLessEqual(axial_coordinate, _section_end[i]))
      return i;

  mooseError("No axial section index was found.");
}

getBoundaryArea()

const Real & Component2D::getBoundaryArea

(

const BoundaryName &

boundary_name

)

const

Gets the area for a boundary.

Definition at line 570 of file Component2D.C.

Referenced by HeatStructure2DCouplerBase::init().

{
  checkSetupStatus(MESH_PREPARED);

  if (_boundary_name_to_area.find(boundary_name) != _boundary_name_to_area.end())
    return _boundary_name_to_area.at(boundary_name);
  else
    mooseError(name(), ": The boundary '", boundary_name, "' does not exist on this component.");
}

getBoundaryInfo() [1/2]

const std::vector< std::tuple< dof_id_type, unsigned short int > > & Component2D::getBoundaryInfo

(

const BoundaryName &

boundary_name

)

const

Gets boundary info associated with the component boundary.

Parameters

[in]

boundary

Boundary name of a component boundary

Returns

The list of tuples (element id, local side id) that is associated with boundary boundary

Definition at line 519 of file Component2D.C.

Referenced by getBoundaryInfo(), HeatStructure2DCouplerBase::setupMesh(), and HeatTransferFromHeatStructure1Phase::setupMesh().

{
  checkSetupStatus(MESH_PREPARED);

  if (_boundary_info.find(boundary_name) != _boundary_info.end())
    return _boundary_info.at(boundary_name);
  else
    mooseError(name(), ": The boundary '", boundary_name, "' does not exist on this component.");
}

getBoundaryInfo() [2/2]

const std::vector< std::tuple< dof_id_type, unsigned short int > > & Component2D::getBoundaryInfo

(

const ExternalBoundaryType &

boundary_type

)

const

Gets boundary info associated with a external boundary type.

Parameters

[in]

boundary_type

The external boundary type

Returns

The list of tuples (element id, local side id) associated the external boundary type

Definition at line 530 of file Component2D.C.

{
  checkSetupStatus(MESH_PREPARED);

  switch (boundary_type)
  {
    case ExternalBoundaryType::INNER:
      return getBoundaryInfo(_boundary_name_inner);
    case ExternalBoundaryType::OUTER:
      return getBoundaryInfo(_boundary_name_outer);
    case ExternalBoundaryType::START:
      return getBoundaryInfo(_boundary_name_start);
    case ExternalBoundaryType::END:
      return getBoundaryInfo(_boundary_name_end);
    default:
      mooseError(name(), ": Invalid external boundary type.");
  }
}

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

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

getDirection()

virtual RealVectorValue DiscreteLineSegmentInterface::getDirection ( ) const

inlinevirtualinherited

Definition at line 28 of file DiscreteLineSegmentInterface.h.

Referenced by HeatConductionModel::addHeatEquationRZ(), HeatStructure2DCoupler::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::getFlowChannelAxisAlignment(), and Component1DConnection::setupMesh().

{ return _dir; }

getElementBoundaryCoordinates() [1/2]

std::vector< Real > DiscreteLineSegmentInterface::getElementBoundaryCoordinates ( ) const

inherited

Gets the element boundary coordinates for the aligned axis.

Definition at line 254 of file DiscreteLineSegmentInterface.C.

Referenced by CoupledHeatTransferAction::addUserObjects().

{
  return getElementBoundaryCoordinates(_position, _dir, _rotation, _lengths, _n_elems);
}

getElementBoundaryCoordinates() [2/2]

std::vector< Real > DiscreteLineSegmentInterface::getElementBoundaryCoordinates ( const RealVectorValue &  position, const RealVectorValue &  orientation, const Real &  rotation, const std::vector< Real > &  lengths, const std::vector< unsigned int > &  n_elems  )

staticinherited

Gets the element boundary coordinates for the aligned axis.

Parameters

[in]	position	Start position of axis in 3-D space
[in]	orientation	Direction of axis from start position to end position
[in]	rotation	Angle of rotation about the x-axis, in degrees
[in]	lengths	Length of each axial section
[in]	n_elems	Number of elements in each axial section

Definition at line 204 of file DiscreteLineSegmentInterface.C.

{
  const auto axis = getAlignmentAxis(orientation);

  unsigned int d;
  if (axis == "x")
    d = 0;
  else if (axis == "y")
    d = 1;
  else if (axis == "z")
    d = 2;
  else
    mooseError("Invalid axis.");

  const auto R = computeDirectionTransformationTensor(orientation);
  const auto Rx = computeXRotationTransformationTensor(rotation);

  const unsigned int n_elems_total = std::accumulate(n_elems.begin(), n_elems.end(), 0);
  const unsigned int n_sections = lengths.size();

  unsigned int i_section_start = 0;
  Real section_start_ref_position = 0.0;
  std::vector<Real> element_boundary_coordinates(n_elems_total + 1);
  element_boundary_coordinates[0] =
      computeRealPointFromReferencePoint(Point(0, 0, 0), position, R, Rx)(d);
  for (unsigned int j = 0; j < n_sections; ++j)
  {
    const Real section_dx = lengths[j] / n_elems[j];
    for (unsigned int k = 0; k < n_elems[j]; ++k)
    {
      const unsigned int i = i_section_start + k + 1;
      const Real ref_position = section_start_ref_position + section_dx * k;
      const Point ref_point = Point(ref_position, 0, 0);
      element_boundary_coordinates[i] =
          computeRealPointFromReferencePoint(ref_point, position, R, Rx)(d);
    }

    section_start_ref_position += lengths[j];
    i_section_start += n_elems[j];
  }

  return element_boundary_coordinates;
}

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

getExternalBoundaryName()

const BoundaryName & Component2D::getExternalBoundaryName

(

const ExternalBoundaryType &

boundary_type

)

const

Gets the name of an external boundary by type.

Parameters

[in]

boundary_type

The external boundary type

Definition at line 550 of file Component2D.C.

Referenced by HSBoundaryInterface::getHSBoundaryName().

{
  checkSetupStatus(MESH_PREPARED);

  switch (boundary_type)
  {
    case ExternalBoundaryType::OUTER:
      return _boundary_name_outer;
    case ExternalBoundaryType::INNER:
      return _boundary_name_inner;
    case ExternalBoundaryType::START:
      return _boundary_name_start;
    case ExternalBoundaryType::END:
      return _boundary_name_end;
    default:
      mooseError(name(), ": Invalid external boundary type.");
  }
}

getExternalBoundaryType()

Component2D::ExternalBoundaryType Component2D::getExternalBoundaryType

(

const BoundaryName &

boundary_name

)

const

Gets the external boundary type of the given boundary.

An error is thrown if the supplied boundary name does not exist in this component or if the boundary is interior.

Parameters

[in]

boundary_name

Boundary name for which to get boundary type

Definition at line 496 of file Component2D.C.

Referenced by HSBoundary::check(), and HeatStructure2DCouplerBase::init().

{
  checkSetupStatus(MESH_PREPARED);

  if (boundary_name == _boundary_name_inner ||
      isBoundaryInVector(boundary_name, _boundary_names_axial_inner))
    return ExternalBoundaryType::INNER;
  else if (boundary_name == _boundary_name_outer ||
           isBoundaryInVector(boundary_name, _boundary_names_axial_outer))
    return ExternalBoundaryType::OUTER;
  else if (boundary_name == _boundary_name_start ||
           isBoundaryInVector(boundary_name, _boundary_names_radial_start))
    return ExternalBoundaryType::START;
  else if (boundary_name == _boundary_name_end ||
           isBoundaryInVector(boundary_name, _boundary_names_radial_end))
    return ExternalBoundaryType::END;
  else if (hasBoundary(boundary_name))
    mooseError(name(), ": The boundary '", boundary_name, "' is an interior boundary.");
  else
    mooseError(name(), ": The boundary '", boundary_name, "' does not exist on this component.");
}

getExternalBoundaryTypeMooseEnum()

MooseEnum Component2D::getExternalBoundaryTypeMooseEnum ( const std::string &  default_value = "" )

static

Gets the MooseEnum corresponding to ExternalBoundaryType.

Parameters

[in]

default_value

Default value; omit to have no default

Definition at line 21 of file Component2D.C.

Referenced by HSBoundaryInterface::validParams().

{
  return THM::getMooseEnum<ExternalBoundaryType>(name, _external_boundary_type_to_enum);
}

getLength()

virtual Real DiscreteLineSegmentInterface::getLength ( ) const

inlinevirtualinherited

Definition at line 32 of file DiscreteLineSegmentInterface.h.

Referenced by HeatTransferFromHeatStructure1Phase::check(), and HeatTransferFromHeatStructure3D1Phase::init().

{ return _length; }

getNames()

const std::vector<std::string>& Component2D::getNames ( ) const

inline

Gets the names of the transverse regions.

Definition at line 50 of file Component2D.h.

Referenced by HeatStructureBase::addConstantDensitySolidPropertiesMaterial().

{ return _names; }

getNodeIDs()

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

inherited

Gets the node IDs corresponding to this component.

Definition at line 291 of file Component.C.

{
  checkSetupStatus(MESH_PREPARED);

  return _node_ids;
}

getNumElems()

virtual Real DiscreteLineSegmentInterface::getNumElems ( ) const

inlinevirtualinherited

Definition at line 31 of file DiscreteLineSegmentInterface.h.

Referenced by HeatTransferFromHeatStructure1Phase::check(), and HeatTransferFromHeatStructure3D1Phase::init().

{ return _n_elem; }

getNumRegions()

unsigned int Component2D::getNumRegions ( ) const

inline

Gets the number of transverse regions.

Definition at line 38 of file Component2D.h.

{ return _n_regions; }

getPosition()

virtual Point DiscreteLineSegmentInterface::getPosition ( ) const

inlinevirtualinherited

Definition at line 27 of file DiscreteLineSegmentInterface.h.

Referenced by HeatConductionModel::addHeatEquationRZ(), HeatSourceFromTotalPower::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), and HeatTransferFromHeatStructure3D1Phase::addMooseObjects().

{ return _position; }

getRotation()

virtual Real DiscreteLineSegmentInterface::getRotation ( ) const

inlinevirtualinherited

Definition at line 29 of file DiscreteLineSegmentInterface.h.

{ return _rotation; }

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(), FlowModel1PhaseBase::addDensityAux(), FlowModelSinglePhase::addDensityIC(), FlowModelGasMix::addDensityIC(), FlowModel1PhaseBase::addEnergyGravityKernel(), FlowModelSinglePhase::addFluidPropertiesMaterials(), FlowModelGasMix::addFluidPropertiesMaterials(), FlowModel1PhaseBase::addFunctionIC(), HeatConductionModel::addHeatEquationRZ(), HeatConductionModel::addHeatEquationXYZ(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), HeatConductionModel::addInitialConditions(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), FlowModelGasMix::addMassDiffusionEnergyDGKernel(), FlowModelGasMix::addMassDiffusionSpeciesDGKernel(), FlowModelGasMix::addMassFractionAux(), HeatConductionModel::addMaterials(), FlowModel1PhaseBase::addMomentumAreaGradientKernel(), FlowModel1PhaseBase::addMomentumFrictionKernel(), FlowModel1PhaseBase::addMomentumGravityKernel(), HeatSourceVolumetric1Phase::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), FunctorClosures::addMooseObjectsFlowChannel(), Closures1PhaseSimple::addMooseObjectsHeatTransfer(), FlowModelSinglePhase::addPressureAux(), FlowModelGasMix::addPressureAux(), FlowModelSinglePhase::addRDGAdvectionDGKernels(), FlowModelGasMix::addRDGAdvectionDGKernels(), FlowModel1PhaseBase::addRhoAIC(), FlowModelSinglePhase::addRhoEAIC(), FlowModelGasMix::addRhoEAIC(), FlowModel1PhaseBase::addRhoUAIC(), FlowModelSinglePhase::addSlopeReconstructionMaterial(), FlowModelGasMix::addSlopeReconstructionMaterial(), FlowModel1PhaseBase::addSpecificInternalEnergyAux(), FlowModel1PhaseBase::addSpecificInternalEnergyIC(), FlowModel1PhaseBase::addSpecificTotalEnthalpyAux(), FlowModel1PhaseBase::addSpecificTotalEnthalpyIC(), FlowModel1PhaseBase::addSpecificVolumeAux(), FlowModel1PhaseBase::addSpecificVolumeIC(), FlowModelSinglePhase::addTemperatureAux(), FlowModelGasMix::addTemperatureAux(), Closures1PhaseTHM::addTemperatureWallFromHeatFluxMaterial(), FlowModel1PhaseBase::addTimeDerivativeKernelIfTransient(), HSBoundaryExternalAppTemperature::addVariables(), HSBoundaryExternalAppConvection::addVariables(), FlowModel1PhaseBase::addVariables(), FlowModelGasMix::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), HeatConductionModel::addVariables(), FlowChannelBase::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(), 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(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), VolumeJunction1Phase::addJunctionIC(), VolumeJunction1Phase::addJunctionVariable(), FormLossFromFunction1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), SolidWall1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), InletFunction1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), Outlet1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), Shaft::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), ShaftConnectedMotor::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), SolidWallGasMix::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HeatStructureBase::addMooseObjects(), HeatTransferBase::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), HeatTransferFromExternalAppTemperature1Phase::addVariables(), FormLossFromExternalApp1Phase::addVariables(), TotalPower::addVariables(), TotalPowerBase::addVariables(), HeatTransferFromTemperature1Phase::addVariables(), HSBoundaryExternalAppTemperature::addVariables(), HeatTransferFromSpecifiedTemperature1Phase::addVariables(), Shaft::addVariables(), HeatTransferFromExternalAppHeatFlux1Phase::addVariables(), HSBoundaryExternalAppConvection::addVariables(), HeatTransferFromHeatStructure3D1Phase::addVariables(), HeatTransferFromHeatStructure1Phase::addVariables(), HSBoundaryExternalAppHeatFlux::addVariables(), FlowChannelBase::addVariables(), VolumeJunction1Phase::addVolumeJunctionIC(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), FlowChannel1PhaseBase::buildFlowModel(), HeatStructureInterface::buildModel(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), VolumeJunction1Phase::buildVolumeJunctionUserObject(), Shaft::check(), VolumeJunction1Phase::check(), FlowChannel1PhaseBase::check(), HeatStructureInterface::check(), FlowChannelGasMix::checkFluidProperties(), FlowChannel1Phase::checkFluidProperties(), GeometricalComponent::getVariableFn(), FlowJunction1Phase::init(), FlowBoundary1PhaseBase::init(), FlowBoundary::init(), FlowJunction::init(), Component1DConnection::init(), FlowChannelBase::init(), Component::problemIsTransient(), HeatStructure2DCouplerBase::setupMesh(), GateValve1Phase::setupMesh(), HSCoupler2D3D::setupMesh(), HSCoupler2D2DRadiation::setupMesh(), JunctionOneToOne1Phase::setupMesh(), HeatTransferFromHeatStructure1Phase::setupMesh(), VolumeJunction1Phase::setupMesh(), and HeatTransferFromHeatStructure3D1Phase::setupMesh().

{
  return _sim;
}

getTotalWidth()

const Real& Component2D::getTotalWidth ( ) const

inline

Gets the total width of all transverse regions.

Definition at line 33 of file Component2D.h.

Referenced by buildMesh().

{ return _total_width; }

getVariableFn()

const FunctionName & GeometricalComponent::getVariableFn ( const FunctionName &  fn_param_name )

protectedinherited

Makes a constant function parameter controllable and returns its name.

Parameters

[in]

fn_param_name

FunctionName parameter

Definition at line 79 of file GeometricalComponent.C.

{
  const FunctionName & fn_name = getParam<FunctionName>(fn_param_name);
  const Function & fn = getTHMProblem().getFunction(fn_name);

  if (dynamic_cast<const ConstantFunction *>(&fn) != nullptr)
  {
    connectObject(fn.parameters(), fn_name, fn_param_name, "value");
  }

  return fn_name;
}

getVolumes()

const std::vector<Real>& Component2D::getVolumes ( ) const

inline

Gets the volumes of the transverse regions.

Definition at line 55 of file Component2D.h.

{ return _volume; }

hasBlock()

bool Component2D::hasBlock

(

const std::string &

name

)

const

Returns true if there is a transverse region of a given name.

Parameters

name	The name of the transverse region

Definition at line 59 of file Component2D.C.

Referenced by HeatSourceBase::check().

{
  return std::find(_names.begin(), _names.end(), name) != _names.end();
}

hasBoundary()

bool Component2D::hasBoundary

(

const BoundaryName &

boundary_name

)

const

Returns true if this component has the supplied boundary.

Parameters

[in]

boundary_name

Boundary name to check

Definition at line 473 of file Component2D.C.

Referenced by HeatStructure2DRadiationCouplerRZ::check(), HeatStructure2DCouplerBase::check(), getExternalBoundaryType(), HeatStructure2DCouplerBase::init(), and HeatStructure2DCouplerBase::setupMesh().

{
  checkSetupStatus(MESH_PREPARED);

  return hasExternalBoundary(boundary_name) ||
         isBoundaryInVector(boundary_name, _boundary_names_interior_axial_per_radial_section) ||
         isBoundaryInVector(boundary_name, _boundary_names_inner_radial);
}

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

hasExternalBoundary()

bool Component2D::hasExternalBoundary

(

const BoundaryName &

boundary_name

)

const

Returns true if this component has the supplied external boundary.

Parameters

[in]

boundary_name

Boundary name to check

Definition at line 483 of file Component2D.C.

Referenced by HSBoundary::check(), and hasBoundary().

{
  checkSetupStatus(MESH_PREPARED);

  return boundary_name == _boundary_name_inner || boundary_name == _boundary_name_outer ||
         boundary_name == _boundary_name_start || boundary_name == _boundary_name_end ||
         isBoundaryInVector(boundary_name, _boundary_names_axial_inner) ||
         isBoundaryInVector(boundary_name, _boundary_names_axial_outer) ||
         isBoundaryInVector(boundary_name, _boundary_names_radial_start) ||
         isBoundaryInVector(boundary_name, _boundary_names_radial_end);
}

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

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

Definition at line 290 of file Component.h.

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

{}

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

isBoundaryInVector()

bool Component2D::isBoundaryInVector	(	const BoundaryName &	boundary_name,
		const std::vector< BoundaryName > &	boundary_name_vector
	)		const

Returns true if the supplied boundary is in the given vector.

Definition at line 465 of file Component2D.C.

Referenced by getExternalBoundaryType(), hasBoundary(), and hasExternalBoundary().

{
  return std::find(boundary_name_vector.begin(), boundary_name_vector.end(), boundary_name) !=
         boundary_name_vector.end();
}

logComponentError()

template<typename... Args>

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

inlineinherited

Logs an error for a component.

Parameters

[in]

component_name

Name of the component

Definition at line 47 of file LoggingInterface.h.

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

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

logComponentWarning()

template<typename... Args>

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

inlineinherited

Logs a warning for a component.

Parameters

[in]

component_name

Name of the component

Definition at line 67 of file LoggingInterface.h.

Referenced by Component::logWarning().

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

logError()

template<typename... Args>

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

inlineinherited

Logs an error.

Definition at line 215 of file Component.h.

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

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

logWarning()

template<typename... Args>

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

inlineinherited

Logs a warning.

Definition at line 224 of file Component.h.

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

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

makeFunctionControllableIfConstant()

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

inherited

Makes a function controllable if it is constant.

Parameters

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

Definition at line 141 of file Component.C.

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

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

mesh()

THMMesh & Component::mesh ( )

inherited

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

Definition at line 60 of file Component.C.

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

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

parent()

Component* Component::parent ( )

inlineinherited

Definition at line 54 of file Component.h.

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

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

overrideprotectedvirtualinherited

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

Reimplemented from Component.

Reimplemented in HeatStructureCylindricalBase.

Definition at line 38 of file GeneratedMeshComponent.C.

Referenced by HeatStructureCylindricalBase::setupMesh().

{
  generateNodeLocations();

  buildMesh();

  // displace nodes
  for (auto && node_id : _node_ids)
  {
    Node & curr_node = mesh().nodeRef(node_id);
    RealVectorValue p(curr_node(0), curr_node(1), curr_node(2));
    curr_node = computeRealPointFromReferencePoint(p);
  }
}

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

usingSecondOrderMesh()

virtual bool GeneratedMeshComponent::usingSecondOrderMesh ( ) const

protectedpure virtualinherited

Check if second order mesh is being used by this geometrical component.

Returns

true if second order mesh is being used, otherwise false

Implemented in Component1D, and HeatStructureBase.

Referenced by buildMesh(), GeneratedMeshComponent::check(), and GeneratedMeshComponent::computeNumberOfNodes().

validParams()

InputParameters Component2D::validParams ( )

static

Definition at line 35 of file Component2D.C.

Referenced by HeatStructureBase::validParams().

{
  InputParameters params = GeneratedMeshComponent::validParams();
  return params;
}

Member Data Documentation

_axial_inner_bc_id

std::vector<unsigned int> Component2D::_axial_inner_bc_id

protected

BC ID of the axial regions of the inner boundary of the component.

Definition at line 184 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_axial_offset

Real Component2D::_axial_offset

mutableprotected

Distance by which to offset the mesh from the component axis.

Definition at line 220 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), getAxialOffset(), and HeatStructureCylindricalBase::setupMesh().

_axial_outer_bc_id

std::vector<unsigned int> Component2D::_axial_outer_bc_id

protected

BC ID of the axial regions of the outer boundary of the component.

Definition at line 182 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_axial_region_names

const std::vector<std::string>& GeneratedMeshComponent::_axial_region_names

protectedinherited

Axial region names.

Definition at line 39 of file GeneratedMeshComponent.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), Component1D::buildMesh(), and GeneratedMeshComponent::GeneratedMeshComponent().

_boundary_info

std::map<BoundaryName, std::vector<std::tuple<dof_id_type, unsigned short int> > > Component2D::_boundary_info

protected

Map of boundary name to list of tuples of element and side IDs for that boundary.

Definition at line 217 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and getBoundaryInfo().

_boundary_name_end

BoundaryName Component2D::_boundary_name_end

protected

Boundary name of the end side of the component.

Definition at line 199 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getBoundaryInfo(), getExternalBoundaryName(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_name_inner

BoundaryName Component2D::_boundary_name_inner

protected

Boundary name of the inner side of the component.

Definition at line 195 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getBoundaryInfo(), getExternalBoundaryName(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_name_outer

BoundaryName Component2D::_boundary_name_outer

protected

Boundary name of the outer side of the component.

Definition at line 193 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getBoundaryInfo(), getExternalBoundaryName(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_name_start

BoundaryName Component2D::_boundary_name_start

protected

Boundary name of the start side of the component.

Definition at line 197 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getBoundaryInfo(), getExternalBoundaryName(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_name_to_area

std::map<BoundaryName, Real> Component2D::_boundary_name_to_area

protected

Map of boundary name to boundary area.

Definition at line 214 of file Component2D.h.

Referenced by buildMesh(), and getBoundaryArea().

_boundary_names_axial_inner

std::vector<BoundaryName> Component2D::_boundary_names_axial_inner

protected

Boundary names of the axial regions of the inner side of the component.

Definition at line 205 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_names_axial_outer

std::vector<BoundaryName> Component2D::_boundary_names_axial_outer

protected

Boundary names of the axial regions of the outer side of the component.

Definition at line 203 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_names_inner_radial

std::vector<BoundaryName> Component2D::_boundary_names_inner_radial

protected

Boundary names of the inner radial boundary regions of the component.

Definition at line 211 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), and hasBoundary().

_boundary_names_interior_axial_per_radial_section

std::vector<BoundaryName> Component2D::_boundary_names_interior_axial_per_radial_section

protected

Boundary names of the interior axial boundaries (per radial section) of the component.

Definition at line 201 of file Component2D.h.

Referenced by build2DMesh(), buildMesh(), and hasBoundary().

_boundary_names_radial_end

std::vector<BoundaryName> Component2D::_boundary_names_radial_end

protected

Boundary names of the radial regions of the end side of the component.

Definition at line 209 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getExternalBoundaryType(), and hasExternalBoundary().

_boundary_names_radial_start

std::vector<BoundaryName> Component2D::_boundary_names_radial_start

protected

Boundary names of the radial regions of the start side of the component.

Definition at line 207 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getExternalBoundaryType(), and hasExternalBoundary().

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

_dir

const RealVectorValue DiscreteLineSegmentInterface::_dir

protectedinherited

Normalized direction of axis from start position to end position.

Definition at line 95 of file DiscreteLineSegmentInterface.h.

Referenced by Component1D::buildMesh(), DiscreteLineSegmentInterface::computeAxialCoordinate(), DiscreteLineSegmentInterface::computeRadialCoordinate(), DiscreteLineSegmentInterface::getAlignmentAxis(), DiscreteLineSegmentInterface::getDirection(), and DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

_dir_unnormalized

const RealVectorValue& DiscreteLineSegmentInterface::_dir_unnormalized

protectedinherited

Unnormalized direction of axis from start position to end position.

Definition at line 93 of file DiscreteLineSegmentInterface.h.

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

_end_bc_id

unsigned int Component2D::_end_bc_id

protected

BC ID of the component (end)

Definition at line 178 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_external_boundary_type_to_enum

const std::map< std::string, Component2D::ExternalBoundaryType > Component2D::_external_boundary_type_to_enum

static

Initial value:

{{"INNER", ExternalBoundaryType::INNER},
                                                 {"OUTER", ExternalBoundaryType::OUTER},
                                                 {"START", ExternalBoundaryType::START},
                                                 {"END", ExternalBoundaryType::END}}

map of external boundary type string to enum

Definition at line 234 of file Component2D.h.

Referenced by getExternalBoundaryTypeMooseEnum(), and 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(), FlowChannel1PhaseBase::addHydraulicDiameterMaterial(), FormLossFromFunction1Phase::addMooseObjects(), InletMassFlowRateTemperature1Phase::addMooseObjects(), HSBoundaryRadiation::addMooseObjects(), HSBoundarySpecifiedTemperature::addMooseObjects(), HeatStructure2DCoupler::addMooseObjects(), InletFunction1Phase::addMooseObjects(), HeatStructure2DRadiationCouplerRZ::addMooseObjects(), InletDensityVelocity1Phase::addMooseObjects(), InletStagnationPressureTemperature1Phase::addMooseObjects(), Outlet1Phase::addMooseObjects(), HSBoundaryAmbientConvection::addMooseObjects(), HeatTransferFromHeatFlux1Phase::addMooseObjects(), SolidWall1Phase::addMooseObjects(), InletVelocityTemperature1Phase::addMooseObjects(), HeatSourceFromPowerDensity::addMooseObjects(), HeatSourceFromTotalPower::addMooseObjects(), HSBoundaryHeatFlux::addMooseObjects(), HeatSourceVolumetric1Phase::addMooseObjects(), FormLossFromExternalApp1Phase::addMooseObjects(), Shaft::addMooseObjects(), HeatTransferFromSpecifiedTemperature1Phase::addMooseObjects(), FreeBoundary1Phase::addMooseObjects(), GateValve1Phase::addMooseObjects(), TotalPower::addMooseObjects(), VolumeJunction1Phase::addMooseObjects(), HSBoundaryExternalAppTemperature::addMooseObjects(), SolidWallGasMix::addMooseObjects(), ShaftConnectedTurbine1Phase::addMooseObjects(), ShaftConnectedCompressor1Phase::addMooseObjects(), HeatTransferFromExternalAppHeatFlux1Phase::addMooseObjects(), FormLoss1PhaseBase::addMooseObjects(), ShaftConnectedMotor::addMooseObjects(), ShaftConnectedPump1Phase::addMooseObjects(), HSBoundaryExternalAppConvection::addMooseObjects(), HSCoupler2D2DRadiation::addMooseObjects(), HSCoupler2D3D::addMooseObjects(), SimpleTurbine1Phase::addMooseObjects(), HeatTransferBase::addMooseObjects(), HeatTransferFromHeatStructure3D1Phase::addMooseObjects(), HeatTransferFromHeatStructure1Phase::addMooseObjects(), HSBoundaryExternalAppHeatFlux::addMooseObjects(), JunctionOneToOne1Phase::addMooseObjects(), FlowChannelBase::addMooseObjects(), Component::addRelationshipManager(), FlowChannelBase::addVariables(), VolumeJunction1Phase::addVolumeJunctionIC(), FlowBoundary1Phase::addWeakBCs(), FlowBoundaryGasMix::addWeakBCs(), FlowChannel1PhaseBase::buildFlowModel(), Pump1Phase::buildVolumeJunctionUserObject(), JunctionParallelChannels1Phase::buildVolumeJunctionUserObject(), SimpleTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedTurbine1Phase::buildVolumeJunctionUserObject(), ShaftConnectedCompressor1Phase::buildVolumeJunctionUserObject(), ShaftConnectedPump1Phase::buildVolumeJunctionUserObject(), and VolumeJunction1Phase::buildVolumeJunctionUserObject().

_inner_bc_id

unsigned int Component2D::_inner_bc_id

protected

BC ID of the component (inner)

Definition at line 174 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_inner_radial_bc_id

std::vector<unsigned int> Component2D::_inner_radial_bc_id

protected

BC ID of the inner radial boundary regions of the component.

Definition at line 190 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_interior_axial_per_radial_section_bc_id

std::vector<unsigned int> Component2D::_interior_axial_per_radial_section_bc_id

protected

BC ID of the interior axial boundaries (per radial section) of the component.

Definition at line 180 of file Component2D.h.

Referenced by build2DMesh(), and buildMesh().

_length

Real DiscreteLineSegmentInterface::_length

protectedinherited

Total axial length.

Definition at line 102 of file DiscreteLineSegmentInterface.h.

Referenced by buildMesh(), Component1D::buildMesh(), DiscreteLineSegmentInterface::computeAxialCoordinate(), ElbowPipe1Phase::ElbowPipe1Phase(), DiscreteLineSegmentInterface::getLength(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_lengths

std::vector<Real> DiscreteLineSegmentInterface::_lengths

protectedinherited

Length of each axial section.

Definition at line 100 of file DiscreteLineSegmentInterface.h.

Referenced by buildMesh(), DiscreteLineSegmentInterface::DiscreteLineSegmentInterface(), ElbowPipe1Phase::ElbowPipe1Phase(), GeneratedMeshComponent::generateNodeLocations(), and DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

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

_moose_object_name_dlsi

const std::string DiscreteLineSegmentInterface::_moose_object_name_dlsi

protectedinherited

Name of the MOOSE object.

Definition at line 128 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::computeAxialCoordinate().

_n_elem

const unsigned int DiscreteLineSegmentInterface::_n_elem

protectedinherited

Total number of axial elements.

Definition at line 107 of file DiscreteLineSegmentInterface.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), Component1D::buildMesh(), GeneratedMeshComponent::generateNodeLocations(), DiscreteLineSegmentInterface::getAxialElementIndex(), and DiscreteLineSegmentInterface::getNumElems().

_n_elems

const std::vector<unsigned int>& DiscreteLineSegmentInterface::_n_elems

protectedinherited

Number of elements in each axial section.

Definition at line 105 of file DiscreteLineSegmentInterface.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), Component1D::buildMesh(), DiscreteLineSegmentInterface::DiscreteLineSegmentInterface(), GeneratedMeshComponent::generateNodeLocations(), and DiscreteLineSegmentInterface::getElementBoundaryCoordinates().

_n_part_elems

std::vector<unsigned int> Component2D::_n_part_elems

protected

Number of elements in each transverse region.

Definition at line 167 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_n_regions

unsigned int Component2D::_n_regions

protected

Number of transverse regions.

Definition at line 157 of file Component2D.h.

Referenced by HeatStructureBase::addMooseObjects(), build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getNumRegions(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_n_sections

const unsigned int DiscreteLineSegmentInterface::_n_sections

protectedinherited

Number of axial sections.

Definition at line 110 of file DiscreteLineSegmentInterface.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), check(), DiscreteLineSegmentInterface::DiscreteLineSegmentInterface(), GeneratedMeshComponent::generateNodeLocations(), and DiscreteLineSegmentInterface::getAxialSectionIndex().

_names

std::vector<std::string> Component2D::_names

protected

Names of each transverse region.

Definition at line 159 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), getNames(), hasBlock(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

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

_node_locations

std::vector<Real> GeneratedMeshComponent::_node_locations

protectedinherited

Node locations along the main axis.

Definition at line 42 of file GeneratedMeshComponent.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), ElbowPipe1Phase::buildMeshNodes(), Component1D::buildMeshNodes(), GeneratedMeshComponent::generateNodeLocations(), and GeneratedMeshComponent::placeLocalNodeLocations().

_outer_bc_id

unsigned int Component2D::_outer_bc_id

protected

BC ID of the component (outer)

Definition at line 172 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_parent

Component* Component::_parent

protectedinherited

Pointer to a parent component (used in composed components)

Definition at line 438 of file Component.h.

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

_position

const Point& DiscreteLineSegmentInterface::_position

protectedinherited

Start position of axis in 3-D space.

Definition at line 91 of file DiscreteLineSegmentInterface.h.

Referenced by Component1D::buildMesh(), DiscreteLineSegmentInterface::computeAxialCoordinate(), DiscreteLineSegmentInterface::computeRadialCoordinate(), DiscreteLineSegmentInterface::computeRealPointFromReferencePoint(), DiscreteLineSegmentInterface::computeReferencePointFromRealPoint(), DiscreteLineSegmentInterface::getElementBoundaryCoordinates(), and DiscreteLineSegmentInterface::getPosition().

_R

const RealTensorValue DiscreteLineSegmentInterface::_R

protectedinherited

Direction transformation tensor.

Definition at line 118 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::computeRealPointFromReferencePoint().

_R_inv

const RealTensorValue DiscreteLineSegmentInterface::_R_inv

protectedinherited

Inverse direction transformation tensor.

Definition at line 123 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::computeReferencePointFromRealPoint().

_radial_end_bc_id

std::vector<unsigned int> Component2D::_radial_end_bc_id

protected

BC ID of the radial regions of the end boundary of the component.

Definition at line 188 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_radial_start_bc_id

std::vector<unsigned int> Component2D::_radial_start_bc_id

protected

BC ID of the radial regions of the start boundary of the component.

Definition at line 186 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

_rotation

const Real& DiscreteLineSegmentInterface::_rotation

protectedinherited

Angle of rotation about the x-axis.

Definition at line 97 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::getElementBoundaryCoordinates(), and DiscreteLineSegmentInterface::getRotation().

_Rx

const RealTensorValue DiscreteLineSegmentInterface::_Rx

protectedinherited

Rotational transformation tensor about x-axis.

Definition at line 120 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::computeRealPointFromReferencePoint().

_Rx_inv

const RealTensorValue DiscreteLineSegmentInterface::_Rx_inv

protectedinherited

Inverse rotational transformation tensor about x-axis.

Definition at line 125 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::computeReferencePointFromRealPoint().

_section_end

std::vector<Real> DiscreteLineSegmentInterface::_section_end

protectedinherited

Axial coordinate of the end of each axial section using the line 'position' as the origin.

Definition at line 112 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::DiscreteLineSegmentInterface(), and DiscreteLineSegmentInterface::getAxialSectionIndex().

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

_start_bc_id

unsigned int Component2D::_start_bc_id

protected

BC ID of the component (start)

Definition at line 176 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), and buildMesh().

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

_total_elem_number

unsigned int Component2D::_total_elem_number

protected

Total number of transverse elements.

Definition at line 169 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_total_width

Real Component2D::_total_width

protected

Total width of all transverse regions.

Definition at line 163 of file Component2D.h.

Referenced by getTotalWidth(), HeatStructureCylindricalBase::getUnitPerimeter(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_volume

std::vector<Real> Component2D::_volume

protected

Volume of each transverse region.

Definition at line 165 of file Component2D.h.

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

_width

std::vector<Real> Component2D::_width

protected

Width of each transverse region.

Definition at line 161 of file Component2D.h.

Referenced by build2DMesh(), build2DMesh2ndOrder(), buildMesh(), HeatStructureCylindrical::HeatStructureCylindrical(), and HeatStructurePlate::HeatStructurePlate().

_x_centers

std::vector<Real> DiscreteLineSegmentInterface::_x_centers

protectedinherited

Center axial coordinate of each axial element.

Definition at line 115 of file DiscreteLineSegmentInterface.h.

Referenced by DiscreteLineSegmentInterface::DiscreteLineSegmentInterface(), and DiscreteLineSegmentInterface::getAxialElementIndex().

_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/Component2D.h
• thermal_hydraulics/src/components/Component2D.C