ADShaftConnectableUserObjectInterface Class Reference

Interface class for user objects that are connected to a shaft. More...

#include <ADShaftConnectableUserObjectInterface.h>

Inheritance diagram for ADShaftConnectableUserObjectInterface:

Public Member Functions
	ADShaftConnectableUserObjectInterface (const MooseObject *moose_object)
virtual void	initialize ()
virtual void	execute ()
virtual void	finalize ()
virtual void	threadJoin (const UserObject &uo)
virtual ADReal	getTorque () const
virtual ADReal	getMomentOfInertia () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	setupConnections (unsigned int n_connections, unsigned int n_flow_eq)
virtual void	setConnectionData (const std::vector< std::vector< dof_id_type >> &flow_channel_dofs)
	Stores data computed by a volume-junction-like object associated with the conection. More...
virtual void	setOmegaDofs (const MooseVariableScalar *omega_var)
virtual void	setupJunctionData (std::vector< dof_id_type > &scalar_dofs)
	Stores data associated with a junction component. More...

Protected Attributes
const MooseObject *	_moose_object
	Associated MOOSE object. More...
unsigned int	_n_shaft_eq
	Number of equation in the shaft component. More...
unsigned int	_n_connections
	Number of flow channels the shaft connected component is attached to. More...
unsigned int	_n_flow_eq
	Number of flow variables in connected flow channels. More...
std::vector< dof_id_type >	_omega_dof
	Degrees of freedom for omega variable (from shaft) More...
std::vector< dof_id_type >	_scalar_dofs
	Degrees of freedom for scalar variables (from junction) More...
std::vector< std::vector< dof_id_type > >	_flow_channel_dofs
	Degrees of freedom for flow channel variables, for each connection. More...
ADReal	_torque
	Total torque. More...
ADReal	_moment_of_inertia
	Moment of inertia. More...

Detailed Description

Interface class for user objects that are connected to a shaft.

Definition at line 22 of file ADShaftConnectableUserObjectInterface.h.

Constructor & Destructor Documentation

ADShaftConnectableUserObjectInterface()

ADShaftConnectableUserObjectInterface::ADShaftConnectableUserObjectInterface

(

const MooseObject *

moose_object

)

Definition at line 25 of file ADShaftConnectableUserObjectInterface.C.

  : _moose_object(moose_object), _n_shaft_eq(1)
{
  _omega_dof.resize(_n_shaft_eq);
}

Member Function Documentation

execute()

void ADShaftConnectableUserObjectInterface::execute ( )

virtual

Reimplemented in ADShaftConnectedPump1PhaseUserObject, ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, and ADShaftConnectedMotorUserObject.

Definition at line 40 of file ADShaftConnectableUserObjectInterface.C.

{
}

finalize()

void ADShaftConnectableUserObjectInterface::finalize ( )

virtual

Reimplemented in ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, ADShaftConnectedPump1PhaseUserObject, and ADShaftConnectedMotorUserObject.

Definition at line 88 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedMotorUserObject::finalize(), ADShaftConnectedPump1PhaseUserObject::finalize(), ADShaftConnectedTurbine1PhaseUserObject::finalize(), and ADShaftConnectedCompressor1PhaseUserObject::finalize().

{
  _moose_object->comm().sum(_torque);
  _moose_object->comm().sum(_moment_of_inertia);
}

getMomentOfInertia()

ADReal ADShaftConnectableUserObjectInterface::getMomentOfInertia ( ) const

virtual

Reimplemented in ADShaftConnectedMotorUserObject.

Definition at line 51 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ShaftConnectedCompressor1PhaseAux::computeValue(), ShaftConnectedPump1PhaseAux::computeValue(), ShaftConnectedTurbine1PhaseAux::computeValue(), and ShaftConnectedComponentPostprocessor::getValue().

{
  return _moment_of_inertia;
}

getTorque()

ADReal ADShaftConnectableUserObjectInterface::getTorque ( ) const

virtual

Reimplemented in ADShaftConnectedMotorUserObject.

Definition at line 45 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftComponentTorqueScalarKernel::computeQpResidual(), and ShaftConnectedComponentPostprocessor::getValue().

{
  return _torque;
}

initialize()

void ADShaftConnectableUserObjectInterface::initialize ( )

virtual

Reimplemented in ADShaftConnectedPump1PhaseUserObject, ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, and ADShaftConnectedMotorUserObject.

Definition at line 33 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedCompressor1PhaseUserObject::initialize(), ADShaftConnectedTurbine1PhaseUserObject::initialize(), and ADShaftConnectedPump1PhaseUserObject::initialize().

{
  _torque = 0;
  _moment_of_inertia = 0;
}

setConnectionData()

void ADShaftConnectableUserObjectInterface::setConnectionData ( const std::vector< std::vector< dof_id_type >> &  flow_channel_dofs )

protectedvirtual

Stores data computed by a volume-junction-like object associated with the conection.

Definition at line 65 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedCompressor1PhaseUserObject::execute(), ADShaftConnectedTurbine1PhaseUserObject::execute(), and ADShaftConnectedPump1PhaseUserObject::execute().

{
  _flow_channel_dofs = flow_channel_dofs;
}

setOmegaDofs()

void ADShaftConnectableUserObjectInterface::setOmegaDofs ( const MooseVariableScalar *  omega_var )

protectedvirtual

Definition at line 72 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedPump1PhaseUserObject::finalize(), ADShaftConnectedTurbine1PhaseUserObject::finalize(), and ADShaftConnectedCompressor1PhaseUserObject::finalize().

{
  auto && dofs = omega_var->dofIndices();
  mooseAssert(dofs.size() == 1,
              "There should be exactly 1 coupled DoF index for the variable '" + omega_var->name() +
                  "'.");
  _omega_dof = dofs;
}

setupConnections()

void ADShaftConnectableUserObjectInterface::setupConnections ( unsigned int  n_connections, unsigned int  n_flow_eq  )

protectedvirtual

Definition at line 57 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedCompressor1PhaseUserObject::initialSetup(), ADShaftConnectedTurbine1PhaseUserObject::initialSetup(), and ADShaftConnectedPump1PhaseUserObject::initialSetup().

{
  _n_connections = n_connections;
  _n_flow_eq = n_flow_eq;
}

setupJunctionData()

void ADShaftConnectableUserObjectInterface::setupJunctionData ( std::vector< dof_id_type > &  scalar_dofs )

protectedvirtual

Stores data associated with a junction component.

Definition at line 82 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedPump1PhaseUserObject::finalize(), ADShaftConnectedTurbine1PhaseUserObject::finalize(), and ADShaftConnectedCompressor1PhaseUserObject::finalize().

{
  _scalar_dofs = scalar_dofs;
}

threadJoin()

void ADShaftConnectableUserObjectInterface::threadJoin ( const UserObject &  uo )

virtual

Reimplemented in ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, and ADShaftConnectedPump1PhaseUserObject.

Definition at line 95 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedPump1PhaseUserObject::threadJoin(), ADShaftConnectedTurbine1PhaseUserObject::threadJoin(), and ADShaftConnectedCompressor1PhaseUserObject::threadJoin().

{
  const ADShaftConnectableUserObjectInterface & sctc_uo =
      dynamic_cast<const ADShaftConnectableUserObjectInterface &>(uo);
  _torque += sctc_uo._torque;
  _moment_of_inertia += sctc_uo._moment_of_inertia;
}

validParams()

InputParameters ADShaftConnectableUserObjectInterface::validParams ( )

static

Definition at line 19 of file ADShaftConnectableUserObjectInterface.C.

Referenced by ADShaftConnectedMotorUserObject::validParams(), ADShaftConnectedTurbine1PhaseUserObject::validParams(), ADShaftConnectedPump1PhaseUserObject::validParams(), and ADShaftConnectedCompressor1PhaseUserObject::validParams().

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

Member Data Documentation

_flow_channel_dofs

std::vector<std::vector<dof_id_type> > ADShaftConnectableUserObjectInterface::_flow_channel_dofs

protected

Degrees of freedom for flow channel variables, for each connection.

Definition at line 61 of file ADShaftConnectableUserObjectInterface.h.

Referenced by setConnectionData().

_moment_of_inertia

ADReal ADShaftConnectableUserObjectInterface::_moment_of_inertia

protected

Moment of inertia.

Definition at line 65 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedTurbine1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedCompressor1PhaseUserObject::computeFluxesAndResiduals(), finalize(), getMomentOfInertia(), initialize(), and threadJoin().

_moose_object

const MooseObject* ADShaftConnectableUserObjectInterface::_moose_object

protected

Associated MOOSE object.

Definition at line 48 of file ADShaftConnectableUserObjectInterface.h.

Referenced by finalize().

_n_connections

unsigned int ADShaftConnectableUserObjectInterface::_n_connections

protected

Number of flow channels the shaft connected component is attached to.

Definition at line 52 of file ADShaftConnectableUserObjectInterface.h.

Referenced by setupConnections().

_n_flow_eq

unsigned int ADShaftConnectableUserObjectInterface::_n_flow_eq

protected

Number of flow variables in connected flow channels.

Definition at line 54 of file ADShaftConnectableUserObjectInterface.h.

Referenced by setupConnections().

_n_shaft_eq

unsigned int ADShaftConnectableUserObjectInterface::_n_shaft_eq

protected

Number of equation in the shaft component.

Definition at line 50 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface().

_omega_dof

std::vector<dof_id_type> ADShaftConnectableUserObjectInterface::_omega_dof

protected

Degrees of freedom for omega variable (from shaft)

Definition at line 57 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface(), and setOmegaDofs().

_scalar_dofs

std::vector<dof_id_type> ADShaftConnectableUserObjectInterface::_scalar_dofs

protected

Degrees of freedom for scalar variables (from junction)

Definition at line 59 of file ADShaftConnectableUserObjectInterface.h.

Referenced by setupJunctionData().

_torque

ADReal ADShaftConnectableUserObjectInterface::_torque

protected

Total torque.

Definition at line 63 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedTurbine1PhaseUserObject::computeFluxesAndResiduals(), ADShaftConnectedCompressor1PhaseUserObject::computeFluxesAndResiduals(), finalize(), getTorque(), initialize(), and threadJoin().

---

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

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