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

This class is here to get the force and torque acting on a grain from different userobjects and sum them all. More...

#include <MaskedGrainForceAndTorque.h>

Inheritance diagram for MaskedGrainForceAndTorque:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 MaskedGrainForceAndTorque (const InputParameters &parameters)
 
virtual void initialize ()
 
virtual void execute ()
 
virtual void finalize ()
 
virtual const std::vector< RealGradient > & getForceValues () const
 
virtual const std::vector< RealGradient > & getTorqueValues () const
 
virtual const std::vector< Real > & getForceCJacobians () const
 
virtual const std::vector< std::vector< Real > > & getForceEtaJacobians () const
 
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
 

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)
 

Static Protected Member Functions

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

Protected Attributes

const GrainForceAndTorqueInterface & _grain_force_torque_input
 
const std::vector< RealGradient > & _grain_forces_input
 
const std::vector< RealGradient > & _grain_torques_input
 
const std::vector< Real > & _grain_force_c_jacobians_input
 
const std::vector< std::vector< Real > > & _grain_force_eta_jacobians_input
 
std::vector< unsigned int > _pinned_grains
 
unsigned int _num_pinned_grains
 
unsigned int _grain_num
 
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
 
std::vector< RealGradient > _force_values
 providing grain forces, torques and their jacobians w. r. t c More...
 
std::vector< RealGradient > _torque_values
 
std::vector< Real > _c_jacobians
 
std::vector< std::vector< Real > > _eta_jacobians
 

Static Protected Attributes

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

Detailed Description

This class is here to get the force and torque acting on a grain from different userobjects and sum them all.

Definition at line 21 of file MaskedGrainForceAndTorque.h.

Constructor & Destructor Documentation

◆ MaskedGrainForceAndTorque()

MaskedGrainForceAndTorque::MaskedGrainForceAndTorque ( const InputParameters &  parameters)

Definition at line 26 of file MaskedGrainForceAndTorque.C.

27  : GrainForceAndTorqueInterface(),
28  GeneralUserObject(parameters),
29  _grain_force_torque_input(getUserObject<GrainForceAndTorqueInterface>("grain_force")),
30  _grain_forces_input(_grain_force_torque_input.getForceValues()),
31  _grain_torques_input(_grain_force_torque_input.getTorqueValues()),
32  _grain_force_c_jacobians_input(_grain_force_torque_input.getForceCJacobians()),
33  _grain_force_eta_jacobians_input(_grain_force_torque_input.getForceEtaJacobians()),
34  _pinned_grains(getParam<std::vector<unsigned int>>("pinned_grains")),
35  _num_pinned_grains(_pinned_grains.size()),
36  _grain_num(_grain_forces_input.size()),
37  _force_values(_grain_num),
38  _torque_values(_grain_num)
39 {
40 }
GrainForceAndTorqueInterface::getForceEtaJacobians
virtual const std::vector< std::vector< Real > > & getForceEtaJacobians() const =0
MaskedGrainForceAndTorque::_grain_forces_input
const std::vector< RealGradient > & _grain_forces_input
Definition: MaskedGrainForceAndTorque.h:39
GrainForceAndTorqueInterface
This class provides interface for extracting the forces and torques computed in other UserObjects...
Definition: GrainForceAndTorqueInterface.h:24
GrainForceAndTorqueInterface::getTorqueValues
virtual const std::vector< RealGradient > & getTorqueValues() const =0
MaskedGrainForceAndTorque::_torque_values
std::vector< RealGradient > _torque_values
Definition: MaskedGrainForceAndTorque.h:50
MaskedGrainForceAndTorque::_grain_torques_input
const std::vector< RealGradient > & _grain_torques_input
Definition: MaskedGrainForceAndTorque.h:40
MaskedGrainForceAndTorque::_grain_force_c_jacobians_input
const std::vector< Real > & _grain_force_c_jacobians_input
Definition: MaskedGrainForceAndTorque.h:41
MaskedGrainForceAndTorque::_grain_force_torque_input
const GrainForceAndTorqueInterface & _grain_force_torque_input
Definition: MaskedGrainForceAndTorque.h:38
MaskedGrainForceAndTorque::_force_values
std::vector< RealGradient > _force_values
providing grain forces, torques and their jacobians w. r. t c
Definition: MaskedGrainForceAndTorque.h:49
GrainForceAndTorqueInterface::getForceValues
virtual const std::vector< RealGradient > & getForceValues() const =0
GeneralUserObject::getParam
const T & getParam(const std::string &name) const
GrainForceAndTorqueInterface::getForceCJacobians
virtual const std::vector< Real > & getForceCJacobians() const =0
GeneralUserObject::GeneralUserObject
GeneralUserObject(const InputParameters &parameters)
MaskedGrainForceAndTorque::_grain_force_eta_jacobians_input
const std::vector< std::vector< Real > > & _grain_force_eta_jacobians_input
Definition: MaskedGrainForceAndTorque.h:42
GeneralUserObject::parameters
const InputParameters & parameters() const
MaskedGrainForceAndTorque::_pinned_grains
std::vector< unsigned int > _pinned_grains
Definition: MaskedGrainForceAndTorque.h:44

Member Function Documentation

◆ execute()

virtual void MaskedGrainForceAndTorque::execute ( )
inlinevirtual

Implements GeneralUserObject.

Definition at line 29 of file MaskedGrainForceAndTorque.h.

29 {};

◆ finalize()

virtual void MaskedGrainForceAndTorque::finalize ( )
inlinevirtual

Implements GeneralUserObject.

Definition at line 30 of file MaskedGrainForceAndTorque.h.

30 {};

◆ getForceCJacobians()

const std::vector< Real > & MaskedGrainForceAndTorque::getForceCJacobians ( ) const
virtual

Implements GrainForceAndTorqueInterface.

Definition at line 145 of file MaskedGrainForceAndTorque.C.

146 {
147  return _c_jacobians;
148 }

◆ getForceEtaJacobians()

const std::vector< std::vector< Real > > & MaskedGrainForceAndTorque::getForceEtaJacobians ( ) const
virtual

Implements GrainForceAndTorqueInterface.

Definition at line 151 of file MaskedGrainForceAndTorque.C.

152 {
153  return _eta_jacobians;
154 }
MaskedGrainForceAndTorque::_eta_jacobians
std::vector< std::vector< Real > > _eta_jacobians
Definition: MaskedGrainForceAndTorque.h:52

◆ getForceValues()

const std::vector< RealGradient > & MaskedGrainForceAndTorque::getForceValues ( ) const
virtual

Implements GrainForceAndTorqueInterface.

Definition at line 133 of file MaskedGrainForceAndTorque.C.

134 {
135  return _force_values;
136 }
MaskedGrainForceAndTorque::_force_values
std::vector< RealGradient > _force_values
providing grain forces, torques and their jacobians w. r. t c
Definition: MaskedGrainForceAndTorque.h:49

◆ getTorqueValues()

const std::vector< RealGradient > & MaskedGrainForceAndTorque::getTorqueValues ( ) const
virtual

Implements GrainForceAndTorqueInterface.

Definition at line 139 of file MaskedGrainForceAndTorque.C.

140 {
141  return _torque_values;
142 }
MaskedGrainForceAndTorque::_torque_values
std::vector< RealGradient > _torque_values
Definition: MaskedGrainForceAndTorque.h:50

◆ initialize()

void MaskedGrainForceAndTorque::initialize ( )
virtual

Implements GeneralUserObject.

Definition at line 43 of file MaskedGrainForceAndTorque.C.

44 {
45  for (unsigned int i = 0; i < _grain_num; ++i)
46  {
47  _force_values[i] = _grain_forces_input[i];
48  _torque_values[i] = _grain_torques_input[i];
49 
50  if (_num_pinned_grains != 0)
51  {
52  for (unsigned int j = 0; j < _num_pinned_grains; ++j)
53  {
54  if (i == _pinned_grains[j])
55  {
56  _force_values[i] = 0.0;
57  _torque_values[i] = 0.0;
58  }
59  }
60  }
61  }
62 
63  if (_fe_problem.currentlyComputingJacobian())
64  {
65  unsigned int total_dofs = _subproblem.es().n_dofs();
66  _c_jacobians.resize(6 * _grain_num * total_dofs, 0.0);
67  _eta_jacobians.resize(_grain_num);
68  for (unsigned int i = 0; i < _grain_num; ++i)
69  for (unsigned int j = 0; j < total_dofs; ++j)
70  {
71  _c_jacobians[(6 * i + 0) * total_dofs + j] =
72  _grain_force_c_jacobians_input[(6 * i + 0) * total_dofs + j];
73  _c_jacobians[(6 * i + 1) * total_dofs + j] =
74  _grain_force_c_jacobians_input[(6 * i + 1) * total_dofs + j];
75  _c_jacobians[(6 * i + 2) * total_dofs + j] =
76  _grain_force_c_jacobians_input[(6 * i + 2) * total_dofs + j];
77  _c_jacobians[(6 * i + 3) * total_dofs + j] =
78  _grain_force_c_jacobians_input[(6 * i + 3) * total_dofs + j];
79  _c_jacobians[(6 * i + 4) * total_dofs + j] =
80  _grain_force_c_jacobians_input[(6 * i + 4) * total_dofs + j];
81  _c_jacobians[(6 * i + 5) * total_dofs + j] =
82  _grain_force_c_jacobians_input[(6 * i + 5) * total_dofs + j];
83 
84  if (_num_pinned_grains != 0)
85  for (unsigned int k = 0; k < _num_pinned_grains; ++k)
86  if (i == _pinned_grains[k])
87  {
88  _c_jacobians[(6 * i + 0) * total_dofs + j] = 0.0;
89  _c_jacobians[(6 * i + 1) * total_dofs + j] = 0.0;
90  _c_jacobians[(6 * i + 2) * total_dofs + j] = 0.0;
91  _c_jacobians[(6 * i + 3) * total_dofs + j] = 0.0;
92  _c_jacobians[(6 * i + 4) * total_dofs + j] = 0.0;
93  _c_jacobians[(6 * i + 5) * total_dofs + j] = 0.0;
94  }
95  }
96 
97  for (unsigned int i = 0; i < _grain_num; ++i)
98  {
99  _eta_jacobians[i].resize(6 * _grain_num * total_dofs);
100  for (unsigned int j = 0; j < _grain_num; ++j)
101  for (unsigned int k = 0; k < total_dofs; ++k)
102  {
103  _eta_jacobians[i][(6 * j + 0) * total_dofs + k] =
104  _grain_force_eta_jacobians_input[i][(6 * j + 0) * total_dofs + k];
105  _eta_jacobians[i][(6 * j + 1) * total_dofs + k] =
106  _grain_force_eta_jacobians_input[i][(6 * j + 1) * total_dofs + k];
107  _eta_jacobians[i][(6 * j + 2) * total_dofs + k] =
108  _grain_force_eta_jacobians_input[i][(6 * j + 2) * total_dofs + k];
109  _eta_jacobians[i][(6 * j + 3) * total_dofs + k] =
110  _grain_force_eta_jacobians_input[i][(6 * j + 3) * total_dofs + k];
111  _eta_jacobians[i][(6 * j + 4) * total_dofs + k] =
112  _grain_force_eta_jacobians_input[i][(6 * j + 4) * total_dofs + k];
113  _eta_jacobians[i][(6 * j + 5) * total_dofs + k] =
114  _grain_force_eta_jacobians_input[i][(6 * j + 5) * total_dofs + k];
115 
116  if (_num_pinned_grains != 0)
117  for (unsigned int l = 0; l < _num_pinned_grains; ++l)
118  if (j == _pinned_grains[l])
119  {
120  _eta_jacobians[i][(6 * j + 0) * total_dofs + k] = 0.0;
121  _eta_jacobians[i][(6 * j + 1) * total_dofs + k] = 0.0;
122  _eta_jacobians[i][(6 * j + 2) * total_dofs + k] = 0.0;
123  _eta_jacobians[i][(6 * j + 3) * total_dofs + k] = 0.0;
124  _eta_jacobians[i][(6 * j + 4) * total_dofs + k] = 0.0;
125  _eta_jacobians[i][(6 * j + 5) * total_dofs + k] = 0.0;
126  }
127  }
128  }
129  }
130 }
MaskedGrainForceAndTorque::_grain_forces_input
const std::vector< RealGradient > & _grain_forces_input
Definition: MaskedGrainForceAndTorque.h:39
libMesh::EquationSystems::n_dofs
std::size_t n_dofs() const
GeneralUserObject::_subproblem
SubProblem & _subproblem
SubProblem::es
virtual libMesh::EquationSystems & es()=0
MaskedGrainForceAndTorque::_torque_values
std::vector< RealGradient > _torque_values
Definition: MaskedGrainForceAndTorque.h:50
MaskedGrainForceAndTorque::_grain_torques_input
const std::vector< RealGradient > & _grain_torques_input
Definition: MaskedGrainForceAndTorque.h:40
MaskedGrainForceAndTorque::_grain_force_c_jacobians_input
const std::vector< Real > & _grain_force_c_jacobians_input
Definition: MaskedGrainForceAndTorque.h:41
MaskedGrainForceAndTorque::_force_values
std::vector< RealGradient > _force_values
providing grain forces, torques and their jacobians w. r. t c
Definition: MaskedGrainForceAndTorque.h:49
GeneralUserObject::_fe_problem
FEProblemBase & _fe_problem
MaskedGrainForceAndTorque::_grain_force_eta_jacobians_input
const std::vector< std::vector< Real > > & _grain_force_eta_jacobians_input
Definition: MaskedGrainForceAndTorque.h:42
EM::j
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
FEProblemBase::currentlyComputingJacobian
const bool & currentlyComputingJacobian() const
MaskedGrainForceAndTorque::_pinned_grains
std::vector< unsigned int > _pinned_grains
Definition: MaskedGrainForceAndTorque.h:44
NS::k
static const std::string k
Definition: NS.h:130
MaskedGrainForceAndTorque::_eta_jacobians
std::vector< std::vector< Real > > _eta_jacobians
Definition: MaskedGrainForceAndTorque.h:52

◆ validParams()

InputParameters MaskedGrainForceAndTorque::validParams ( )
static

Definition at line 15 of file MaskedGrainForceAndTorque.C.

16 {
17  InputParameters params = GeneralUserObject::validParams();
18  params.addClassDescription("Userobject for masking/pinning grains and making forces and torques "
19  "acting on that grain zero");
20  params.addParam<UserObjectName>("grain_force",
21  "userobject for getting force and torque acting on grains");
22  params.addParam<std::vector<unsigned int>>("pinned_grains", "Grain numbers for pinned grains");
23  return params;
24 }
GeneralUserObject::validParams
static InputParameters validParams()
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _c_jacobians

std::vector<Real> MaskedGrainForceAndTorque::_c_jacobians
protected

Definition at line 51 of file MaskedGrainForceAndTorque.h.

Referenced by getForceCJacobians(), and initialize().

◆ _eta_jacobians

std::vector<std::vector<Real> > MaskedGrainForceAndTorque::_eta_jacobians
protected

Definition at line 52 of file MaskedGrainForceAndTorque.h.

Referenced by getForceEtaJacobians(), and initialize().

◆ _force_values

std::vector<RealGradient> MaskedGrainForceAndTorque::_force_values
protected

providing grain forces, torques and their jacobians w. r. t c

Definition at line 49 of file MaskedGrainForceAndTorque.h.

Referenced by getForceValues(), and initialize().

◆ _grain_force_c_jacobians_input

const std::vector<Real>& MaskedGrainForceAndTorque::_grain_force_c_jacobians_input
protected

Definition at line 41 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _grain_force_eta_jacobians_input

const std::vector<std::vector<Real> >& MaskedGrainForceAndTorque::_grain_force_eta_jacobians_input
protected

Definition at line 42 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _grain_force_torque_input

const GrainForceAndTorqueInterface& MaskedGrainForceAndTorque::_grain_force_torque_input
protected

Definition at line 38 of file MaskedGrainForceAndTorque.h.

◆ _grain_forces_input

const std::vector<RealGradient>& MaskedGrainForceAndTorque::_grain_forces_input
protected

Definition at line 39 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _grain_num

unsigned int MaskedGrainForceAndTorque::_grain_num
protected

Definition at line 46 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _grain_torques_input

const std::vector<RealGradient>& MaskedGrainForceAndTorque::_grain_torques_input
protected

Definition at line 40 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _num_pinned_grains

unsigned int MaskedGrainForceAndTorque::_num_pinned_grains
protected

Definition at line 45 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _pinned_grains

std::vector<unsigned int> MaskedGrainForceAndTorque::_pinned_grains
protected

Definition at line 44 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

◆ _torque_values

std::vector<RealGradient> MaskedGrainForceAndTorque::_torque_values
protected

Definition at line 50 of file MaskedGrainForceAndTorque.h.

Referenced by getTorqueValues(), and initialize().

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