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
ADShaftConnectedMotorUserObject Class Reference

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

#include <ADShaftConnectedMotorUserObject.h>

Inheritance diagram for ADShaftConnectedMotorUserObject:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 ADShaftConnectedMotorUserObject (const InputParameters &params)
 
virtual ADReal getTorque () const override
 
virtual ADReal getMomentOfInertia () 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
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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)
 
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)
 
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 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)
 

Static Public Member Functions

static InputParameters validParams ()
 
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

const ConsoleStream _console
 

Static Public Attributes

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
 
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)
 
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< 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...
 

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 ADVariableValue & _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
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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 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
 
const MooseObject * _moose_object
 Associated MOOSE object. More...
 
unsigned int _n_shaft_eq
 Number of equation in the shaft component. More...
 
unsigned int _n_connections
 Number of flow channels the shaft connected component is attached to. More...
 
unsigned int _n_flow_eq
 Number of flow variables in connected flow channels. More...
 
std::vector< dof_id_type > _omega_dof
 Degrees of freedom for omega variable (from shaft) More...
 
std::vector< dof_id_type > _scalar_dofs
 Degrees of freedom for scalar variables (from junction) More...
 
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
 Degrees of freedom for flow channel variables, for each connection. More...
 
ADReal _torque
 Total torque. More...
 
ADReal _moment_of_inertia
 Moment of inertia. More...
 

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 ADShaftConnectedMotorUserObject.h.

Constructor & Destructor Documentation

◆ ADShaftConnectedMotorUserObject()

ADShaftConnectedMotorUserObject::ADShaftConnectedMotorUserObject ( const InputParameters &  params)

Definition at line 29 of file ADShaftConnectedMotorUserObject.C.

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

Member Function Documentation

◆ execute()

void ADShaftConnectedMotorUserObject::execute ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 64 of file ADShaftConnectedMotorUserObject.C.

65 {
66 }

◆ finalize()

void ADShaftConnectedMotorUserObject::finalize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 69 of file ADShaftConnectedMotorUserObject.C.

70 {
71  ADShaftConnectableUserObjectInterface::finalize();
72 }

◆ getMomentOfInertia()

ADReal ADShaftConnectedMotorUserObject::getMomentOfInertia ( ) const
overridevirtual

Reimplemented from ADShaftConnectableUserObjectInterface.

Definition at line 49 of file ADShaftConnectedMotorUserObject.C.

50 {
51  const ADReal & shaft_speed = _shaft_speed[0];
52  ADReal inertia = _inertia_fn.value(MetaPhysicL::raw_value(shaft_speed), Point());
53  inertia.derivatives() = _inertia_fn.timeDerivative(MetaPhysicL::raw_value(shaft_speed), Point()) *
54  shaft_speed.derivatives();
55  return inertia;
56 }
ADShaftConnectedMotorUserObject::_inertia_fn
const Function & _inertia_fn
Moment of inertia as a function of shaft speed.
Definition: ADShaftConnectedMotorUserObject.h:34
Function::timeDerivative
virtual Real timeDerivative(Real t, const Point &p) const
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
ADShaftConnectedMotorUserObject::_shaft_speed
const ADVariableValue & _shaft_speed
Shaft speed.
Definition: ADShaftConnectedMotorUserObject.h:36
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
Function::value
virtual Real value(Real t, const Point &p) const

◆ getTorque()

ADReal ADShaftConnectedMotorUserObject::getTorque ( ) const
overridevirtual

Reimplemented from ADShaftConnectableUserObjectInterface.

Definition at line 39 of file ADShaftConnectedMotorUserObject.C.

40 {
41  const ADReal & shaft_speed = _shaft_speed[0];
42  ADReal torque = _torque_fn.value(MetaPhysicL::raw_value(shaft_speed), Point());
43  torque.derivatives() = _torque_fn.timeDerivative(MetaPhysicL::raw_value(shaft_speed), Point()) *
44  shaft_speed.derivatives();
45  return torque;
46 }
ADShaftConnectedMotorUserObject::_torque_fn
const Function & _torque_fn
Torque as a function of shaft speed.
Definition: ADShaftConnectedMotorUserObject.h:32
Function::timeDerivative
virtual Real timeDerivative(Real t, const Point &p) const
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
ADShaftConnectedMotorUserObject::_shaft_speed
const ADVariableValue & _shaft_speed
Shaft speed.
Definition: ADShaftConnectedMotorUserObject.h:36
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
Function::value
virtual Real value(Real t, const Point &p) const

◆ initialize()

void ADShaftConnectedMotorUserObject::initialize ( )
overridevirtual

Implements GeneralUserObject.

Definition at line 59 of file ADShaftConnectedMotorUserObject.C.

60 {
61 }

◆ setConnectionData()

void ADShaftConnectableUserObjectInterface::setConnectionData ( 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 65 of file ADShaftConnectableUserObjectInterface.C.

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

67 {
68  _flow_channel_dofs = flow_channel_dofs;
69 }
ADShaftConnectableUserObjectInterface::_flow_channel_dofs
std::vector< std::vector< dof_id_type > > _flow_channel_dofs
Degrees of freedom for flow channel variables, for each connection.
Definition: ADShaftConnectableUserObjectInterface.h:61

◆ setOmegaDofs()

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

Definition at line 72 of file ADShaftConnectableUserObjectInterface.C.

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

73 {
74  auto && dofs = omega_var->dofIndices();
75  mooseAssert(dofs.size() == 1,
76  "There should be exactly 1 coupled DoF index for the variable '" + omega_var->name() +
77  "'.");
78  _omega_dof = dofs;
79 }
MooseVariableScalar::name
const std::string & name() const override
MooseVariableScalar::dofIndices
virtual const std::vector< dof_id_type > & dofIndices() const
ADShaftConnectableUserObjectInterface::_omega_dof
std::vector< dof_id_type > _omega_dof
Degrees of freedom for omega variable (from shaft)
Definition: ADShaftConnectableUserObjectInterface.h:57

◆ setupConnections()

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

Definition at line 57 of file ADShaftConnectableUserObjectInterface.C.

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

59 {
60  _n_connections = n_connections;
61  _n_flow_eq = n_flow_eq;
62 }
ADShaftConnectableUserObjectInterface::_n_connections
unsigned int _n_connections
Number of flow channels the shaft connected component is attached to.
Definition: ADShaftConnectableUserObjectInterface.h:52
ADShaftConnectableUserObjectInterface::_n_flow_eq
unsigned int _n_flow_eq
Number of flow variables in connected flow channels.
Definition: ADShaftConnectableUserObjectInterface.h:54

◆ setupJunctionData()

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

Stores data associated with a junction component.

Definition at line 82 of file ADShaftConnectableUserObjectInterface.C.

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

83 {
84  _scalar_dofs = scalar_dofs;
85 }
ADShaftConnectableUserObjectInterface::_scalar_dofs
std::vector< dof_id_type > _scalar_dofs
Degrees of freedom for scalar variables (from junction)
Definition: ADShaftConnectableUserObjectInterface.h:59

◆ threadJoin()

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

Reimplemented in ADShaftConnectedCompressor1PhaseUserObject, ADShaftConnectedTurbine1PhaseUserObject, and ADShaftConnectedPump1PhaseUserObject.

Definition at line 95 of file ADShaftConnectableUserObjectInterface.C.

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

96 {
97  const ADShaftConnectableUserObjectInterface & sctc_uo =
98  dynamic_cast<const ADShaftConnectableUserObjectInterface &>(uo);
99  _torque += sctc_uo._torque;
100  _moment_of_inertia += sctc_uo._moment_of_inertia;
101 }
ADShaftConnectableUserObjectInterface
Interface class for user objects that are connected to a shaft.
Definition: ADShaftConnectableUserObjectInterface.h:22

◆ validParams()

InputParameters ADShaftConnectedMotorUserObject::validParams ( )
static

Definition at line 16 of file ADShaftConnectedMotorUserObject.C.

17 {
18  InputParameters params = GeneralUserObject::validParams();
19  params += ADShaftConnectableUserObjectInterface::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> > ADShaftConnectableUserObjectInterface::_flow_channel_dofs
protectedinherited

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

Definition at line 61 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::setConnectionData().

◆ _inertia_fn

const Function& ADShaftConnectedMotorUserObject::_inertia_fn
protected

Moment of inertia as a function of shaft speed.

Definition at line 34 of file ADShaftConnectedMotorUserObject.h.

Referenced by getMomentOfInertia().

◆ _moment_of_inertia

ADReal ADShaftConnectableUserObjectInterface::_moment_of_inertia
protectedinherited

Moment of inertia.

Definition at line 65 of file ADShaftConnectableUserObjectInterface.h.

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

◆ _moose_object

const MooseObject* ADShaftConnectableUserObjectInterface::_moose_object
protectedinherited

Associated MOOSE object.

Definition at line 48 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::finalize().

◆ _n_connections

unsigned int ADShaftConnectableUserObjectInterface::_n_connections
protectedinherited

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

Definition at line 52 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::setupConnections().

◆ _n_flow_eq

unsigned int ADShaftConnectableUserObjectInterface::_n_flow_eq
protectedinherited

Number of flow variables in connected flow channels.

Definition at line 54 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::setupConnections().

◆ _n_shaft_eq

unsigned int ADShaftConnectableUserObjectInterface::_n_shaft_eq
protectedinherited

Number of equation in the shaft component.

Definition at line 50 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::ADShaftConnectableUserObjectInterface().

◆ _omega_dof

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

Degrees of freedom for omega variable (from shaft)

Definition at line 57 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::ADShaftConnectableUserObjectInterface(), and ADShaftConnectableUserObjectInterface::setOmegaDofs().

◆ _scalar_dofs

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

Degrees of freedom for scalar variables (from junction)

Definition at line 59 of file ADShaftConnectableUserObjectInterface.h.

Referenced by ADShaftConnectableUserObjectInterface::setupJunctionData().

◆ _shaft_speed

const ADVariableValue& ADShaftConnectedMotorUserObject::_shaft_speed
protected

Shaft speed.

Definition at line 36 of file ADShaftConnectedMotorUserObject.h.

Referenced by getMomentOfInertia(), and getTorque().

◆ _torque

ADReal ADShaftConnectableUserObjectInterface::_torque
protectedinherited

Total torque.

Definition at line 63 of file ADShaftConnectableUserObjectInterface.h.

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

◆ _torque_fn

const Function& ADShaftConnectedMotorUserObject::_torque_fn
protected

Torque as a function of shaft speed.

Definition at line 32 of file ADShaftConnectedMotorUserObject.h.

Referenced by getTorque().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:44:50 for https://mooseframework.inl.gov by   doxygen 1.8.14