Update Euler angles of each grains after rigid body rotation This class estimates the rotation of principal axes of the grains due to applied torques and calculates the final grain orientation. More...

#include <EulerAngleUpdater.h>

Inheritance diagram for EulerAngleUpdater:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	EulerAngleUpdater (const InputParameters &parameters)

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

virtual const EulerAngles &	getEulerAngles (unsigned int) const override

virtual const EulerAngles &	getEulerAnglesOld (unsigned int) const

virtual unsigned int	getGrainNum () const 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

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 GrainTrackerInterface &	_grain_tracker

const EulerAngleProvider &	_euler

const GrainForceAndTorqueInterface &	_grain_torque

const VectorPostprocessorValue &	_grain_volumes

const Real	_mr

bool &	_first_time
	Whether this is the first time updating angles, in which case the initial euler angle provider should be used. More...

bool	_first_time_recovered
	Whether the simulation has recovered once. More...

std::vector< EulerAngles > &	_angles
	Current set of Euler angles (one per grain), updated on initialize() More...

std::vector< EulerAngles > &	_angles_old
	Previous set of Euler angles, used when the time step failed to reset the angles (pre-update) 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

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

Update Euler angles of each grains after rigid body rotation This class estimates the rotation of principal axes of the grains due to applied torques and calculates the final grain orientation.

Step1: Calculate RotationTensor based on euler angles from previous time step (R0) Step2: Obtain the torque acting on the grains at current time Step Step3: Calculate the angular velocities around global axes Step4: Calculate change in euler angles due to torque and corresponding rotation matrix(R1) Step5: Calculate final rotation matrix, R = R1 * R0, determines the final position of any rotated vector Step6: Back-calculate the euler angles from the final rotation matrix Step7: Ensure euler angles comply with Bunge definitions

Definition at line 32 of file EulerAngleUpdater.h.

Constructor & Destructor Documentation

◆ EulerAngleUpdater()

EulerAngleUpdater::EulerAngleUpdater ( const InputParameters & parameters )

Definition at line 36 of file EulerAngleUpdater.C.

   : EulerAngleProvider(params),
     _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker_object")),
     _euler(getUserObject<EulerAngleProvider>("euler_angle_provider")),
     _grain_torque(getUserObject<GrainForceAndTorqueInterface>("grain_torques_object")),
     _grain_volumes(getVectorPostprocessorValue("grain_volumes", "feature_volumes")),
     _mr(getParam<Real>("rotation_constant")),
     _first_time(declareRestartableData<bool>("first_time_euler_update", true)),
     _first_time_recovered(_app.isRecovering()),
     _angles(declareRestartableData<std::vector<EulerAngles>>("euler_angles")),
     _angles_old(declareRestartableData<std::vector<EulerAngles>>("euler_angles_old"))
 {
 }

Member Function Documentation

◆ execute()

virtual void EulerAngleUpdater::execute ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 40 of file EulerAngleUpdater.h.

40 {}

◆ finalize()

virtual void EulerAngleUpdater::finalize ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 41 of file EulerAngleUpdater.h.

41 {}

◆ getEulerAngles()

const EulerAngles & EulerAngleUpdater::getEulerAngles ( unsigned int i ) const

overridevirtual

Implements EulerAngleProvider.

Definition at line 173 of file EulerAngleUpdater.C.

Referenced by EulerAngleUpdaterCheck::initialize().

 {
   mooseAssert(i < getGrainNum(), "Requesting Euler angles for an invalid grain id");
   return _angles[i];
 }

◆ getEulerAnglesOld()

const EulerAngles & EulerAngleUpdater::getEulerAnglesOld ( unsigned int i ) const

virtual

Definition at line 180 of file EulerAngleUpdater.C.

Referenced by EulerAngleUpdaterCheck::initialize().

 {
   mooseAssert(i < getGrainNum(), "Requesting Euler angles for an invalid grain id");
   return _angles_old[i];
 }

◆ getGrainNum()

unsigned int EulerAngleUpdater::getGrainNum ( ) const

overridevirtual

Implements EulerAngleProvider.

Definition at line 167 of file EulerAngleUpdater.C.

Referenced by getEulerAngles(), and getEulerAnglesOld().

 {
   return _angles.size();
 }

◆ initialize()

void EulerAngleUpdater::initialize ( )

overridevirtual

Change in euler angles are obtained from the torque & angular velocities about the material axes. Change in phi1, Phi and phi2 are caused by rotation about z axis, x' axis & z'' axis, respectively. Components of the angular velocities across z, x' and z'' axes are obtained from the torque values. This yields change in euler angles due to grain rotation.

Final RotationMatrix = RotationMatrix due to applied torque X old RotationMatrix Updated Euler angles are obtained by back-tracking the angles from the rotation matrix For details about the componenets of the rotation matrix please refer to RotationTensor.C Phi = acos(R33); phi1 = atan2(R31,-R32); phi2 = atan2(R13,R23) for phi != 0.0 por 180.0

Implements GeneralUserObject.

Definition at line 51 of file EulerAngleUpdater.C.

 {
   const auto grain_num = _grain_tracker.getTotalFeatureCount();
 
   if (_first_time)
   {
     _angles.resize(grain_num);
     _angles_old.resize(grain_num);
     for (unsigned int i = 0; i < grain_num; ++i)
       _angles[i] = _euler.getEulerAngles(i); // Read initial euler angles
   }
 
   unsigned int angle_size = _angles.size();
   for (unsigned int i = angle_size; i < grain_num; ++i) // if new grains are created
     _angles.push_back(_euler.getEulerAngles(i));        // Assign initial euler angles
 
   for (unsigned int i = 0; i < grain_num; ++i)
   {
     // We dont want to use old angles on recovery
     if (!_first_time && !_first_time_recovered && !_fe_problem.converged(_sys.number()))
       _angles[i] = _angles_old[i];
     _first_time_recovered = false;
 
     RealGradient torque = _grain_torque.getTorqueValues()[i];
 
     if (i <= angle_size) // if new grains are created
       _angles_old[i] = _angles[i];
     else
       _angles_old.push_back(_angles[i]);
 
     RotationTensor R0(_angles_old[i]); // RotationTensor as per old euler angles
     RealVectorValue torque_rotated =
         R0 * torque; // Applied torque is rotated to allign with old grain axes
     RealVectorValue omega =
         _mr / _grain_volumes[i] * torque_rotated; // Angular velocity as per old grain axes
     RealVectorValue angle_change;
     angle_change(0) = omega(2) * _dt;
     angle_change(1) =
         (omega(0) * std::cos(angle_change(0)) + omega(1) * std::sin(angle_change(0))) * _dt;
     angle_change(2) = (omega(0) * std::sin(angle_change(0)) * std::sin(angle_change(1)) -
                        omega(1) * std::cos(angle_change(0)) * std::sin(angle_change(1)) +
                        omega(2) * std::cos(angle_change(1))) *
                       _dt;
     angle_change *= (180.0 / libMesh::pi);
 
     RotationTensor R1(angle_change); // Rotation matrix due to torque
     RealTensorValue R = R1 * R0;
 
     if (R(2, 2) != 1.0 && R(2, 2) != -1.0) // checks if cos(Phi) = 1 or -1
     {
       _angles[i].phi1 = std::atan2(R(2, 0), -R(2, 1)) * (180.0 / libMesh::pi);
       _angles[i].Phi = std::acos(R(2, 2)) * (180.0 / libMesh::pi);
       _angles[i].phi2 = std::atan2(R(0, 2), R(1, 2)) * (180.0 / libMesh::pi);
     }
     else if (R(2, 2) == 1.0) // special case for Phi = 0.0
     {
       if (R0(2, 2) == 1.0)
         // when Phi_old = 0.0; all the rotations are about z axis and angles accumulates after each
         // rotation
         _angles[i].phi1 = _angles_old[i].phi1 + _angles_old[i].phi2 + angle_change(0);
       else
         _angles[i].phi1 = angle_change(0);
       // Comply with bunge euler angle definitions, 0.0 <= phi1 <= 360.0
       if (std::abs(_angles[i].phi1) > 360.0)
       {
         int laps = _angles[i].phi1 / 360.0;
         _angles[i].phi1 -= laps * 360.0;
       }
       _angles[i].Phi = 0.0;
       _angles[i].phi2 = -_angles[i].phi1 + std::atan2(R(0, 1), R(1, 1)) * (180.0 / libMesh::pi);
     }
     else
     {
       if (R0(2, 2) == 1.0)
         _angles[i].phi1 = _angles_old[i].phi1 + _angles_old[i].phi2 + angle_change(0);
       else
         _angles[i].phi1 = angle_change(0);
       // Comply with bunge euler angle definitions, 0.0 <= phi1 <= 360.0
       if (std::abs(_angles[i].phi1) > 360.0)
       {
         int laps = _angles[i].phi1 / 360.0;
         _angles[i].phi1 -= laps * 360.0;
       }
       _angles[i].Phi = 180.0;
       _angles[i].phi2 = _angles[i].phi1 - std::atan2(-R(0, 1), -R(1, 1)) * (180.0 / libMesh::pi);
     }
 
     // Following checks and updates are done only to comply with bunge euler angle definitions, 0.0
     // <= phi1/phi2 <= 360.0
     if (_angles[i].phi1 < 0.0)
       _angles[i].phi1 += 360.0;
     if (_angles[i].phi2 < 0.0)
       _angles[i].phi2 += 360.0;
     if (_angles[i].Phi < 0.0)
       mooseError("Euler angle out of range.");
   }
 
   _first_time = false;
 }

◆ validParams()

InputParameters EulerAngleUpdater::validParams ( )

static

Definition at line 19 of file EulerAngleUpdater.C.

 {
   InputParameters params = EulerAngleProvider::validParams();
   params.addClassDescription(
       "Provide updated euler angles after rigid body rotation of the grains.");
   params.addRequiredParam<UserObjectName>("grain_tracker_object",
                                           "The FeatureFloodCount UserObject to get values from.");
   params.addRequiredParam<UserObjectName>("euler_angle_provider",
                                           "Name of Euler angle provider user object");
   params.addRequiredParam<UserObjectName>("grain_torques_object",
                                           "Name of Euler angle provider user object");
   params.addRequiredParam<VectorPostprocessorName>("grain_volumes",
                                                    "The feature volume VectorPostprocessorValue.");
   params.addParam<Real>("rotation_constant", 1.0, "Constant value characterizing grain rotation");
   return params;
 }

Member Data Documentation

◆ _angles

std::vector<EulerAngles>& EulerAngleUpdater::_angles

protected

Current set of Euler angles (one per grain), updated on initialize()

Definition at line 61 of file EulerAngleUpdater.h.

Referenced by getEulerAngles(), getGrainNum(), and initialize().

◆ _angles_old

std::vector<EulerAngles>& EulerAngleUpdater::_angles_old

protected

Previous set of Euler angles, used when the time step failed to reset the angles (pre-update)

Definition at line 63 of file EulerAngleUpdater.h.

Referenced by getEulerAnglesOld(), and initialize().

◆ _euler

const EulerAngleProvider& EulerAngleUpdater::_euler

protected

Definition at line 49 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _first_time

bool& EulerAngleUpdater::_first_time

protected

Whether this is the first time updating angles, in which case the initial euler angle provider should be used.

Definition at line 55 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _first_time_recovered

bool EulerAngleUpdater::_first_time_recovered

protected

Whether the simulation has recovered once.

This only serves to prevent using the old angles in initialize() as problem.converged() returns false on the very first initialize() call after recovering

Definition at line 58 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _grain_torque

const GrainForceAndTorqueInterface& EulerAngleUpdater::_grain_torque

protected

Definition at line 50 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _grain_tracker

const GrainTrackerInterface& EulerAngleUpdater::_grain_tracker

protected

Definition at line 48 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _grain_volumes

const VectorPostprocessorValue& EulerAngleUpdater::_grain_volumes

protected

Definition at line 51 of file EulerAngleUpdater.h.

Referenced by initialize().

◆ _mr

const Real EulerAngleUpdater::_mr

protected

Definition at line 53 of file EulerAngleUpdater.h.

Referenced by initialize().

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

phase_field/include/userobjects/EulerAngleUpdater.h
phase_field/src/userobjects/EulerAngleUpdater.C

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

Detailed Description

Constructor & Destructor Documentation

◆ EulerAngleUpdater()

Member Function Documentation

◆ execute()

◆ finalize()

◆ getEulerAngles()

◆ getEulerAnglesOld()

◆ getGrainNum()

◆ initialize()

◆ validParams()

Member Data Documentation

◆ _angles

◆ _angles_old

◆ _euler

◆ _first_time

◆ _first_time_recovered

◆ _grain_torque

◆ _grain_tracker

◆ _grain_volumes

◆ _mr