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

User object to provide data for a shaft-connected motor. More...

#include <ShaftConnectedMotorUserObject.h>

Inheritance diagram for ShaftConnectedMotorUserObject:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 ShaftConnectedMotorUserObject (const InputParameters &params)
 
virtual Real getTorque () const override
 
virtual void getTorqueJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) const override
 
virtual Real getMomentOfInertia () const override
 
virtual void getMomentOfInertiaJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) const override
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
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 customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () 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
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyByName (const std::string &prop_name_in)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOldByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialProperty (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOld (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlder (const std::string &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
virtual bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
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 GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
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
 
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
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
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 Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
virtual void threadJoin (const UserObject &uo)
 
virtual void getTorqueJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) const
 
virtual void getMomentOfInertiaJacobianData (DenseMatrix< Real > &jacobian_block, std::vector< dof_id_type > &dofs_j) 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)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

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
 
static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) 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
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
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
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
virtual void getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
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)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const Function & _torque_fn
 Torque as a function of shaft speed. More...
 
const Function & _inertia_fn
 Moment of inertia as a function of shaft speed. More...
 
const VariableValue & _shaft_speed
 Shaft speed. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
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
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const bool _is_kokkos_object
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
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
 
const Parallel::Communicator & _communicator
 
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...
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Detailed Description

User object to provide data for a shaft-connected motor.

Definition at line 18 of file ShaftConnectedMotorUserObject.h.

Constructor & Destructor Documentation

◆ ShaftConnectedMotorUserObject()

ShaftConnectedMotorUserObject::ShaftConnectedMotorUserObject ( const InputParameters &  params)

Definition at line 29 of file ShaftConnectedMotorUserObject.C.

30  : GeneralUserObject(params),
31  ShaftConnectableUserObjectInterface(this),
32  _torque_fn(getFunction("torque")),
33  _inertia_fn(getFunction("inertia")),
34  _shaft_speed(coupledScalarValue("shaft_speed"))
35 {
36 }
GeneralUserObject::getFunction
const Function & getFunction(const std::string &name) const
ShaftConnectedMotorUserObject::_shaft_speed
const VariableValue & _shaft_speed
Shaft speed.
Definition: ShaftConnectedMotorUserObject.h:42
ShaftConnectableUserObjectInterface::ShaftConnectableUserObjectInterface
ShaftConnectableUserObjectInterface(const MooseObject *moose_object)
Definition: ShaftConnectableUserObjectInterface.C:21
GeneralUserObject::coupledScalarValue
const VariableValue & coupledScalarValue(const std::string &var_name, unsigned int comp=0) const
ShaftConnectedMotorUserObject::_torque_fn
const Function & _torque_fn
Torque as a function of shaft speed.
Definition: ShaftConnectedMotorUserObject.h:38
GeneralUserObject::GeneralUserObject
GeneralUserObject(const InputParameters &parameters)
ShaftConnectedMotorUserObject::_inertia_fn
const Function & _inertia_fn
Moment of inertia as a function of shaft speed.
Definition: ShaftConnectedMotorUserObject.h:40

Member Function Documentation

◆ computeMomentOfInertiaScalarJacobianWRTFlowDofs()

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

Definition at line 177 of file ShaftConnectableUserObjectInterface.C.

179 {
180  _moi_jacobian_flow_channel_vars[c].resize(1, _flow_channel_dofs[c].size());
181  unsigned int jk = 0;
182  for (unsigned int j = 0; j < _n_flow_eq; j++)
183  {
184  for (unsigned int k = 0; k < _phi_face_values[c][j].size(); k++)
185  {
186  _moi_jacobian_flow_channel_vars[c](0, jk) = jac(0, j) * _phi_face_values[c][j][k];
187  jk++;
188  }
189  }
190 }
ShaftConnectableUserObjectInterface::_phi_face_values
std::vector< std::vector< std::vector< Real > > > _phi_face_values
Side shape function value (i.e. side from the flow channels)
Definition: ShaftConnectableUserObjectInterface.h:91
ShaftConnectableUserObjectInterface::_n_flow_eq
unsigned int _n_flow_eq
Number of flow variables in connected flow channels.
Definition: ShaftConnectableUserObjectInterface.h:63
ShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ShaftConnectableUserObjectInterface.h:70
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
NS::k
static const std::string k
Definition: NS.h:130
ShaftConnectableUserObjectInterface::_moi_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _moi_jacobian_flow_channel_vars
Definition: ShaftConnectableUserObjectInterface.h:84

◆ computeTorqueScalarJacobianWRTFlowDofs()

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

Definition at line 161 of file ShaftConnectableUserObjectInterface.C.

163 {
164  _torque_jacobian_flow_channel_vars[c].resize(1, _flow_channel_dofs[c].size());
165  unsigned int jk = 0;
166  for (unsigned int j = 0; j < _n_flow_eq; j++)
167  {
168  for (unsigned int k = 0; k < _phi_face_values[c][j].size(); k++)
169  {
170  _torque_jacobian_flow_channel_vars[c](0, jk) = jac(0, j) * _phi_face_values[c][j][k];
171  jk++;
172  }
173  }
174 }
ShaftConnectableUserObjectInterface::_phi_face_values
std::vector< std::vector< std::vector< Real > > > _phi_face_values
Side shape function value (i.e. side from the flow channels)
Definition: ShaftConnectableUserObjectInterface.h:91
ShaftConnectableUserObjectInterface::_n_flow_eq
unsigned int _n_flow_eq
Number of flow variables in connected flow channels.
Definition: ShaftConnectableUserObjectInterface.h:63
ShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ShaftConnectableUserObjectInterface.h:70
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
ShaftConnectableUserObjectInterface::_torque_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _torque_jacobian_flow_channel_vars
Cached scalar residual Jacobian matrices w.r.t.
Definition: ShaftConnectableUserObjectInterface.h:78
NS::k
static const std::string k
Definition: NS.h:130

◆ execute()

void ShaftConnectedMotorUserObject::execute ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 68 of file ShaftConnectedMotorUserObject.C.

69 {
70 }

◆ finalize()

void ShaftConnectedMotorUserObject::finalize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 73 of file ShaftConnectedMotorUserObject.C.

74 {
75 }

◆ getMomentOfInertia()

Real ShaftConnectedMotorUserObject::getMomentOfInertia ( ) const
overridevirtual

Reimplemented from ShaftConnectableUserObjectInterface.

Definition at line 51 of file ShaftConnectedMotorUserObject.C.

52 {
53  return _inertia_fn.value(_shaft_speed[0], Point());
54 }
ShaftConnectedMotorUserObject::_shaft_speed
const VariableValue & _shaft_speed
Shaft speed.
Definition: ShaftConnectedMotorUserObject.h:42
Function::value
virtual Real value(Real t, const Point &p) const
ShaftConnectedMotorUserObject::_inertia_fn
const Function & _inertia_fn
Moment of inertia as a function of shaft speed.
Definition: ShaftConnectedMotorUserObject.h:40

◆ getMomentOfInertiaJacobianData() [1/2]

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

Definition at line 57 of file ShaftConnectedMotorUserObject.C.

59 {
60 }

◆ getMomentOfInertiaJacobianData() [2/2]

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

Definition at line 90 of file ShaftConnectableUserObjectInterface.C.

92 {
93  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
94 
95  unsigned int n_dofs = 1 + _scalar_dofs.size();
96  for (unsigned int c = 0; c < _n_connections; c++)
97  n_dofs += _moi_jacobian_flow_channel_vars[c].n();
98 
99  jacobian_block.resize(_n_shaft_eq, n_dofs);
100  dofs_j.resize(n_dofs);
101 
102  unsigned int k = 0;
103  jacobian_block(0, k) = _moi_jacobian_omega_var(0, 0);
104  dofs_j[k] = _omega_dof[0];
105  k++;
106 
107  // Store Jacobian entries w.r.t. scalar variables
108  for (unsigned int j = 0; j < _scalar_dofs.size(); j++, k++)
109  {
110  jacobian_block(0, k) = _moi_jacobian_scalar_vars(0, j);
111  dofs_j[k] = _scalar_dofs[j];
112  }
113  // Store Jacobian entries w.r.t. flow variables
114  for (unsigned int c = 0; c < _n_connections; c++)
115  {
116  for (unsigned int j = 0; j < _moi_jacobian_flow_channel_vars[c].n(); j++, k++)
117  {
118  jacobian_block(0, k) = _moi_jacobian_flow_channel_vars[c](0, j);
119  dofs_j[k] = _flow_channel_dofs[c][j];
120  }
121  }
122 }
ShaftConnectableUserObjectInterface::_moi_jacobian_omega_var
DenseMatrix< Real > _moi_jacobian_omega_var
Jacobian entries of moment of inertia wrt to omega variable (from shaft)
Definition: ShaftConnectableUserObjectInterface.h:88
ShaftConnectableUserObjectInterface::_n_shaft_eq
unsigned int _n_shaft_eq
Number of equation in the shaft component.
Definition: ShaftConnectableUserObjectInterface.h:59
ShaftConnectableUserObjectInterface::_omega_dof
std::vector< dof_id_type > _omega_dof
Degrees of freedom for omega variable (from shaft)
Definition: ShaftConnectableUserObjectInterface.h:66
ShaftConnectableUserObjectInterface::_moi_jacobian_scalar_vars
DenseMatrix< Real > _moi_jacobian_scalar_vars
Jacobian entries of moment of inertia wrt to omega scalar variables (from junction) ...
Definition: ShaftConnectableUserObjectInterface.h:86
ShaftConnectableUserObjectInterface::_scalar_dofs
std::vector< dof_id_type > _scalar_dofs
Degrees of freedom for scalar variables (from junction)
Definition: ShaftConnectableUserObjectInterface.h:68
ShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ShaftConnectableUserObjectInterface.h:70
DenseMatrix< Real >::resize
void resize(const unsigned int new_m, const unsigned int new_n)
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
NS::k
static const std::string k
Definition: NS.h:130
ShaftConnectableUserObjectInterface::_moi_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _moi_jacobian_flow_channel_vars
Definition: ShaftConnectableUserObjectInterface.h:84
ShaftConnectableUserObjectInterface::_n_connections
unsigned int _n_connections
Number of flow channels the shaft connected component is attached to.
Definition: ShaftConnectableUserObjectInterface.h:61

◆ getTorque()

Real ShaftConnectedMotorUserObject::getTorque ( ) const
overridevirtual

Reimplemented from ShaftConnectableUserObjectInterface.

Definition at line 39 of file ShaftConnectedMotorUserObject.C.

40 {
41  return _torque_fn.value(_shaft_speed[0], Point());
42 }
ShaftConnectedMotorUserObject::_shaft_speed
const VariableValue & _shaft_speed
Shaft speed.
Definition: ShaftConnectedMotorUserObject.h:42
ShaftConnectedMotorUserObject::_torque_fn
const Function & _torque_fn
Torque as a function of shaft speed.
Definition: ShaftConnectedMotorUserObject.h:38
Function::value
virtual Real value(Real t, const Point &p) const

◆ getTorqueJacobianData() [1/2]

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

Definition at line 45 of file ShaftConnectedMotorUserObject.C.

47 {
48 }

◆ getTorqueJacobianData() [2/2]

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

Definition at line 49 of file ShaftConnectableUserObjectInterface.C.

Referenced by ShaftComponentTorqueScalarKernel::computeJacobian().

51 {
52  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
53 
54  unsigned int n_dofs = 1 + _scalar_dofs.size();
55  for (unsigned int c = 0; c < _n_connections; c++)
56  n_dofs += _torque_jacobian_flow_channel_vars[c].n();
57 
58  jacobian_block.resize(_n_shaft_eq, n_dofs);
59  dofs_j.resize(n_dofs);
60 
61  unsigned int k = 0;
62  jacobian_block(0, k) = _torque_jacobian_omega_var(0, 0);
63  dofs_j[k] = _omega_dof[0];
64  k++;
65 
66  // Store Jacobian entries w.r.t. scalar variables
67  for (unsigned int j = 0; j < _scalar_dofs.size(); j++, k++)
68  {
69  jacobian_block(0, k) = _torque_jacobian_scalar_vars(0, j);
70  dofs_j[k] = _scalar_dofs[j];
71  }
72  // Store Jacobian entries w.r.t. flow variables
73  for (unsigned int c = 0; c < _n_connections; c++)
74  {
75  for (unsigned int j = 0; j < _torque_jacobian_flow_channel_vars[c].n(); j++, k++)
76  {
77  jacobian_block(0, k) = _torque_jacobian_flow_channel_vars[c](0, j);
78  dofs_j[k] = _flow_channel_dofs[c][j];
79  }
80  }
81 }
ShaftConnectableUserObjectInterface::_torque_jacobian_scalar_vars
DenseMatrix< Real > _torque_jacobian_scalar_vars
Jacobian entries of torque wrt to scalar variables (from junction)
Definition: ShaftConnectableUserObjectInterface.h:80
ShaftConnectableUserObjectInterface::_n_shaft_eq
unsigned int _n_shaft_eq
Number of equation in the shaft component.
Definition: ShaftConnectableUserObjectInterface.h:59
ShaftConnectableUserObjectInterface::_omega_dof
std::vector< dof_id_type > _omega_dof
Degrees of freedom for omega variable (from shaft)
Definition: ShaftConnectableUserObjectInterface.h:66
ShaftConnectableUserObjectInterface::_scalar_dofs
std::vector< dof_id_type > _scalar_dofs
Degrees of freedom for scalar variables (from junction)
Definition: ShaftConnectableUserObjectInterface.h:68
ShaftConnectableUserObjectInterface::_torque_jacobian_omega_var
DenseMatrix< Real > _torque_jacobian_omega_var
Jacobian entries of torque wrt to omega variable (from shaft)
Definition: ShaftConnectableUserObjectInterface.h:82
ShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ShaftConnectableUserObjectInterface.h:70
DenseMatrix< Real >::resize
void resize(const unsigned int new_m, const unsigned int new_n)
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
ShaftConnectableUserObjectInterface::_torque_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _torque_jacobian_flow_channel_vars
Cached scalar residual Jacobian matrices w.r.t.
Definition: ShaftConnectableUserObjectInterface.h:78
NS::k
static const std::string k
Definition: NS.h:130
ShaftConnectableUserObjectInterface::_n_connections
unsigned int _n_connections
Number of flow channels the shaft connected component is attached to.
Definition: ShaftConnectableUserObjectInterface.h:61

◆ initialize()

void ShaftConnectedMotorUserObject::initialize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 63 of file ShaftConnectedMotorUserObject.C.

64 {
65 }

◆ 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 
)
protectedvirtualinherited

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

Definition at line 136 of file ShaftConnectableUserObjectInterface.C.

139 {
140  _flow_channel_dofs = flow_channel_dofs;
141  _phi_face_values = phi_face_values;
142 }
ShaftConnectableUserObjectInterface::_phi_face_values
std::vector< std::vector< std::vector< Real > > > _phi_face_values
Side shape function value (i.e. side from the flow channels)
Definition: ShaftConnectableUserObjectInterface.h:91
ShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ShaftConnectableUserObjectInterface.h:70

◆ setOmegaDofs()

void ShaftConnectableUserObjectInterface::setOmegaDofs ( const MooseVariableScalar *  omega_var)
protectedvirtualinherited

Definition at line 145 of file ShaftConnectableUserObjectInterface.C.

146 {
147  auto && dofs = omega_var->dofIndices();
148  mooseAssert(dofs.size() == 1,
149  "There should be exactly 1 coupled DoF index for the variable '" + omega_var->name() +
150  "'.");
151  _omega_dof = dofs;
152 }
MooseVariableScalar::name
const std::string & name() const
MooseVariableScalar::dofIndices
virtual const std::vector< dof_id_type > & dofIndices() const
ShaftConnectableUserObjectInterface::_omega_dof
std::vector< dof_id_type > _omega_dof
Degrees of freedom for omega variable (from shaft)
Definition: ShaftConnectableUserObjectInterface.h:66

◆ setupConnections()

void ShaftConnectableUserObjectInterface::setupConnections ( unsigned int  n_connections,
unsigned int  n_flow_eq 
)
protectedvirtualinherited

Definition at line 125 of file ShaftConnectableUserObjectInterface.C.

127 {
128  _n_connections = n_connections;
129  _torque_jacobian_flow_channel_vars.resize(_n_connections);
130  _moi_jacobian_flow_channel_vars.resize(_n_connections);
131 
132  _n_flow_eq = n_flow_eq;
133 }
ShaftConnectableUserObjectInterface::_n_flow_eq
unsigned int _n_flow_eq
Number of flow variables in connected flow channels.
Definition: ShaftConnectableUserObjectInterface.h:63
ShaftConnectableUserObjectInterface::_torque_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _torque_jacobian_flow_channel_vars
Cached scalar residual Jacobian matrices w.r.t.
Definition: ShaftConnectableUserObjectInterface.h:78
ShaftConnectableUserObjectInterface::_moi_jacobian_flow_channel_vars
std::vector< DenseMatrix< Real > > _moi_jacobian_flow_channel_vars
Definition: ShaftConnectableUserObjectInterface.h:84
ShaftConnectableUserObjectInterface::_n_connections
unsigned int _n_connections
Number of flow channels the shaft connected component is attached to.
Definition: ShaftConnectableUserObjectInterface.h:61

◆ setupJunctionData()

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

Stores data associated with a junction component.

Definition at line 155 of file ShaftConnectableUserObjectInterface.C.

156 {
157  _scalar_dofs = scalar_dofs;
158 }
ShaftConnectableUserObjectInterface::_scalar_dofs
std::vector< dof_id_type > _scalar_dofs
Degrees of freedom for scalar variables (from junction)
Definition: ShaftConnectableUserObjectInterface.h:68

◆ threadJoin()

void ShaftConnectableUserObjectInterface::threadJoin ( const UserObject &  uo)
virtualinherited

Definition at line 198 of file ShaftConnectableUserObjectInterface.C.

199 {
200  const ShaftConnectableUserObjectInterface & sctc_uo =
201  dynamic_cast<const ShaftConnectableUserObjectInterface &>(uo);
202  _torque += sctc_uo._torque;
203  _moment_of_inertia += sctc_uo._moment_of_inertia;
204 }
ShaftConnectableUserObjectInterface
Interface class for user objects that are connected to a shaft.
Definition: ShaftConnectableUserObjectInterface.h:22

◆ validParams()

InputParameters ShaftConnectedMotorUserObject::validParams ( )
static

Definition at line 16 of file ShaftConnectedMotorUserObject.C.

17 {
18  InputParameters params = GeneralUserObject::validParams();
19  params += ShaftConnectableUserObjectInterface::validParams();
20  params.addRequiredParam<FunctionName>("torque", "Torque as a function of shaft speed");
21  params.addRequiredParam<FunctionName>("inertia",
22  "Moment of inertia as a function of shaft speed");
23  params.addRequiredCoupledVar("shaft_speed", "Shaft speed");
24  params.addClassDescription(
25  "Computes the torque and moment of inertia of a shaft connected motor");
26  return params;
27 }
GeneralUserObject::validParams
static InputParameters validParams()
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addRequiredCoupledVar
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _flow_channel_dofs

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

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

Definition at line 70 of file ShaftConnectableUserObjectInterface.h.

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

◆ _inertia_fn

const Function& ShaftConnectedMotorUserObject::_inertia_fn
protected

Moment of inertia as a function of shaft speed.

Definition at line 40 of file ShaftConnectedMotorUserObject.h.

Referenced by getMomentOfInertia().

◆ _moi_jacobian_flow_channel_vars

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

Definition at line 84 of file ShaftConnectableUserObjectInterface.h.

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

◆ _moi_jacobian_omega_var

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_moi_jacobian_omega_var
protectedinherited

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

Definition at line 88 of file ShaftConnectableUserObjectInterface.h.

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

◆ _moi_jacobian_scalar_vars

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_moi_jacobian_scalar_vars
protectedinherited

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

Definition at line 86 of file ShaftConnectableUserObjectInterface.h.

Referenced by ShaftConnectableUserObjectInterface::getMomentOfInertiaJacobianData().

◆ _moment_of_inertia

Real ShaftConnectableUserObjectInterface::_moment_of_inertia
protectedinherited

Moment of inertia.

Definition at line 74 of file ShaftConnectableUserObjectInterface.h.

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

◆ _n_connections

unsigned int ShaftConnectableUserObjectInterface::_n_connections
protectedinherited

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

Definition at line 61 of file ShaftConnectableUserObjectInterface.h.

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

◆ _n_flow_eq

unsigned int ShaftConnectableUserObjectInterface::_n_flow_eq
protectedinherited

Number of flow variables in connected flow channels.

Definition at line 63 of file ShaftConnectableUserObjectInterface.h.

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

◆ _n_shaft_eq

unsigned int ShaftConnectableUserObjectInterface::_n_shaft_eq
protectedinherited

Number of equation in the shaft component.

Definition at line 59 of file ShaftConnectableUserObjectInterface.h.

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

◆ _omega_dof

std::vector<dof_id_type> ShaftConnectableUserObjectInterface::_omega_dof
protectedinherited

Degrees of freedom for omega variable (from shaft)

Definition at line 66 of file ShaftConnectableUserObjectInterface.h.

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

◆ _phi_face_values

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

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

Definition at line 91 of file ShaftConnectableUserObjectInterface.h.

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

◆ _scalar_dofs

std::vector<dof_id_type> ShaftConnectableUserObjectInterface::_scalar_dofs
protectedinherited

Degrees of freedom for scalar variables (from junction)

Definition at line 68 of file ShaftConnectableUserObjectInterface.h.

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

◆ _shaft_speed

const VariableValue& ShaftConnectedMotorUserObject::_shaft_speed
protected

Shaft speed.

Definition at line 42 of file ShaftConnectedMotorUserObject.h.

Referenced by getMomentOfInertia(), and getTorque().

◆ _torque

Real ShaftConnectableUserObjectInterface::_torque
protectedinherited

Total torque.

Definition at line 72 of file ShaftConnectableUserObjectInterface.h.

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

◆ _torque_fn

const Function& ShaftConnectedMotorUserObject::_torque_fn
protected

Torque as a function of shaft speed.

Definition at line 38 of file ShaftConnectedMotorUserObject.h.

Referenced by getTorque().

◆ _torque_jacobian_flow_channel_vars

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

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 ShaftConnectableUserObjectInterface::computeTorqueScalarJacobianWRTFlowDofs(), ShaftConnectableUserObjectInterface::getTorqueJacobianData(), and ShaftConnectableUserObjectInterface::setupConnections().

◆ _torque_jacobian_omega_var

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_torque_jacobian_omega_var
protectedinherited

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

Definition at line 82 of file ShaftConnectableUserObjectInterface.h.

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

◆ _torque_jacobian_scalar_vars

DenseMatrix<Real> ShaftConnectableUserObjectInterface::_torque_jacobian_scalar_vars
protectedinherited

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

Definition at line 80 of file ShaftConnectableUserObjectInterface.h.

Referenced by ShaftConnectableUserObjectInterface::getTorqueJacobianData().

The documentation for this class was generated from the following files:
Generated on Wed Nov 5 2025 20:31:28 for https://mooseframework.inl.gov by   doxygen 1.8.14