ShaftConnectable Class Reference

Interface class for components that connect to a shaft. More...

#include <ShaftConnectable.h>

Inheritance diagram for ShaftConnectable:

Public Member Functions
	ShaftConnectable (const Component *const component)
virtual void	checkShaftConnection (const Component *const component) const
virtual VariableName	getMomentofInertiaVariableName () const
virtual VariableName	getTorqueVariableName () const
virtual UserObjectName	getShaftConnectedUserObjectName () const
virtual void	setShaftName (const std::string &name) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
VariableName	_moment_of_inertia_var_name
	Moment of inertia variable name. More...
VariableName	_torque_var_name
	Torque of variable name. More...
UserObjectName	_user_object_name
	Shaft-connectable user object name. More...
std::string	_shaft_name
	Name of the shaft component. More...
bool	_connected_to_shaft
	Flag indicating that a shaft has this component connected. More...

Detailed Description

Interface class for components that connect to a shaft.

Definition at line 19 of file ShaftConnectable.h.

Constructor & Destructor Documentation

ShaftConnectable()

ShaftConnectable::ShaftConnectable

(

const Component *const

component

)

Definition at line 20 of file ShaftConnectable.C.

  : _moment_of_inertia_var_name(component->genName(component->name(), "moment_of_inertia")),
    _torque_var_name(component->genName(component->name(), "torque")),
    _user_object_name(component->genName(component->name(), "shaftconnected_uo")),
    _connected_to_shaft(false)
{
}

Member Function Documentation

checkShaftConnection()

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

virtual

Definition at line 29 of file ShaftConnectable.C.

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

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

getMomentofInertiaVariableName()

VariableName ShaftConnectable::getMomentofInertiaVariableName ( ) const

virtual

Definition at line 36 of file ShaftConnectable.C.

{
  return _moment_of_inertia_var_name;
}

getShaftConnectedUserObjectName()

UserObjectName ShaftConnectable::getShaftConnectedUserObjectName ( ) const

virtual

Reimplemented in ShaftConnectedCompressor1Phase, ShaftConnectedPump1Phase, and ShaftConnectedTurbine1Phase.

Definition at line 48 of file ShaftConnectable.C.

Referenced by ShaftConnectedMotor::addMooseObjects().

{
  return _user_object_name;
}

getTorqueVariableName()

VariableName ShaftConnectable::getTorqueVariableName ( ) const

virtual

Definition at line 42 of file ShaftConnectable.C.

{
  return _torque_var_name;
}

setShaftName()

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

virtual

Definition at line 54 of file ShaftConnectable.C.

Referenced by Shaft::init().

{
  _shaft_name = name;
  _connected_to_shaft = true;
}

validParams()

InputParameters ShaftConnectable::validParams ( )

static

Definition at line 14 of file ShaftConnectable.C.

Referenced by ShaftConnectedMotor::validParams(), ShaftConnectedTurbine1Phase::validParams(), ShaftConnectedPump1Phase::validParams(), and ShaftConnectedCompressor1Phase::validParams().

{
  InputParameters params = emptyInputParameters();
  return params;
}

Member Data Documentation

_connected_to_shaft

bool ShaftConnectable::_connected_to_shaft

mutableprotected

Flag indicating that a shaft has this component connected.

Definition at line 40 of file ShaftConnectable.h.

Referenced by checkShaftConnection(), and setShaftName().

_moment_of_inertia_var_name

VariableName ShaftConnectable::_moment_of_inertia_var_name

protected

Moment of inertia variable name.

Definition at line 32 of file ShaftConnectable.h.

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

_shaft_name

std::string ShaftConnectable::_shaft_name

mutableprotected

Name of the shaft component.

Definition at line 38 of file ShaftConnectable.h.

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

_torque_var_name

VariableName ShaftConnectable::_torque_var_name

protected

Torque of variable name.

Definition at line 34 of file ShaftConnectable.h.

Referenced by getTorqueVariableName().

_user_object_name

UserObjectName ShaftConnectable::_user_object_name

protected

Shaft-connectable user object name.

Definition at line 36 of file ShaftConnectable.h.

Referenced by getShaftConnectedUserObjectName().

---

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

• thermal_hydraulics/include/interfaces/ShaftConnectable.h
• thermal_hydraulics/src/interfaces/ShaftConnectable.C