A GeneralUserObject that reads an EBSD file and stores the centroid data in a data structure which indexes on element centroids. More...

#include <EBSDReader.h>

Inheritance diagram for EBSDReader:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	EBSDReader (const InputParameters &params)

virtual	~EBSDReader ()

virtual void	readFile ()

virtual void	initialize ()

virtual void	execute ()

virtual void	finalize ()

const EBSDPointData &	getData (const Point &p) const
	Get the requested type of data at the point p.

const EBSDAvgData &	getAvgData (unsigned int i) const
	Get the requested type of average data for (global) grain number i.

const EBSDAvgData &	getAvgData (unsigned int phase, unsigned int local_id) const
	Get the requested type of average data for a given phase and (local) grain.

virtual const EulerAngles &	getEulerAngles (unsigned int) const
	EulerAngleProvider interface implementation to fetch a triplet of Euler angles.

virtual unsigned int	getGrainNum () const
	Return the total number of grains.

virtual unsigned int	getPhaseNum () const
	Return the total number of phases.

virtual unsigned int	getGrainNum (unsigned int phase) const
	Return the number of grains in a given phase.

unsigned int	getFeatureID (unsigned int phase, unsigned int local_id) const
	Return the EBSD feature id for a given phase and phase (local) grain number.

unsigned int	getFeatureID (unsigned int global_id) const
	Return the EBSD feature id for a given (global) grain number.

virtual unsigned int	getGlobalID (unsigned int phase, unsigned int local_id) const
	Return the (global) grain id for a given phase and (local) grain number.

virtual unsigned int	getGlobalID (unsigned int feature_id) const
	Return the (global) grain id for a given feature_id.

MooseSharedPointer< EBSDPointDataFunctor >	getPointDataAccessFunctor (const MooseEnum &field_name) const
	Factory function to return a point functor specified by name.

MooseSharedPointer< EBSDAvgDataFunctor >	getAvgDataAccessFunctor (const MooseEnum &field_name) const
	Factory function to return a average functor specified by name.

const std::map< dof_id_type, std::vector< Real > > &	getNodeToGrainWeightMap () const
	Returns a map consisting of the node index followd by a vector of all grain weights for that node.

const std::map< dof_id_type, std::vector< Real > > &	getNodeToPhaseWeightMap () const
	Returns a map consisting of the node index followd by a vector of all phase weights for that node.

void	meshChanged ()
	Maps need to be updated when the mesh changes.

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () 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)

std::set< UserObjectName >	getDependObjects () const

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

const std::vector< MooseVariableScalar * > &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase * > >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

virtual bool	getMaterialPropertyCalled () const

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

const T &	getKokkosFunction (const std::string &name) const

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

bool	hasKokkosFunction (const std::string &param_name) const

bool	hasKokkosFunctionByName (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	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	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

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, NameFunc &&name_func)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

static MooseEnum	getPointDataFieldType ()

static MooseEnum	getAvgDataFieldType ()

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
unsigned	indexFromPoint (const Point &p) const
	Computes a global index in the _data array given an input centroid point.

unsigned	indexFromIndex (unsigned int var) const
	Transfer the index into the _avg_data array from given index.

void	buildNodeWeightMaps ()
	Build grain and phase weight maps.

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObjectBase &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
unsigned int	_custom_columns
	number of additional custom data columns

std::vector< EBSDPointData >	_data
	Logically three-dimensional data indexed by geometric points in a 1D vector.

std::vector< EBSDAvgData >	_avg_data
	Averages by (global) grain ID.

std::vector< EulerAngles >	_avg_angles
	Euler Angles by (global) grain ID.

std::map< unsigned int, unsigned int >	_global_id_map
	map from feature_id to global_id

std::vector< std::vector< unsigned int > >	_global_id
	global ID for given phases and grains

std::map< dof_id_type, std::vector< Real > >	_node_to_grain_weight_map
	Map of grain weights per node.

std::map< dof_id_type, std::vector< Real > >	_node_to_phase_weight_map
	Map of phase weights per node.

const int &	_time_step
	current timestep. Maps are only rebuild on mesh change during time step zero

unsigned int	_mesh_dimension
	Dimension of the problem domain.

unsigned int	_bins
	number of bins for each quaternion component

unsigned int	_L_norm
	L_norm value for averaging.

unsigned	_nx
	The number of values in the x, y and z directions.

unsigned	_ny

unsigned	_nz

Real	_dx
	The spacing of the values in x, y and z directions.

Real	_dy

Real	_dz

Real	_minx
	Grid origin.

Real	_miny

Real	_minz

Real	_maxx
	Maximum grid extent.

Real	_maxy

Real	_maxz

std::vector< EulerAngles > &	_angles

const Moose::CoordinateSystemType &	_coord_sys

const THREAD_ID	_tid

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

Assembly &	_assembly

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_mdi_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const bool	_is_kokkos_object

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

const Parallel::Communicator &	_communicator


MooseMesh &	_mesh
	MooseMesh Variables.

NonlinearSystemBase &	_nl


unsigned int	_grain_num
	Variables needed to determine reduced order parameter values.

Point	_bottom_left

Point	_top_right

Point	_range

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Member Functions
const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

const VariableValue *	getDefaultValue (const std::string &var_name) const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

void	checkVar (const std::string &var_name) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const

unsigned int	getMaxQps () const

void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
UserObject *	_primary_thread_copy

std::set< std::string >	_supplied_uo

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_fni_object

const InputParameters &	_fni_params

FEProblemBase &	_fni_feproblem

const THREAD_ID	_fni_tid

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const InputParameters &	_dni_params

FEProblemBase &	_dni_feproblem

const MooseObject *const	_dni_moose_object_ptr

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

const RestartableDataMapName	_metaname

std::string	_restartable_name

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const InputParameters &	_sc_parameters

const std::string &	_sc_name

const bool	_sc_is_implicit

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const MooseObject &	_mi_moose_object

const bool	_mi_boundary_restricted

const std::set< SubdomainID > &	_mi_block_ids

const std::set< BoundaryID > &	_mi_boundary_ids

std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > >	_optional_property_proxies

const std::string	_ti_name

Detailed Description

A GeneralUserObject that reads an EBSD file and stores the centroid data in a data structure which indexes on element centroids.

Grains are indexed through multiple schemes:

feature_id The grain number in the EBSD data file
global_id The index into the global average data (contiguously numbered) This is also called "(global) grain ID"
local_id The index into the per-phase grain list. (contiguously numbered and only unique when combined with phase number) This is also called "(local) grain ID"

Phases are referred to using the numbers in the EBSD data file. In case the phase number in the data file starts at 1 the phase 0 will simply contain no grains.

Definition at line 31 of file EBSDReader.h.

Constructor & Destructor Documentation

◆ EBSDReader()

EBSDReader::EBSDReader ( const InputParameters & params )

Definition at line 40 of file EBSDReader.C.

  : EulerAngleProvider(params),
    _mesh(_fe_problem.mesh()),
    _nl(_fe_problem.getNonlinearSystemBase(_sys.number())),
    _grain_num(0),
    _custom_columns(getParam<unsigned int>("custom_columns")),
    _time_step(_fe_problem.timeStep()),
    _mesh_dimension(_mesh.dimension()),
    _bins(getParam<unsigned int>("bins")),
    _L_norm(getParam<Real>("L_norm")),
    _nx(0),
    _ny(0),
    _nz(0),
    _dx(0.),
    _dy(0.),
    _dz(0.)
{
  readFile();
  // throws an error for zero bins
  if (_bins == 0)
    mooseError("One cannot have zero bins");
}

◆ ~EBSDReader()

EBSDReader::~EBSDReader ( )

virtual

Definition at line 347 of file EBSDReader.C.

347{}

Member Function Documentation

◆ buildNodeWeightMaps()

void EBSDReader::buildNodeWeightMaps ( )

protected

Build grain and phase weight maps.

Definition at line 466 of file EBSDReader.C.

{
  // Import nodeToElemMap from MooseMesh for current node
  // This map consists of the node index followed by a vector of element indices that are associated
  // with that node
  const auto & node_to_elem_map = _mesh.nodeToElemMap();
  libMesh::MeshBase & mesh = _mesh.getMesh();
 
  // Loop through each node in mesh and calculate eta values for each grain associated with the node
  for (const auto & node : as_range(mesh.active_nodes_begin(), mesh.active_nodes_end()))
  {
    // Get node_id
    const dof_id_type node_id = node->id();
 
    // Initialize map entries for current node
    _node_to_grain_weight_map[node_id].assign(getGrainNum(), 0.0);
    _node_to_phase_weight_map[node_id].assign(getPhaseNum(), 0.0);
 
    // Loop through element indices associated with the current node and record weighted eta value
    // in new map
    const auto & node_to_elem_pair = node_to_elem_map.find(node_id);
    if (node_to_elem_pair != node_to_elem_map.end())
    {
      unsigned int n_elems =
          node_to_elem_pair->second
              .size(); // n_elems can range from 1 to 4 for 2D and 1 to 8 for 3D problems
 
      for (unsigned int ne = 0; ne < n_elems; ++ne)
      {
        // Current element index
        unsigned int elem_id = (node_to_elem_pair->second)[ne];
 
        // Retrieve EBSD grain number for the current element index
        const Elem * elem = mesh.elem_ptr(elem_id);
        const EBSDReader::EBSDPointData & d = getData(elem->vertex_average());
 
        // get the (global) grain ID for the EBSD feature ID
        const unsigned int global_id = getGlobalID(d._feature_id);
 
        // Calculate eta value and add to map
        _node_to_grain_weight_map[node_id][global_id] += 1.0 / n_elems;
        _node_to_phase_weight_map[node_id][d._phase] += 1.0 / n_elems;
      }
    }
  }
}

Referenced by meshChanged(), and readFile().

◆ execute()

virtual void EBSDReader::execute ( )

inlinevirtual

Implements GeneralUserObject.

Definition at line 42 of file EBSDReader.h.

42{}

◆ finalize()

virtual void EBSDReader::finalize ( )

inlinevirtual

Implements GeneralUserObject.

Definition at line 43 of file EBSDReader.h.

43{}

◆ getAvgData() [1/2]

const EBSDReader::EBSDAvgData & EBSDReader::getAvgData ( unsigned int i ) const

Get the requested type of average data for (global) grain number i.

Definition at line 356 of file EBSDReader.C.

{
  return _avg_data[indexFromIndex(var)];
}

Referenced by PolycrystalEBSD::getGrainsBasedOnPoint(), and EBSDReaderAvgDataAux::precalculateValue().

◆ getAvgData() [2/2]

const EBSDReader::EBSDAvgData & EBSDReader::getAvgData	(	unsigned int	phase,
		unsigned int	local_id
	)		const

Get the requested type of average data for a given phase and (local) grain.

Definition at line 368 of file EBSDReader.C.

{
  return _avg_data[indexFromIndex(_global_id[phase][local_id])];
}

◆ getAvgDataAccessFunctor()

MooseSharedPointer< EBSDAccessFunctors::EBSDAvgDataFunctor > EBSDReader::getAvgDataAccessFunctor ( const MooseEnum & field_name ) const

Factory function to return a average functor specified by name.

Definition at line 560 of file EBSDReader.C.

{
  EBSDAvgDataFunctor * ret_val = NULL;
 
  switch (field_name)
  {
    case 0: // phi1
      ret_val = new EBSDAvgDataPhi1();
      break;
    case 1: // phi
      ret_val = new EBSDAvgDataPhi();
      break;
    case 2: // phi2
      ret_val = new EBSDAvgDataPhi2();
      break;
    case 3: // phase
      ret_val = new EBSDAvgDataPhase();
      break;
    case 4: // symmetry
      ret_val = new EBSDAvgDataSymmetry();
      break;
    case 5: // local_id
      ret_val = new EBSDAvgDataLocalID();
      break;
    case 6: // feature_id
      ret_val = new EBSDAvgDataFeatureID();
      break;
    default:
    {
      // check for custom columns
      for (const auto i : make_range(_custom_columns))
        if (field_name == "CUSTOM" + Moose::stringify(i))
        {
          ret_val = new EBSDAvgDataCustom(i);
          break;
        }
    }
  }
 
  // If ret_val was not set by any of the above cases, throw an error.
  if (!ret_val)
    mooseError("Error:  Please input supported EBSD_param");
 
  // If we made it here, wrap up the the ret_val in a
  // MooseSharedPointer and ship it off.
  return MooseSharedPointer<EBSDAvgDataFunctor>(ret_val);
}

◆ getAvgDataFieldType()

MooseEnum EBSDAccessFunctors::getAvgDataFieldType ( )

staticinherited

Definition at line 19 of file EBSDAccessFunctors.C.

{
  return MooseEnum("phi1 phi phi2 phase symmetry local_id feature_id", "", true);
}

Referenced by EBSDReaderAvgDataAux::validParams().

◆ getData()

const EBSDReader::EBSDPointData & EBSDReader::getData ( const Point & p ) const

Get the requested type of data at the point p.

Definition at line 350 of file EBSDReader.C.

{
  return _data[indexFromPoint(p)];
}

Referenced by buildNodeWeightMaps(), PolycrystalEBSD::getGrainsBasedOnPoint(), and EBSDReaderPointDataAux::precalculateValue().

◆ getEulerAngles()

const EulerAngles & EBSDReader::getEulerAngles ( unsigned int var ) const

virtual

EulerAngleProvider interface implementation to fetch a triplet of Euler angles.

Reimplemented from EulerAngleProvider.

Definition at line 362 of file EBSDReader.C.

{
  return _avg_angles[indexFromIndex(var)];
}

Referenced by ComputeGBMisorientationType::getMisorientationAngles().

◆ getFeatureID() [1/2]

unsigned int EBSDReader::getFeatureID ( unsigned int global_id ) const

inline

Return the EBSD feature id for a given (global) grain number.

Definition at line 86 of file EBSDReader.h.

  {
    return _avg_data[global_id]._feature_id;
  }

◆ getFeatureID() [2/2]

unsigned int EBSDReader::getFeatureID	(	unsigned int	phase,
		unsigned int	local_id
	)		const

inline

Return the EBSD feature id for a given phase and phase (local) grain number.

Definition at line 81 of file EBSDReader.h.

  {
    return _avg_data[_global_id[phase][local_id]]._feature_id;
  }

Referenced by ComputeGBMisorientationType::computeQpProperties(), and ComputeGBMisorientationType::getMisorientationAngles().

◆ getGlobalID() [1/2]

unsigned int EBSDReader::getGlobalID ( unsigned int feature_id ) const

virtual

Return the (global) grain id for a given feature_id.

Definition at line 449 of file EBSDReader.C.

{
  auto it = _global_id_map.find(feature_id);
  if (it == _global_id_map.end())
    mooseError("Invalid Feature ID");
  return it->second;
}

◆ getGlobalID() [2/2]

virtual unsigned int EBSDReader::getGlobalID	(	unsigned int	phase,
		unsigned int	local_id
	)		const

inlinevirtual

Return the (global) grain id for a given phase and (local) grain number.

Definition at line 92 of file EBSDReader.h.

  {
    return _global_id[phase][local_id];
  }

Referenced by buildNodeWeightMaps(), PolycrystalEBSD::getGrainsBasedOnPoint(), PolycrystalEBSD::getNodalVariableValue(), and EulerAngleProvider2RGBAux::precalculateValue().

◆ getGrainNum() [1/2]

unsigned int EBSDReader::getGrainNum ( ) const

virtual

Return the total number of grains.

Reimplemented from EulerAngleProvider.

Definition at line 374 of file EBSDReader.C.

{
  return _grain_num;
}

Referenced by buildNodeWeightMaps(), ComputeGBMisorientationType::getMisorientationAngles(), EulerAngleProvider2RGBAux::getNumGrains(), and PolycrystalEBSD::getNumGrains().

◆ getGrainNum() [2/2]

unsigned int EBSDReader::getGrainNum ( unsigned int phase ) const

virtual

Return the number of grains in a given phase.

Definition at line 380 of file EBSDReader.C.

{
  return _global_id[phase].size();
}

◆ getNodeToGrainWeightMap()

const std::map< dof_id_type, std::vector< Real > > & EBSDReader::getNodeToGrainWeightMap ( ) const

Returns a map consisting of the node index followd by a vector of all grain weights for that node.

Needed by ReconVarIC

Definition at line 437 of file EBSDReader.C.

{
  return _node_to_grain_weight_map;
}

◆ getNodeToPhaseWeightMap()

const std::map< dof_id_type, std::vector< Real > > & EBSDReader::getNodeToPhaseWeightMap ( ) const

Returns a map consisting of the node index followd by a vector of all phase weights for that node.

Needed by ReconPhaseVarIC

Definition at line 443 of file EBSDReader.C.

{
  return _node_to_phase_weight_map;
}

◆ getPhaseNum()

virtual unsigned int EBSDReader::getPhaseNum ( ) const

inlinevirtual

Return the total number of phases.

Definition at line 73 of file EBSDReader.h.

73{ return _global_id.size(); }

Referenced by buildNodeWeightMaps().

◆ getPointDataAccessFunctor()

MooseSharedPointer< EBSDAccessFunctors::EBSDPointDataFunctor > EBSDReader::getPointDataAccessFunctor ( const MooseEnum & field_name ) const

Factory function to return a point functor specified by name.

Definition at line 514 of file EBSDReader.C.

{
  EBSDPointDataFunctor * ret_val = NULL;
 
  switch (field_name)
  {
    case 0: // phi1
      ret_val = new EBSDPointDataPhi1();
      break;
    case 1: // phi
      ret_val = new EBSDPointDataPhi();
      break;
    case 2: // phi2
      ret_val = new EBSDPointDataPhi2();
      break;
    case 3: // grain
      ret_val = new EBSDPointDataFeatureID();
      break;
    case 4: // phase
      ret_val = new EBSDPointDataPhase();
      break;
    case 5: // symmetry
      ret_val = new EBSDPointDataSymmetry();
      break;
    default:
    {
      // check for custom columns
      for (const auto i : make_range(_custom_columns))
        if (field_name == "CUSTOM" + Moose::stringify(i))
        {
          ret_val = new EBSDPointDataCustom(i);
          break;
        }
    }
  }
 
  // If ret_val was not set by any of the above cases, throw an error.
  if (!ret_val)
    mooseError("Error:  Please input supported EBSD_param");
 
  // If we made it here, wrap up the the ret_val in a
  // MooseSharedPointer and ship it off.
  return MooseSharedPointer<EBSDPointDataFunctor>(ret_val);
}

◆ getPointDataFieldType()

MooseEnum EBSDAccessFunctors::getPointDataFieldType ( )

staticinherited

Definition at line 13 of file EBSDAccessFunctors.C.

{
  return MooseEnum("phi1 phi phi2 feature_id phase symmetry", "", true);
}

Referenced by EBSDReaderPointDataAux::validParams().

◆ indexFromIndex()

unsigned int EBSDReader::indexFromIndex ( unsigned int var ) const

protected

Transfer the index into the _avg_data array from given index.

Definition at line 420 of file EBSDReader.C.

{
 
  // Transfer the index into the _avg_data array.
  unsigned avg_index = var;
 
  // Don't access out of range!
  if (avg_index >= _avg_data.size())
    mooseError("Error! Index out of range in EBSDReader::indexFromIndex(), index: ",
               avg_index,
               " size: ",
               _avg_data.size());
 
  return avg_index;
}

Referenced by getAvgData(), getAvgData(), and getEulerAngles().

◆ indexFromPoint()

unsigned int EBSDReader::indexFromPoint ( const Point & p ) const

protected

Computes a global index in the _data array given an input centroid point.

Definition at line 386 of file EBSDReader.C.

{
  // Don't assume an ordering on the input data, use the (x, y,
  // z) values of this centroid to determine the index.
  unsigned int x_index, y_index, z_index, global_index;
 
  x_index = (unsigned int)((p(0) - _minx) / _dx);
  y_index = (unsigned int)((p(1) - _miny) / _dy);
  if (p(0) <= _minx || p(0) >= _maxx || p(1) <= _miny || p(1) >= _maxy)
    mooseError("Data points must be on the interior of the mesh elements. In EBSDReader ", name());
 
  if (_mesh_dimension == 3)
  {
    z_index = (unsigned int)((p(2) - _minz) / _dz);
    global_index = z_index * _ny;
    if (p(2) <= _minz || p(2) >= _maxz)
      mooseError("Data points must be on the interior of the mesh elements. In EBSDReader ",
                 name());
  }
  else
    global_index = 0;
 
  // Compute the global index into the _data array.  This stores points
  // in a [z][y][x] ordering.
  global_index = (global_index + y_index) * _nx + x_index;
 
  // Don't access out of range!
  mooseAssert(global_index < _data.size(),
              "global_index " << global_index << " points out of _data range: " << _data.size());
 
  return global_index;
}

Referenced by getData(), and readFile().

◆ initialize()

virtual void EBSDReader::initialize ( )

inlinevirtual

Implements GeneralUserObject.

Definition at line 41 of file EBSDReader.h.

41{}

◆ meshChanged()

void EBSDReader::meshChanged ( )

virtual

Maps need to be updated when the mesh changes.

Reimplemented from GeneralUserObject.

Definition at line 458 of file EBSDReader.C.

{
  // maps are only rebuild for use in initial conditions, which happens in time step zero
  if (_time_step == 0)
    buildNodeWeightMaps();
}

◆ readFile()

void EBSDReader::readFile ( )

virtual

Markley, F. Landis, Yang Cheng, John Lucas Crassidis, and Yaakov Oshman. "Averaging quaternions." Journal of Guidance, Control, and Dynamics 30, no. 4 (2007): 1193-1197. A 4 by N matrix (Q) is constructed, where N is the number of quaternions. A weight matrix (W) is created. The eigenvector corresponding to the maximum eigenvalue of Q*W*Q' is the weighted average quaternion

If no bin exists which has at least 50% of total quaternions in a grain then the EBSD data may not be reliable Note: The limit 50% is arbitrary

Definition at line 64 of file EBSDReader.C.

{
  std::string ebsd_filename;
  EBSDMeshGenerator::Geometry geometry;
 
  // Fetch and check mesh or meshgenerators
  EBSDMesh * mesh = dynamic_cast<EBSDMesh *>(&_mesh);
  if (mesh != NULL)
  {
    ebsd_filename = mesh->getEBSDFilename();
    geometry = mesh->getEBSDGeometry();
  }
  else
  {
    std::string ebsd_meshgenerator_name;
    if (isParamValid("ebsd_meshgenerator"))
      ebsd_meshgenerator_name = getParam<std::string>("ebsd_meshgenerator");
    else
    {
      auto meshgenerator_names = _app.getMeshGeneratorNames();
      for (auto & mgn : meshgenerator_names)
      {
        const EBSDMeshGenerator * emg =
            dynamic_cast<const EBSDMeshGenerator *>(&_app.getMeshGenerator(mgn));
        if (emg)
        {
          if (!ebsd_meshgenerator_name.empty())
            mooseError("Found multiple EBSDMeshGenerator objects (",
                       ebsd_meshgenerator_name,
                       " and ",
                       mgn,
                       "). Use the 'ebsd_meshgenerator' parameter to specify which one to use.");
          ebsd_meshgenerator_name = mgn;
        }
      }
 
      if (ebsd_meshgenerator_name.empty())
        mooseError("Failed to autodetect an EBSDMeshGenerator (or a deprecated EBSDMesh object).");
    }
 
    // get the selected or detected mesh generator
    const EBSDMeshGenerator * emg =
        dynamic_cast<const EBSDMeshGenerator *>(&_app.getMeshGenerator(ebsd_meshgenerator_name));
    if (!emg)
      paramError("ebsd_meshgenerator", "No valid EBSDMeshGenerator object found.");
 
    ebsd_filename = emg->getEBSDFilename();
    geometry = emg->getEBSDGeometry();
  }
 
  std::ifstream stream_in(ebsd_filename.c_str());
  if (!stream_in)
    mooseError("Can't open EBSD file: ", ebsd_filename);
 
  // Copy file header data from the EBSDMesh
  _dx = geometry.d[0];
  _nx = geometry.n[0];
  _minx = geometry.min[0];
  _maxx = _minx + _dx * _nx;
 
  _dy = geometry.d[1];
  _ny = geometry.n[1];
  _miny = geometry.min[1];
  _maxy = _miny + _dy * _ny;
 
  _dz = geometry.d[2];
  _nz = geometry.n[2];
  _minz = geometry.min[2];
  _maxz = _minz + _dz * _nz;
 
  // Resize the _data array
  unsigned total_size = geometry.dim < 3 ? _nx * _ny : _nx * _ny * _nz;
  _data.resize(total_size);
 
  std::string line;
  while (std::getline(stream_in, line))
  {
    if (line.find("#") != 0)
    {
      // Temporary variables to read in on each line
      EBSDPointData d;
      Real x, y, z;
 
      std::istringstream iss(line);
      iss >> d._phi1 >> d._Phi >> d._phi2 >> x >> y >> z >> d._feature_id >> d._phase >>
          d._symmetry;
 
      // Transform angles to degrees
      d._phi1 *= 180.0 / libMesh::pi;
      d._Phi *= 180.0 / libMesh::pi;
      d._phi2 *= 180.0 / libMesh::pi;
 
      // Custom columns
      d._custom.resize(_custom_columns);
      for (unsigned int i = 0; i < _custom_columns; ++i)
        if (!(iss >> d._custom[i]))
          mooseError("Unable to read in EBSD custom data column #", i);
 
      if (x < _minx || y < _miny || x > _maxx || y > _maxy ||
          (geometry.dim == 3 && (z < _minz || z > _maxz)))
        mooseError("EBSD Data ouside of the domain declared in the header ([",
                   _minx,
                   ':',
                   _maxx,
                   "], [",
                   _miny,
                   ':',
                   _maxy,
                   "], [",
                   _minz,
                   ':',
                   _maxz,
                   "]) dim=",
                   geometry.dim,
                   "\n",
                   line);
 
      d._p = Point(x, y, z);
 
      // determine number of grains in the dataset
      if (_global_id_map.find(d._feature_id) == _global_id_map.end())
        _global_id_map[d._feature_id] = _grain_num++;
 
      unsigned int global_index = indexFromPoint(Point(x, y, z));
      _data[global_index] = d;
    }
  }
  stream_in.close();
 
  // Resize the variables
  _avg_data.resize(_grain_num);
  _avg_angles.resize(_grain_num);
 
  // clear the averages
  for (const auto i : make_range(_grain_num))
  {
    EBSDAvgData & a = _avg_data[i];
    a._symmetry = a._phase = a._n = 0;
    a._p = 0.0;
    a._custom.assign(_custom_columns, 0.0);
 
    EulerAngles & b = _avg_angles[i];
    b.phi1 = b.Phi = b.phi2 = 0.0;
  }
 
  // Array of vectors to store quaternions of each grain
  std::vector<std::vector<Eigen::Quaternion<Real>>> quat(_grain_num);
 
  // Iterate through data points to store orientation information for each grain
  for (auto & j : _data)
  {
    EBSDAvgData & a = _avg_data[_global_id_map[j._feature_id]];
    EulerAngles angles;
 
    angles.phi1 = j._phi1;
    angles.Phi = j._Phi;
    angles.phi2 = j._phi2;
 
    // convert Euler angles to quaternions
    Eigen::Quaternion<Real> q = angles.toQuaternion();
    quat[_global_id_map[j._feature_id]].push_back(q);
 
    if (a._n == 0)
      a._phase = j._phase;
    else if (a._phase != j._phase)
      mooseError("An EBSD feature needs to have a uniform phase.");
 
    if (a._n == 0)
      a._symmetry = j._symmetry;
    else if (a._symmetry != j._symmetry)
      mooseError("An EBSD feature needs to have a uniform symmetry parameter.");
 
    for (unsigned int i = 0; i < _custom_columns; ++i)
      a._custom[i] += j._custom[i];
 
    // store the feature (or grain) ID
    a._feature_id = j._feature_id;
 
    a._p += j._p;
    a._n++;
  }
 
  for (const auto i : make_range(_grain_num))
  {
    EBSDAvgData & a = _avg_data[i];
    EulerAngles & b = _avg_angles[i];
 
    if (a._n == 0)
      continue;
 
    // creating a map to store the quaternion count for each bin index
    std::map<std::tuple<int, int, int, int>, unsigned int> feature_weights;
 
    // looping through all quaternions of the current grain
    for (const auto & q : quat[i])
    {
      const auto bin = std::make_tuple<int, int, int, int>(std::floor(q.w() * 0.5 * _bins),
                                                           std::floor(q.x() * 0.5 * _bins),
                                                           std::floor(q.y() * 0.5 * _bins),
                                                           std::floor(q.z() * 0.5 * _bins));
      feature_weights[bin]++;
    }
 
    // quaternion average matrix Q*w*Q^T
    typedef Eigen::Matrix<Real, 4, 4> Matrix4x4;
    Matrix4x4 quat_mat = Matrix4x4::Zero();
    typedef Eigen::Matrix<Real, 4, 1> Vector4;
 
    bool data_quality_ok = false;
    Real total_weight = 0.0;
    for (const auto & q : quat[i])
    {
      Vector4 v(q.w(), q.x(), q.y(), q.z());
 
      const auto bin = std::make_tuple<int, int, int, int>(std::floor(q.w() * 0.5 * _bins),
                                                           std::floor(q.x() * 0.5 * _bins),
                                                           std::floor(q.y() * 0.5 * _bins),
                                                           std::floor(q.z() * 0.5 * _bins));
      const auto bin_size = feature_weights[bin];
      const auto weight = std::pow(bin_size, _L_norm);
      total_weight += weight;
 
      quat_mat += v * weight * v.transpose();
 
      if (bin_size * 2 > quat[i].size())
        data_quality_ok = true;
    }
 
    quat_mat *= 1.0 / total_weight;
 
    // throws a warning if EBSD data is not reliable
    if (!data_quality_ok)
      _console << COLOR_YELLOW << "EBSD orientation data may not be reliable for grain " << i
               << '\n'
               << COLOR_DEFAULT << std::flush;
 
    // compute eigenvalues and eigenvectors
    Eigen::EigenSolver<Matrix4x4> EigenSolver(quat_mat);
    Vector4 eigen_values = EigenSolver.eigenvalues().real();
    Matrix4x4 eigen_vectors = EigenSolver.eigenvectors().real();
 
    // Selecting eigenvector corresponding to max eigenvalue to compute average Euler angle
    Vector4::Index max_index = 0;
    eigen_values.maxCoeff(&max_index);
    const auto max_vec = eigen_vectors.col(max_index);
    const Eigen::Quaternion<Real> q(max_vec(0), max_vec(1), max_vec(2), max_vec(3));
    b = EulerAngles(q);
 
    // link the EulerAngles into the EBSDAvgData for access via the functors
    a._angles = &b;
 
    if (a._phase >= _global_id.size())
      _global_id.resize(a._phase + 1);
 
    // The averaged per grain data locally contains the phase id, local id, and
    // original feature id. It is stored contiguously indexed by global id.
    a._local_id = _global_id[a._phase].size();
    _global_id[a._phase].push_back(i);
 
    a._p *= 1.0 / Real(a._n);
 
    for (unsigned int i = 0; i < _custom_columns; ++i)
      a._custom[i] /= Real(a._n);
  }
  // Build maps to indicate the weights with which grain and phase data
  // from the surrounding elements contributes to a node for IC purposes
  buildNodeWeightMaps();
}

Referenced by EBSDReader().

◆ validParams()

InputParameters EBSDReader::validParams ( )

static

Definition at line 25 of file EBSDReader.C.

{
  InputParameters params = EulerAngleProvider::validParams();
  params.addClassDescription("Load and manage DREAM.3D EBSD data files for running simulations on "
                             "reconstructed microstructures.");
  params.addParam<unsigned int>(
      "custom_columns", 0, "Number of additional custom data columns to read from the EBSD file");
  params.addParam<unsigned int>("bins", 20, "Number of bins to segregate quaternions");
  params.addParam<Real>("L_norm", 1, "Specifies the type of average the user intends to perform");
  params.addParam<std::string>("ebsd_meshgenerator",
                               "Specify the name of the EBSDMeshGenerator. The EBSDReader can "
                               "autodetect this, if only one such MeshGenerator exists.");
  return params;
}

Member Data Documentation

◆ _angles

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

protectedinherited

Definition at line 39 of file EulerAngleProvider.h.

Referenced by EulerAngleProvider::getEulerAngles(), EulerAngleProvider::getGrainNum(), EulerAngleUpdater::initialize(), RandomEulerAngleProvider::initialize(), EulerAngleUpdateFromReporter::initialize(), EulerAngleFileReader::readFile(), and EulerAngleUpdateFromReporter::UpdateEulerAngle().

◆ _avg_angles

std::vector<EulerAngles> EBSDReader::_avg_angles

protected

Euler Angles by (global) grain ID.

Definition at line 144 of file EBSDReader.h.

Referenced by getEulerAngles(), and readFile().

◆ _avg_data

std::vector<EBSDAvgData> EBSDReader::_avg_data

protected

Averages by (global) grain ID.

Definition at line 141 of file EBSDReader.h.

Referenced by getAvgData(), getAvgData(), getFeatureID(), getFeatureID(), indexFromIndex(), and readFile().

◆ _bins

unsigned int EBSDReader::_bins

protected

number of bins for each quaternion component

Definition at line 165 of file EBSDReader.h.

Referenced by EBSDReader(), and readFile().

◆ _bottom_left

Point EBSDReader::_bottom_left

protected

Definition at line 129 of file EBSDReader.h.

◆ _custom_columns

unsigned int EBSDReader::_custom_columns

protected

number of additional custom data columns

Definition at line 135 of file EBSDReader.h.

Referenced by getAvgDataAccessFunctor(), getPointDataAccessFunctor(), and readFile().

◆ _data

std::vector<EBSDPointData> EBSDReader::_data

protected

Logically three-dimensional data indexed by geometric points in a 1D vector.

Definition at line 138 of file EBSDReader.h.

Referenced by getData(), indexFromPoint(), and readFile().

◆ _dx

Real EBSDReader::_dx

protected

The spacing of the values in x, y and z directions.

Definition at line 174 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _dy

Real EBSDReader::_dy

protected

Definition at line 174 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _dz

Real EBSDReader::_dz

protected

Definition at line 174 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _global_id

std::vector<std::vector<unsigned int> > EBSDReader::_global_id

protected

global ID for given phases and grains

Definition at line 150 of file EBSDReader.h.

Referenced by getAvgData(), getFeatureID(), getGlobalID(), getGrainNum(), getPhaseNum(), and readFile().

◆ _global_id_map

std::map<unsigned int, unsigned int> EBSDReader::_global_id_map

protected

map from feature_id to global_id

Definition at line 147 of file EBSDReader.h.

Referenced by getGlobalID(), and readFile().

◆ _grain_num

unsigned int EBSDReader::_grain_num

protected

Variables needed to determine reduced order parameter values.

Definition at line 128 of file EBSDReader.h.

Referenced by getGrainNum(), and readFile().

◆ _L_norm

unsigned int EBSDReader::_L_norm

protected

L_norm value for averaging.

Definition at line 168 of file EBSDReader.h.

Referenced by readFile().

◆ _maxx

Real EBSDReader::_maxx

protected

Maximum grid extent.

Definition at line 180 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _maxy

Real EBSDReader::_maxy

protected

Definition at line 180 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _maxz

Real EBSDReader::_maxz

protected

Definition at line 180 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _mesh

MooseMesh& EBSDReader::_mesh

protected

MooseMesh Variables.

Definition at line 123 of file EBSDReader.h.

Referenced by buildNodeWeightMaps(), and readFile().

◆ _mesh_dimension

unsigned int EBSDReader::_mesh_dimension

protected

Dimension of the problem domain.

Definition at line 162 of file EBSDReader.h.

Referenced by indexFromPoint().

◆ _minx

Real EBSDReader::_minx

protected

Grid origin.

Definition at line 177 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _miny

Real EBSDReader::_miny

protected

Definition at line 177 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _minz

Real EBSDReader::_minz

protected

Definition at line 177 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _nl

NonlinearSystemBase& EBSDReader::_nl

protected

Definition at line 124 of file EBSDReader.h.

◆ _node_to_grain_weight_map

std::map<dof_id_type, std::vector<Real> > EBSDReader::_node_to_grain_weight_map

protected

Map of grain weights per node.

Definition at line 153 of file EBSDReader.h.

Referenced by buildNodeWeightMaps(), and getNodeToGrainWeightMap().

◆ _node_to_phase_weight_map

std::map<dof_id_type, std::vector<Real> > EBSDReader::_node_to_phase_weight_map

protected

Map of phase weights per node.

Definition at line 156 of file EBSDReader.h.

Referenced by buildNodeWeightMaps(), and getNodeToPhaseWeightMap().

◆ _nx

unsigned EBSDReader::_nx

protected

The number of values in the x, y and z directions.

Definition at line 171 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _ny

unsigned EBSDReader::_ny

protected

Definition at line 171 of file EBSDReader.h.

Referenced by indexFromPoint(), and readFile().

◆ _nz

unsigned EBSDReader::_nz

protected

Definition at line 171 of file EBSDReader.h.

Referenced by readFile().

◆ _range

Point EBSDReader::_range

protected

Definition at line 131 of file EBSDReader.h.

◆ _time_step

const int& EBSDReader::_time_step

protected

current timestep. Maps are only rebuild on mesh change during time step zero

Definition at line 159 of file EBSDReader.h.

Referenced by meshChanged().

◆ _top_right

Point EBSDReader::_top_right

protected

Definition at line 130 of file EBSDReader.h.

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

phase_field/include/userobjects/EBSDReader.h
phase_field/src/userobjects/EBSDReader.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

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EBSDReader()

◆ ~EBSDReader()

Member Function Documentation

◆ buildNodeWeightMaps()

◆ execute()

◆ finalize()

◆ getAvgData() [1/2]

◆ getAvgData() [2/2]

◆ getAvgDataAccessFunctor()

◆ getAvgDataFieldType()

◆ getData()

◆ getEulerAngles()

◆ getFeatureID() [1/2]

◆ getFeatureID() [2/2]

◆ getGlobalID() [1/2]

◆ getGlobalID() [2/2]

◆ getGrainNum() [1/2]

◆ getGrainNum() [2/2]

◆ getNodeToGrainWeightMap()

◆ getNodeToPhaseWeightMap()

◆ getPhaseNum()

◆ getPointDataAccessFunctor()

◆ getPointDataFieldType()

◆ indexFromIndex()

◆ indexFromPoint()

◆ initialize()

◆ meshChanged()

◆ readFile()

◆ validParams()

Member Data Documentation

◆ _angles

◆ _avg_angles

◆ _avg_data

◆ _bins

◆ _bottom_left

◆ _custom_columns

◆ _data

◆ _dx

◆ _dy

◆ _dz

◆ _global_id

◆ _global_id_map

◆ _grain_num

◆ _L_norm

◆ _maxx

◆ _maxy

◆ _maxz

◆ _mesh

◆ _mesh_dimension

◆ _minx

◆ _miny

◆ _minz

◆ _nl

◆ _node_to_grain_weight_map

◆ _node_to_phase_weight_map

◆ _nx

◆ _ny

◆ _nz

◆ _range

◆ _time_step

◆ _top_right