https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ShaftTimeDerivativeScalarKernel Class Reference

Time derivative for angular speed of shaft. More...

#include <ShaftTimeDerivativeScalarKernel.h>

Inheritance diagram for ShaftTimeDerivativeScalarKernel:
[legend]

Public Types

enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 ShaftTimeDerivativeScalarKernel (const InputParameters &parameters)
 
virtual void reinit () override
 
virtual void computeResidual () override
 
virtual void computeJacobian () override
 
virtual const MooseVariableScalar & variable () const override
 
virtual bool isActive ()
 
const VariableValue & uOld () const
 
virtual bool computesJacobian () const
 
virtual void computeResidualAndJacobian ()
 
virtual void computeOffDiagJacobian (unsigned int)
 
virtual void computeOffDiagJacobianScalar (unsigned int)
 
virtual void computeNonlocalJacobian ()
 
virtual void computeNonlocalOffDiagJacobian (unsigned int)
 
const SubProblem & subProblem () const
 
virtual void prepareShapes (unsigned int var_num)
 
virtual std::set< std::string > additionalROVariables ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject (IsKokkosObjectKey &&) const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () 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 &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (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
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
virtual void meshChanged ()
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

virtual Real computeQpResidual () override
 
virtual Real computeQpJacobian () override
 
virtual void precalculateResidual ()
 
virtual void precalculateJacobian ()
 
virtual void precalculateOffDiagJacobian (unsigned int)
 
const MooseVariableFieldBase & getVariable (unsigned int jvar_num) const
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 

Protected Attributes

const VariableValue & _u_dot
 Time derivative of u. More...
 
const VariableValue & _du_dot_du
 Derivative of u_dot wrt u. More...
 
const std::vector< UserObjectName > & _uo_names
 List of names of shaft connected user objects. More...
 
unsigned int _n_components
 Number of shaft connected user objects. More...
 
std::vector< const ShaftConnectableUserObjectInterface * > _shaft_connected_uos
 List of shaft connected user objects. More...
 
const VariableValue & _u
 
MooseVariableScalar & _var
 
unsigned int _i
 
unsigned int _j
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
THREAD_ID _tid
 
Assembly & _assembly
 
MooseMesh & _mesh
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const Parallel::Communicator & _communicator
 

Detailed Description

Time derivative for angular speed of shaft.

Definition at line 19 of file ShaftTimeDerivativeScalarKernel.h.

Constructor & Destructor Documentation

◆ ShaftTimeDerivativeScalarKernel()

ShaftTimeDerivativeScalarKernel::ShaftTimeDerivativeScalarKernel ( const InputParameters &  parameters)

Definition at line 31 of file ShaftTimeDerivativeScalarKernel.C.

32  : ScalarKernel(parameters),
33  _u_dot(_var.uDot()),
34  _du_dot_du(_var.duDotDu()),
35  _uo_names(getParam<std::vector<UserObjectName>>("uo_names")),
36  _n_components(_uo_names.size())
37 {
38  _shaft_connected_uos.resize(_n_components);
39  for (unsigned int i = 0; i < _n_components; ++i)
40  {
41  _shaft_connected_uos[i] =
42  &getUserObjectByName<ShaftConnectableUserObjectInterface>(_uo_names[i]);
43  }
44 }
ScalarKernel::getParam
const T & getParam(const std::string &name) const
ScalarKernel::parameters
const InputParameters & parameters() const
ShaftTimeDerivativeScalarKernel::_shaft_connected_uos
std::vector< const ShaftConnectableUserObjectInterface * > _shaft_connected_uos
List of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:41
ShaftTimeDerivativeScalarKernel::_du_dot_du
const VariableValue & _du_dot_du
Derivative of u_dot wrt u.
Definition: ShaftTimeDerivativeScalarKernel.h:35
ScalarKernel::_var
MooseVariableScalar & _var
ShaftTimeDerivativeScalarKernel::_u_dot
const VariableValue & _u_dot
Time derivative of u.
Definition: ShaftTimeDerivativeScalarKernel.h:33
MooseVariableScalar::uDot
const VariableValue & uDot() const
ShaftTimeDerivativeScalarKernel::_n_components
unsigned int _n_components
Number of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:39
ScalarKernel::ScalarKernel
ScalarKernel(const InputParameters &parameters)
MooseVariableScalar::duDotDu
const VariableValue & duDotDu() const
ShaftTimeDerivativeScalarKernel::_uo_names
const std::vector< UserObjectName > & _uo_names
List of names of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:37

Member Function Documentation

◆ computeJacobian()

void ShaftTimeDerivativeScalarKernel::computeJacobian ( )
overridevirtual

Reimplemented from ScalarKernel.

Definition at line 66 of file ShaftTimeDerivativeScalarKernel.C.

67 {
68  prepareMatrixTag(_assembly, _var.number(), _var.number());
69 
70  Real sum_inertias = 0;
71  for (unsigned int i = 0; i < _n_components; ++i)
72  sum_inertias += _shaft_connected_uos[i]->getMomentOfInertia();
73 
74  // FIXME: Add dI_domega * domega_dt
75  _local_ke(0, 0) += sum_inertias * _du_dot_du[0];
76 
77  accumulateTaggedLocalMatrix();
78 
79  for (unsigned int i = 0; i < _n_components; ++i)
80  {
81  DenseMatrix<Real> jacobian_block;
82  std::vector<dof_id_type> dofs_j;
83  _shaft_connected_uos[i]->getMomentOfInertiaJacobianData(jacobian_block, dofs_j);
84  jacobian_block.scale(_u_dot[0]);
85  addJacobian(_assembly, jacobian_block, _var.dofIndices(), dofs_j, _var.scalingFactor());
86  }
87 }
MooseVariableScalar::number
unsigned int number() const
ShaftTimeDerivativeScalarKernel::_shaft_connected_uos
std::vector< const ShaftConnectableUserObjectInterface * > _shaft_connected_uos
List of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:41
ShaftTimeDerivativeScalarKernel::_du_dot_du
const VariableValue & _du_dot_du
Derivative of u_dot wrt u.
Definition: ShaftTimeDerivativeScalarKernel.h:35
ScalarKernel::_var
MooseVariableScalar & _var
ScalarKernel::_local_ke
DenseMatrix< Number > _local_ke
ShaftTimeDerivativeScalarKernel::_u_dot
const VariableValue & _u_dot
Time derivative of u.
Definition: ShaftTimeDerivativeScalarKernel.h:33
ScalarKernel::addJacobian
void addJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
MooseVariableScalar::dofIndices
virtual const std::vector< dof_id_type > & dofIndices() const
ScalarKernel::accumulateTaggedLocalMatrix
void accumulateTaggedLocalMatrix()
ShaftTimeDerivativeScalarKernel::_n_components
unsigned int _n_components
Number of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:39
ScalarKernel::_assembly
Assembly & _assembly
DenseMatrix< Real >::scale
void scale(const Real factor)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
ScalarKernel::prepareMatrixTag
void prepareMatrixTag(Assembly &assembly, unsigned int ivar, unsigned int jvar)
MooseVariableScalar::scalingFactor
void scalingFactor(const std::vector< Real > &factor)

◆ computeQpJacobian()

virtual Real ShaftTimeDerivativeScalarKernel::computeQpJacobian ( )
inlineoverrideprotectedvirtual

Reimplemented from ScalarKernel.

Definition at line 30 of file ShaftTimeDerivativeScalarKernel.h.

30 { mooseError("unused"); }
ScalarKernel::mooseError
void mooseError(Args &&... args) const

◆ computeQpResidual()

virtual Real ShaftTimeDerivativeScalarKernel::computeQpResidual ( )
inlineoverrideprotectedvirtual

Reimplemented from ScalarKernel.

Definition at line 29 of file ShaftTimeDerivativeScalarKernel.h.

29 { mooseError("unused"); }
ScalarKernel::mooseError
void mooseError(Args &&... args) const

◆ computeResidual()

void ShaftTimeDerivativeScalarKernel::computeResidual ( )
overridevirtual

Reimplemented from ScalarKernel.

Definition at line 52 of file ShaftTimeDerivativeScalarKernel.C.

53 {
54  prepareVectorTag(_assembly, _var.number());
55 
56  Real sum_inertias = 0;
57  for (unsigned int i = 0; i < _n_components; ++i)
58  sum_inertias += _shaft_connected_uos[i]->getMomentOfInertia();
59 
60  _local_re(0) += sum_inertias * _u_dot[0];
61 
62  accumulateTaggedLocalResidual();
63 }
ScalarKernel::accumulateTaggedLocalResidual
void accumulateTaggedLocalResidual()
MooseVariableScalar::number
unsigned int number() const
ShaftTimeDerivativeScalarKernel::_shaft_connected_uos
std::vector< const ShaftConnectableUserObjectInterface * > _shaft_connected_uos
List of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:41
ScalarKernel::_var
MooseVariableScalar & _var
ShaftTimeDerivativeScalarKernel::_u_dot
const VariableValue & _u_dot
Time derivative of u.
Definition: ShaftTimeDerivativeScalarKernel.h:33
ShaftTimeDerivativeScalarKernel::_n_components
unsigned int _n_components
Number of shaft connected user objects.
Definition: ShaftTimeDerivativeScalarKernel.h:39
ScalarKernel::_assembly
Assembly & _assembly
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
ScalarKernel::_local_re
DenseVector< Number > _local_re
ScalarKernel::prepareVectorTag
void prepareVectorTag(Assembly &assembly, unsigned int ivar)

◆ reinit()

void ShaftTimeDerivativeScalarKernel::reinit ( )
overridevirtual

Implements ScalarKernel.

Definition at line 47 of file ShaftTimeDerivativeScalarKernel.C.

48 {
49 }

◆ validParams()

InputParameters ShaftTimeDerivativeScalarKernel::validParams ( )
static

Definition at line 19 of file ShaftTimeDerivativeScalarKernel.C.

20 {
21  InputParameters params = ScalarKernel::validParams();
22  params.addRequiredParam<std::vector<UserObjectName>>("uo_names",
23  "Names of shaft-connectable user objects");
24  params.addClassDescription("Adds a time derivative term to the shaft ODE");
25  params.set<MultiMooseEnum>("vector_tags") = "time";
26  params.set<MultiMooseEnum>("matrix_tags") = "system time";
27 
28  return params;
29 }
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
ScalarKernel::validParams
static InputParameters validParams()

Member Data Documentation

◆ _du_dot_du

const VariableValue& ShaftTimeDerivativeScalarKernel::_du_dot_du
protected

Derivative of u_dot wrt u.

Definition at line 35 of file ShaftTimeDerivativeScalarKernel.h.

Referenced by computeJacobian().

◆ _n_components

unsigned int ShaftTimeDerivativeScalarKernel::_n_components
protected

Number of shaft connected user objects.

Definition at line 39 of file ShaftTimeDerivativeScalarKernel.h.

Referenced by computeJacobian(), computeResidual(), and ShaftTimeDerivativeScalarKernel().

◆ _shaft_connected_uos

std::vector<const ShaftConnectableUserObjectInterface *> ShaftTimeDerivativeScalarKernel::_shaft_connected_uos
protected

List of shaft connected user objects.

Definition at line 41 of file ShaftTimeDerivativeScalarKernel.h.

Referenced by computeJacobian(), computeResidual(), and ShaftTimeDerivativeScalarKernel().

◆ _u_dot

const VariableValue& ShaftTimeDerivativeScalarKernel::_u_dot
protected

Time derivative of u.

Definition at line 33 of file ShaftTimeDerivativeScalarKernel.h.

Referenced by computeJacobian(), and computeResidual().

◆ _uo_names

const std::vector<UserObjectName>& ShaftTimeDerivativeScalarKernel::_uo_names
protected

List of names of shaft connected user objects.

Definition at line 37 of file ShaftTimeDerivativeScalarKernel.h.

Referenced by ShaftTimeDerivativeScalarKernel().

The documentation for this class was generated from the following files:
Generated on Tue Nov 4 2025 20:26:21 for https://mooseframework.inl.gov by   doxygen 1.8.14