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

#include <ShaftConnectableUserObjectInterface.h>

Inheritance diagram for ShaftConnectableUserObjectInterface:

Public Member Functions
	ShaftConnectableUserObjectInterface (const MooseObject *moose_object)

virtual void	initialize ()

virtual void	execute ()

virtual void	finalize ()

virtual void	threadJoin (const UserObject &uo)

virtual Real	getTorque () const

virtual void	getTorqueJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) const

virtual Real	getMomentOfInertia () const

virtual void	getMomentOfInertiaJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) 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< std::vector< Real >>> &phi_face_values, 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...

virtual void	computeMomentOfInertiaScalarJacobianWRTFlowDofs (const DenseMatrix< Real > &jac, const unsigned int &c)

virtual void	computeTorqueScalarJacobianWRTFlowDofs (const DenseMatrix< Real > &jac, const unsigned int &c)

Protected Attributes
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...

Real	_torque
	Total torque. More...

Real	_moment_of_inertia
	Moment of inertia. More...

std::vector< DenseMatrix< Real > >	_torque_jacobian_flow_channel_vars
	Cached scalar residual Jacobian matrices w.r.t. More...

DenseMatrix< Real >	_torque_jacobian_scalar_vars
	Jacobian entries of torque wrt to scalar variables (from junction) More...

DenseMatrix< Real >	_torque_jacobian_omega_var
	Jacobian entries of torque wrt to omega variable (from shaft) More...

std::vector< DenseMatrix< Real > >	_moi_jacobian_flow_channel_vars

DenseMatrix< Real >	_moi_jacobian_scalar_vars
	Jacobian entries of moment of inertia wrt to omega scalar variables (from junction) More...

DenseMatrix< Real >	_moi_jacobian_omega_var
	Jacobian entries of moment of inertia wrt to omega variable (from shaft) More...

std::vector< std::vector< std::vector< Real > > >	_phi_face_values
	Side shape function value (i.e. side from the flow channels) More...

Detailed Description

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

Definition at line 22 of file ShaftConnectableUserObjectInterface.h.

Constructor & Destructor Documentation

◆ ShaftConnectableUserObjectInterface()

ShaftConnectableUserObjectInterface::ShaftConnectableUserObjectInterface ( const MooseObject * moose_object )

Definition at line 21 of file ShaftConnectableUserObjectInterface.C.

   : _n_shaft_eq(1)
 {
   _omega_dof.resize(_n_shaft_eq);
   _torque_jacobian_omega_var.resize(1, _n_shaft_eq);
   _moi_jacobian_omega_var.resize(1, _n_shaft_eq);
 }

Member Function Documentation

◆ computeMomentOfInertiaScalarJacobianWRTFlowDofs()

void ShaftConnectableUserObjectInterface::computeMomentOfInertiaScalarJacobianWRTFlowDofs	(	const DenseMatrix< Real > &	jac,
		const unsigned int &	c
	)

protectedvirtual

Definition at line 177 of file ShaftConnectableUserObjectInterface.C.

 {
   _moi_jacobian_flow_channel_vars[c].resize(1, _flow_channel_dofs[c].size());
   unsigned int jk = 0;
   for (unsigned int j = 0; j < _n_flow_eq; j++)
   {
     for (unsigned int k = 0; k < _phi_face_values[c][j].size(); k++)
     {
       _moi_jacobian_flow_channel_vars[c](0, jk) = jac(0, j) * _phi_face_values[c][j][k];
       jk++;
     }
   }
 }

◆ computeTorqueScalarJacobianWRTFlowDofs()

void ShaftConnectableUserObjectInterface::computeTorqueScalarJacobianWRTFlowDofs	(	const DenseMatrix< Real > &	jac,
		const unsigned int &	c
	)

protectedvirtual

Definition at line 161 of file ShaftConnectableUserObjectInterface.C.

 {
   _torque_jacobian_flow_channel_vars[c].resize(1, _flow_channel_dofs[c].size());
   unsigned int jk = 0;
   for (unsigned int j = 0; j < _n_flow_eq; j++)
   {
     for (unsigned int k = 0; k < _phi_face_values[c][j].size(); k++)
     {
       _torque_jacobian_flow_channel_vars[c](0, jk) = jac(0, j) * _phi_face_values[c][j][k];
       jk++;
     }
   }
 }

◆ execute()

void ShaftConnectableUserObjectInterface::execute ( )

virtual

Reimplemented in ShaftConnectedMotorUserObject.

Definition at line 38 of file ShaftConnectableUserObjectInterface.C.

39 {

40 }

◆ finalize()

void ShaftConnectableUserObjectInterface::finalize ( )

virtual

Reimplemented in ShaftConnectedMotorUserObject.

Definition at line 193 of file ShaftConnectableUserObjectInterface.C.

194 {

195 }

◆ getMomentOfInertia()

Real ShaftConnectableUserObjectInterface::getMomentOfInertia ( ) const

virtual

Reimplemented in ShaftConnectedMotorUserObject.

Definition at line 84 of file ShaftConnectableUserObjectInterface.C.

 {
   return _moment_of_inertia;
 }

◆ getMomentOfInertiaJacobianData()

void ShaftConnectableUserObjectInterface::getMomentOfInertiaJacobianData	(	DenseMatrix< Real > &	jacobian_block,
		std::vector< dof_id_type > &	dofs_j
	)		const

virtual

Definition at line 90 of file ShaftConnectableUserObjectInterface.C.

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
 
   unsigned int n_dofs = 1 + _scalar_dofs.size();
   for (unsigned int c = 0; c < _n_connections; c++)
     n_dofs += _moi_jacobian_flow_channel_vars[c].n();
 
   jacobian_block.resize(_n_shaft_eq, n_dofs);
   dofs_j.resize(n_dofs);
 
   unsigned int k = 0;
   jacobian_block(0, k) = _moi_jacobian_omega_var(0, 0);
   dofs_j[k] = _omega_dof[0];
   k++;
 
   // Store Jacobian entries w.r.t. scalar variables
   for (unsigned int j = 0; j < _scalar_dofs.size(); j++, k++)
   {
     jacobian_block(0, k) = _moi_jacobian_scalar_vars(0, j);
     dofs_j[k] = _scalar_dofs[j];
   }
   // Store Jacobian entries w.r.t. flow variables
   for (unsigned int c = 0; c < _n_connections; c++)
   {
     for (unsigned int j = 0; j < _moi_jacobian_flow_channel_vars[c].n(); j++, k++)
     {
       jacobian_block(0, k) = _moi_jacobian_flow_channel_vars[c](0, j);
       dofs_j[k] = _flow_channel_dofs[c][j];
     }
   }
 }

◆ getTorque()

Real ShaftConnectableUserObjectInterface::getTorque ( ) const

virtual

Reimplemented in ShaftConnectedMotorUserObject.

Definition at line 43 of file ShaftConnectableUserObjectInterface.C.

Referenced by ShaftComponentTorqueScalarKernel::computeResidual().

 {
   return _torque;
 }

◆ getTorqueJacobianData()

void ShaftConnectableUserObjectInterface::getTorqueJacobianData	(	DenseMatrix< Real > &	jacobian_block,
		std::vector< dof_id_type > &	dofs_j
	)		const

virtual

Definition at line 49 of file ShaftConnectableUserObjectInterface.C.

Referenced by ShaftComponentTorqueScalarKernel::computeJacobian().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
 
   unsigned int n_dofs = 1 + _scalar_dofs.size();
   for (unsigned int c = 0; c < _n_connections; c++)
     n_dofs += _torque_jacobian_flow_channel_vars[c].n();
 
   jacobian_block.resize(_n_shaft_eq, n_dofs);
   dofs_j.resize(n_dofs);
 
   unsigned int k = 0;
   jacobian_block(0, k) = _torque_jacobian_omega_var(0, 0);
   dofs_j[k] = _omega_dof[0];
   k++;
 
   // Store Jacobian entries w.r.t. scalar variables
   for (unsigned int j = 0; j < _scalar_dofs.size(); j++, k++)
   {
     jacobian_block(0, k) = _torque_jacobian_scalar_vars(0, j);
     dofs_j[k] = _scalar_dofs[j];
   }
   // Store Jacobian entries w.r.t. flow variables
   for (unsigned int c = 0; c < _n_connections; c++)
   {
     for (unsigned int j = 0; j < _torque_jacobian_flow_channel_vars[c].n(); j++, k++)
     {
       jacobian_block(0, k) = _torque_jacobian_flow_channel_vars[c](0, j);
       dofs_j[k] = _flow_channel_dofs[c][j];
     }
   }
 }

◆ initialize()

void ShaftConnectableUserObjectInterface::initialize ( )

virtual

Reimplemented in ShaftConnectedMotorUserObject.

Definition at line 31 of file ShaftConnectableUserObjectInterface.C.

 {
   _torque = 0;
   _moment_of_inertia = 0;
 }

◆ setConnectionData()

void ShaftConnectableUserObjectInterface::setConnectionData	(	const std::vector< std::vector< std::vector< Real >>> &	phi_face_values,
		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 136 of file ShaftConnectableUserObjectInterface.C.

 {
   _flow_channel_dofs = flow_channel_dofs;
   _phi_face_values = phi_face_values;
 }

◆ setOmegaDofs()

void ShaftConnectableUserObjectInterface::setOmegaDofs ( const MooseVariableScalar * omega_var )

protectedvirtual

Definition at line 145 of file ShaftConnectableUserObjectInterface.C.

 {
   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 ShaftConnectableUserObjectInterface::setupConnections	(	unsigned int	n_connections,
		unsigned int	n_flow_eq
	)

protectedvirtual

Definition at line 125 of file ShaftConnectableUserObjectInterface.C.

 {
   _n_connections = n_connections;
   _torque_jacobian_flow_channel_vars.resize(_n_connections);
   _moi_jacobian_flow_channel_vars.resize(_n_connections);
 
   _n_flow_eq = n_flow_eq;
 }

◆ setupJunctionData()

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

protectedvirtual

Stores data associated with a junction component.

Definition at line 155 of file ShaftConnectableUserObjectInterface.C.

 {
   _scalar_dofs = scalar_dofs;
 }

◆ threadJoin()

void ShaftConnectableUserObjectInterface::threadJoin ( const UserObject & uo )

virtual

Definition at line 198 of file ShaftConnectableUserObjectInterface.C.

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

◆ validParams()

InputParameters ShaftConnectableUserObjectInterface::validParams ( )

static

Definition at line 15 of file ShaftConnectableUserObjectInterface.C.

Referenced by ShaftConnectedMotorUserObject::validParams().

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

Member Data Documentation

◆ _flow_channel_dofs

std::vector<std::vector<dof_id_type> > ShaftConnectableUserObjectInterface::_flow_channel_dofs

protected

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

Definition at line 70 of file ShaftConnectableUserObjectInterface.h.

Referenced by computeMomentOfInertiaScalarJacobianWRTFlowDofs(), computeTorqueScalarJacobianWRTFlowDofs(), getMomentOfInertiaJacobianData(), getTorqueJacobianData(), and setConnectionData().

◆ _moi_jacobian_flow_channel_vars

std::vector<DenseMatrix<Real> > ShaftConnectableUserObjectInterface::_moi_jacobian_flow_channel_vars

protected

Definition at line 84 of file ShaftConnectableUserObjectInterface.h.

Referenced by computeMomentOfInertiaScalarJacobianWRTFlowDofs(), getMomentOfInertiaJacobianData(), and setupConnections().

◆ _moi_jacobian_omega_var

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_moi_jacobian_omega_var

protected

Jacobian entries of moment of inertia wrt to omega variable (from shaft)

Definition at line 88 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData(), and ShaftConnectableUserObjectInterface().

◆ _moi_jacobian_scalar_vars

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_moi_jacobian_scalar_vars

protected

Jacobian entries of moment of inertia wrt to omega scalar variables (from junction)

Definition at line 86 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData().

◆ _moment_of_inertia

Real ShaftConnectableUserObjectInterface::_moment_of_inertia

protected

Moment of inertia.

Definition at line 74 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertia(), initialize(), and threadJoin().

◆ _n_connections

unsigned int ShaftConnectableUserObjectInterface::_n_connections

protected

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

Definition at line 61 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData(), getTorqueJacobianData(), and setupConnections().

◆ _n_flow_eq

unsigned int ShaftConnectableUserObjectInterface::_n_flow_eq

protected

Number of flow variables in connected flow channels.

Definition at line 63 of file ShaftConnectableUserObjectInterface.h.

Referenced by computeMomentOfInertiaScalarJacobianWRTFlowDofs(), computeTorqueScalarJacobianWRTFlowDofs(), and setupConnections().

◆ _n_shaft_eq

unsigned int ShaftConnectableUserObjectInterface::_n_shaft_eq

protected

Number of equation in the shaft component.

Definition at line 59 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData(), getTorqueJacobianData(), and ShaftConnectableUserObjectInterface().

◆ _omega_dof

std::vector<dof_id_type> ShaftConnectableUserObjectInterface::_omega_dof

protected

Degrees of freedom for omega variable (from shaft)

Definition at line 66 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData(), getTorqueJacobianData(), setOmegaDofs(), and ShaftConnectableUserObjectInterface().

◆ _phi_face_values

std::vector<std::vector<std::vector<Real> > > ShaftConnectableUserObjectInterface::_phi_face_values

protected

Side shape function value (i.e. side from the flow channels)

Definition at line 91 of file ShaftConnectableUserObjectInterface.h.

Referenced by computeMomentOfInertiaScalarJacobianWRTFlowDofs(), computeTorqueScalarJacobianWRTFlowDofs(), and setConnectionData().

◆ _scalar_dofs

std::vector<dof_id_type> ShaftConnectableUserObjectInterface::_scalar_dofs

protected

Degrees of freedom for scalar variables (from junction)

Definition at line 68 of file ShaftConnectableUserObjectInterface.h.

Referenced by getMomentOfInertiaJacobianData(), getTorqueJacobianData(), and setupJunctionData().

◆ _torque

Real ShaftConnectableUserObjectInterface::_torque

protected

Total torque.

Definition at line 72 of file ShaftConnectableUserObjectInterface.h.

Referenced by getTorque(), initialize(), and threadJoin().

◆ _torque_jacobian_flow_channel_vars

std::vector<DenseMatrix<Real> > ShaftConnectableUserObjectInterface::_torque_jacobian_flow_channel_vars

protected

Cached scalar residual Jacobian matrices w.r.t.

flow channel variables, for each connection (first index) and each scalar variable (second index)

Definition at line 78 of file ShaftConnectableUserObjectInterface.h.

Referenced by computeTorqueScalarJacobianWRTFlowDofs(), getTorqueJacobianData(), and setupConnections().

◆ _torque_jacobian_omega_var

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_torque_jacobian_omega_var

protected

Jacobian entries of torque wrt to omega variable (from shaft)

Definition at line 82 of file ShaftConnectableUserObjectInterface.h.

Referenced by getTorqueJacobianData(), and ShaftConnectableUserObjectInterface().

◆ _torque_jacobian_scalar_vars

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_torque_jacobian_scalar_vars

protected

Jacobian entries of torque wrt to scalar variables (from junction)

Definition at line 80 of file ShaftConnectableUserObjectInterface.h.

Referenced by getTorqueJacobianData().

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

thermal_hydraulics/include/interfaces/ShaftConnectableUserObjectInterface.h
thermal_hydraulics/src/interfaces/ShaftConnectableUserObjectInterface.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShaftConnectableUserObjectInterface()

Member Function Documentation

◆ computeMomentOfInertiaScalarJacobianWRTFlowDofs()

◆ computeTorqueScalarJacobianWRTFlowDofs()

◆ execute()

◆ finalize()

◆ getMomentOfInertia()

◆ getMomentOfInertiaJacobianData()

◆ getTorque()

◆ getTorqueJacobianData()

◆ initialize()

◆ setConnectionData()

◆ setOmegaDofs()

◆ setupConnections()

◆ setupJunctionData()

◆ threadJoin()

◆ validParams()

Member Data Documentation

◆ _flow_channel_dofs

◆ _moi_jacobian_flow_channel_vars

◆ _moi_jacobian_omega_var

◆ _moi_jacobian_scalar_vars

◆ _moment_of_inertia

◆ _n_connections

◆ _n_flow_eq

◆ _n_shaft_eq

◆ _omega_dof

◆ _phi_face_values

◆ _scalar_dofs

◆ _torque

◆ _torque_jacobian_flow_channel_vars

◆ _torque_jacobian_omega_var

◆ _torque_jacobian_scalar_vars