Mesh generated from parameters. More...

#include <EBSDMesh.h>

Inheritance diagram for EBSDMesh:

Classes
struct	EBSDMeshGeometry

Public Types
enum	ParallelType { ParallelType::DEFAULT, ParallelType::REPLICATED, ParallelType::DISTRIBUTED }

typedef std::pair< const Node *, BoundaryID >	PeriodicNodeInfo

typedef DataFileName	DataFileParameterType

Public Member Functions
	EBSDMesh (const InputParameters &parameters)

virtual	~EBSDMesh ()

virtual void	buildMesh ()

const EBSDMeshGenerator::Geometry &	getEBSDGeometry () const

const std::string &	getEBSDFilename () const

virtual std::unique_ptr< MooseMesh >	safeClone () const override

virtual Real	getMinInDimension (unsigned int component) const override

virtual Real	getMaxInDimension (unsigned int component) const override

virtual void	prepared (bool state) override

bool	prepared () const

virtual MooseMesh &	clone () const

void	determineUseDistributedMesh ()

std::unique_ptr< MeshBase >	buildMeshBaseObject (unsigned int dim=libMesh::invalid_uint)

std::unique_ptr< T >	buildTypedMesh (unsigned int dim=libMesh::invalid_uint)

void	setMeshBase (std::unique_ptr< MeshBase > mesh_base)

virtual void	init ()

virtual unsigned int	dimension () const

virtual unsigned int	effectiveSpatialDimension () const

unsigned int	getBlocksMaxDimension (const std::vector< SubdomainName > &blocks) const

std::vector< BoundaryID >	getBoundaryIDs (const Elem *const elem, const unsigned short int side) const

const std::set< BoundaryID > &	getBoundaryIDs () const

std::vector< BoundaryID >	getBoundaryIDs (const std::vector< BoundaryName > &boundary_name, bool generate_unknown=false) const

const Elem *	getLowerDElem (const Elem *, unsigned short int) const

unsigned int	getHigherDSide (const Elem *elem) const

void	buildNodeList ()

void	buildBndElemList ()

const std::map< dof_id_type, std::vector< dof_id_type > > &	nodeToElemMap ()

const std::map< dof_id_type, std::vector< dof_id_type > > &	nodeToActiveSemilocalElemMap ()

virtual bnd_node_iterator	bndNodesBegin ()

virtual bnd_node_iterator	bndNodesEnd ()

virtual bnd_elem_iterator	bndElemsBegin ()

virtual bnd_elem_iterator	bndElemsEnd ()

void	buildNodeListFromSideList ()

void	buildSideList (std::vector< dof_id_type > &el, std::vector< unsigned short int > &sl, std::vector< boundary_id_type > &il)

std::vector< std::tuple< dof_id_type, unsigned short int, boundary_id_type > >	buildSideList ()

std::vector< std::tuple< dof_id_type, unsigned short int, boundary_id_type > >	buildActiveSideList () const

unsigned int	sideWithBoundaryID (const Elem *const elem, const BoundaryID boundary_id) const

MeshBase::node_iterator	localNodesBegin ()

MeshBase::const_node_iterator	localNodesBegin () const

MeshBase::node_iterator	localNodesEnd ()

MeshBase::const_node_iterator	localNodesEnd () const

MeshBase::element_iterator	activeLocalElementsBegin ()

MeshBase::const_element_iterator	activeLocalElementsBegin () const

const MeshBase::element_iterator	activeLocalElementsEnd ()

const MeshBase::const_element_iterator	activeLocalElementsEnd () const

virtual dof_id_type	nNodes () const

virtual dof_id_type	nElem () const

virtual dof_id_type	maxNodeId () const

virtual dof_id_type	maxElemId () const

virtual const Node &	node (const dof_id_type i) const

virtual Node &	node (const dof_id_type i)

virtual const Node &	nodeRef (const dof_id_type i) const

virtual Node &	nodeRef (const dof_id_type i)

virtual const Node *	nodePtr (const dof_id_type i) const

virtual Node *	nodePtr (const dof_id_type i)

virtual const Node *	queryNodePtr (const dof_id_type i) const

virtual Node *	queryNodePtr (const dof_id_type i)

virtual Elem *	elem (const dof_id_type i)

virtual const Elem *	elem (const dof_id_type i) const

virtual Elem *	elemPtr (const dof_id_type i)

virtual const Elem *	elemPtr (const dof_id_type i) const

virtual Elem *	queryElemPtr (const dof_id_type i)

virtual const Elem *	queryElemPtr (const dof_id_type i) const

void	needsPrepareForUse ()

void	meshChanged ()

virtual void	onMeshChanged ()

void	cacheChangedLists ()

ConstElemPointerRange *	refinedElementRange () const

ConstElemPointerRange *	coarsenedElementRange () const

const std::vector< const Elem *> &	coarsenedElementChildren (const Elem *elem) const

void	updateActiveSemiLocalNodeRange (std::set< dof_id_type > &ghosted_elems)

bool	isSemiLocal (Node *const node) const

const std::unordered_map< boundary_id_type, std::unordered_set< dof_id_type > > &	getBoundariesToElems () const

const std::unordered_map< boundary_id_type, std::unordered_set< dof_id_type > > &	getBoundariesToActiveSemiLocalElemIds () const

std::unordered_set< dof_id_type >	getBoundaryActiveSemiLocalElemIds (BoundaryID bid) const

std::unordered_set< dof_id_type >	getBoundaryActiveNeighborElemIds (BoundaryID bid) const

bool	isBoundaryFullyExternalToSubdomains (BoundaryID bid, const std::set< SubdomainID > &blk_group) const

const std::set< SubdomainID > &	meshSubdomains () const

const std::set< BoundaryID > &	meshBoundaryIds () const

const std::set< BoundaryID > &	meshSidesetIds () const

const std::set< BoundaryID > &	meshNodesetIds () const

void	setBoundaryToNormalMap (std::unique_ptr< std::map< BoundaryID, RealVectorValue >> boundary_map)

void	setBoundaryToNormalMap (std::map< BoundaryID, RealVectorValue > *boundary_map)

void	setMeshBoundaryIDs (std::set< BoundaryID > boundary_IDs)

const RealVectorValue &	getNormalByBoundaryID (BoundaryID id) const

bool	prepare (const MeshBase *mesh_to_clone)

void	update ()

unsigned int	uniformRefineLevel () const

void	setUniformRefineLevel (unsigned int, bool deletion=true)

bool	skipDeletionRepartitionAfterRefine () const

bool	skipRefineWhenUseSplit () const

void	addGhostedBoundary (BoundaryID boundary_id)

void	setGhostedBoundaryInflation (const std::vector< Real > &inflation)

const std::set< unsigned int > &	getGhostedBoundaries () const

const std::vector< Real > &	getGhostedBoundaryInflation () const

void	ghostGhostedBoundaries ()

void	needGhostGhostedBoundaries (bool needghost)

unsigned int	getPatchSize () const

unsigned int	getGhostingPatchSize () const

unsigned int	getMaxLeafSize () const

void	setPatchUpdateStrategy (Moose::PatchUpdateType patch_update_strategy)

const Moose::PatchUpdateType &	getPatchUpdateStrategy () const

BoundingBox	getInflatedProcessorBoundingBox (Real inflation_multiplier=0.01) const

	operator libMesh::MeshBase & ()

	operator const libMesh::MeshBase & () const

MeshBase &	getMesh ()

MeshBase &	getMesh (const std::string &name)

const MeshBase &	getMesh () const

const MeshBase &	getMesh (const std::string &name) const

const MeshBase *	getMeshPtr () const

void	printInfo (std::ostream &os=libMesh::out, const unsigned int verbosity=0) const

const std::set< SubdomainID > &	getNodeBlockIds (const Node &node) const

const std::vector< dof_id_type > &	getNodeList (boundary_id_type nodeset_id) const

const Node *	addUniqueNode (const Point &p, Real tol=1e-6)

Node *	addQuadratureNode (const Elem *elem, const unsigned short int side, const unsigned int qp, BoundaryID bid, const Point &point)

Node *	getQuadratureNode (const Elem *elem, const unsigned short int side, const unsigned int qp)

void	clearQuadratureNodes ()

BoundaryID	getBoundaryID (const BoundaryName &boundary_name) const

SubdomainID	getSubdomainID (const SubdomainName &subdomain_name) const

std::vector< SubdomainID >	getSubdomainIDs (const std::vector< SubdomainName > &subdomain_name) const

void	setSubdomainName (SubdomainID subdomain_id, const SubdomainName &name)

const std::string &	getSubdomainName (SubdomainID subdomain_id) const

std::vector< SubdomainName >	getSubdomainNames (const std::vector< SubdomainID > &subdomain_ids) const

void	setBoundaryName (BoundaryID boundary_id, BoundaryName name)

const std::string &	getBoundaryName (BoundaryID boundary_id)

void	buildPeriodicNodeMap (std::multimap< dof_id_type, dof_id_type > &periodic_node_map, unsigned int var_number, PeriodicBoundaries *pbs) const

void	buildPeriodicNodeSets (std::map< BoundaryID, std::set< dof_id_type >> &periodic_node_sets, unsigned int var_number, PeriodicBoundaries *pbs) const

Real	dimensionWidth (unsigned int component) const

bool	detectOrthogonalDimRanges (Real tol=1e-6)

void	addPeriodicVariable (unsigned int var_num, BoundaryID primary, BoundaryID secondary)

bool	isTranslatedPeriodic (unsigned int nonlinear_var_num, unsigned int component) const

RealVectorValue	minPeriodicVector (unsigned int nonlinear_var_num, Point p, Point q) const

Real	minPeriodicDistance (unsigned int nonlinear_var_num, Point p, Point q) const

const std::pair< BoundaryID, BoundaryID > *	getPairedBoundaryMapping (unsigned int component)

void	buildRefinementAndCoarseningMaps (Assembly *assembly)

const std::vector< std::vector< QpMap > > &	getRefinementMap (const Elem &elem, int parent_side, int child, int child_side)

const std::vector< std::pair< unsigned int, QpMap > > &	getCoarseningMap (const Elem &elem, int input_side)

void	changeBoundaryId (const boundary_id_type old_id, const boundary_id_type new_id, bool delete_prev)

const std::set< BoundaryID > &	getSubdomainBoundaryIds (const SubdomainID subdomain_id) const

std::set< BoundaryID >	getSubdomainInterfaceBoundaryIds (const SubdomainID subdomain_id) const

std::set< SubdomainID >	getBoundaryConnectedBlocks (const BoundaryID bid) const

std::set< SubdomainID >	getBoundaryConnectedSecondaryBlocks (const BoundaryID bid) const

std::set< SubdomainID >	getInterfaceConnectedBlocks (const BoundaryID bid) const

const std::set< SubdomainID > &	getBlockConnectedBlocks (const SubdomainID subdomain_id) const

bool	isBoundaryNode (dof_id_type node_id) const

bool	isBoundaryNode (dof_id_type node_id, BoundaryID bnd_id) const

bool	isBoundaryElem (dof_id_type elem_id) const

bool	isBoundaryElem (dof_id_type elem_id, BoundaryID bnd_id) const

void	errorIfDistributedMesh (std::string name) const

bool	isDistributedMesh () const

bool	isParallelTypeForced () const

void	setParallelType (ParallelType parallel_type)

void	setParallelType (ParallelType parallel_type)

const MooseEnum &	partitionerName () const

bool	isPartitionerForced () const

void	allowRecovery (bool allow)

void	setCustomPartitioner (Partitioner *partitioner)

bool	isRegularOrthogonal ()

bool	hasSecondOrderElements ()

virtual std::unique_ptr< PointLocatorBase >	getPointLocator () const

virtual std::string	getFileName () const

void	needsRemoteElemDeletion (bool need_delete)

bool	needsRemoteElemDeletion () const

void	allowRemoteElementRemoval (bool allow_removal)

bool	allowRemoteElementRemoval () const

void	deleteRemoteElements ()

bool	hasMeshBase () const

bool	hasElementID (const std::string &id_name) const

unsigned int	getElementIDIndex (const std::string &id_name) const

dof_id_type	maxElementID (unsigned int elem_id_index) const

dof_id_type	minElementID (unsigned int elem_id_index) const

bool	areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const

std::set< dof_id_type >	getAllElemIDs (unsigned int elem_id_index) const

std::set< dof_id_type >	getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const

std::unordered_map< dof_id_type, std::set< dof_id_type > >	getElemIDMapping (const std::string &from_id_name, const std::string &to_id_name) const

void	cacheFaceInfoVariableOwnership () const

void	cacheFVElementalDoFs () const

void	computeFiniteVolumeCoords () const

void	isDisplaced (bool is_displaced)

bool	isDisplaced () const

const std::map< boundary_id_type, std::vector< dof_id_type > > &	nodeSetNodes () const

Moose::CoordinateSystemType	getCoordSystem (SubdomainID sid) const

const std::map< SubdomainID, Moose::CoordinateSystemType > &	getCoordSystem () const

Moose::CoordinateSystemType	getUniqueCoordSystem () const

void	setCoordSystem (const std::vector< SubdomainName > &blocks, const MultiMooseEnum &coord_sys)

void	setAxisymmetricCoordAxis (const MooseEnum &rz_coord_axis)

void	setGeneralAxisymmetricCoordAxes (const std::vector< SubdomainName > &blocks, const std::vector< std::pair< Point, RealVectorValue >> &axes)

const std::pair< Point, RealVectorValue > &	getGeneralAxisymmetricCoordAxis (SubdomainID subdomain_id) const

bool	usingGeneralAxisymmetricCoordAxes () const

unsigned int	getAxisymmetricRadialCoord () const

void	checkCoordinateSystems ()

void	setCoordData (const MooseMesh &other_mesh)

void	markFiniteVolumeInfoDirty ()

bool	isFiniteVolumeInfoDirty () const

MooseAppCoordTransform &	coordTransform ()

const MooseUnits &	lengthUnit () const

const std::unordered_map< std::pair< const Elem , unsigned short int >, const Elem > &	getLowerDElemMap () const

bool	isSplit () const

void	buildFiniteVolumeInfo () const

void	setupFiniteVolumeMeshData () const

void	doingPRefinement (bool doing_p_refinement)

bool	doingPRefinement () const

const std::vector< QpMap > &	getPRefinementMap (const Elem &elem) const

const std::vector< QpMap > &	getPRefinementSideMap (const Elem &elem) const

const std::vector< QpMap > &	getPCoarseningMap (const Elem &elem) const

const std::vector< QpMap > &	getPCoarseningSideMap (const Elem &elem) const

void	buildPRefinementAndCoarseningMaps (Assembly *assembly)

bool	isLowerD (const SubdomainID subdomain_id) const

bool	hasLowerD () 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 &	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 &name, const std::string *param=nullptr) const

PerfGraph &	perfGraph ()

ConstElemRange *	getActiveLocalElementRange ()

ConstElemRange *	getActiveLocalElementRange ()

NodeRange *	getActiveNodeRange ()

NodeRange *	getActiveNodeRange ()

SemiLocalNodeRange *	getActiveSemiLocalNodeRange () const

SemiLocalNodeRange *	getActiveSemiLocalNodeRange () const

ConstNodeRange *	getLocalNodeRange ()

ConstNodeRange *	getLocalNodeRange ()

StoredRange< MooseMesh::const_bnd_node_iterator, const BndNode >	getBoundaryNodeRange ()

StoredRange< MooseMesh::const_bnd_node_iterator, const BndNode >	getBoundaryNodeRange ()

StoredRange< MooseMesh::const_bnd_elem_iterator, const BndElement >	getBoundaryElementRange ()

StoredRange< MooseMesh::const_bnd_elem_iterator, const BndElement >	getBoundaryElementRange ()

bool	isCustomPartitionerRequested () const

bool	isCustomPartitionerRequested () const

void	setIsCustomPartitionerRequested (bool cpr)

void	setIsCustomPartitionerRequested (bool cpr)

unsigned int	nFace () const

unsigned int	nFace () const

const std::vector< const FaceInfo *> &	faceInfo () const

const FaceInfo *	faceInfo (const Elem *elem, unsigned int side) const

const std::vector< const FaceInfo *> &	faceInfo () const

const FaceInfo *	faceInfo (const Elem *elem, unsigned int side) const

face_info_iterator	ownedFaceInfoBegin ()

face_info_iterator	ownedFaceInfoBegin ()

face_info_iterator	ownedFaceInfoEnd ()

face_info_iterator	ownedFaceInfoEnd ()

elem_info_iterator	ownedElemInfoBegin ()

elem_info_iterator	ownedElemInfoBegin ()

elem_info_iterator	ownedElemInfoEnd ()

elem_info_iterator	ownedElemInfoEnd ()

const ElemInfo &	elemInfo (const dof_id_type id) const

const ElemInfo &	elemInfo (const dof_id_type id) const

const std::vector< const ElemInfo *> &	elemInfoVector () const

const std::vector< const ElemInfo *> &	elemInfoVector () const

const std::vector< FaceInfo > &	allFaceInfo () const

const std::vector< FaceInfo > &	allFaceInfo () 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	setSubdomainName (MeshBase &mesh, SubdomainID subdomain_id, const SubdomainName &name)

static void	changeBoundaryId (MeshBase &mesh, const boundary_id_type old_id, const boundary_id_type new_id, bool delete_prev)

static MooseEnum	partitioning ()

static MooseEnum	elemTypes ()

static void	setPartitioner (MeshBase &mesh_base, MooseEnum &partitioner, bool use_distributed_mesh, const InputParameters &params, MooseObject &context_obj)

Public Attributes
const ConsoleStream	_console

Protected Types
typedef std::vector< BndNode *>::iterator	bnd_node_iterator_imp

typedef std::vector< BndNode *>::const_iterator	const_bnd_node_iterator_imp

typedef std::vector< BndElement *>::iterator	bnd_elem_iterator_imp

typedef std::vector< BndElement *>::const_iterator	const_bnd_elem_iterator_imp

Protected Member Functions
void	readEBSDHeader ()
	Read the EBSD data file header. More...

void	cacheInfo ()

void	freeBndNodes ()

void	freeBndElems ()

void	setPartitionerHelper (MeshBase *mesh=nullptr)

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

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

Protected Attributes
std::string	_filename
	Name of the file containing the EBSD data. More...

EBSDMeshGenerator::Geometry	_geometry
	EBSD data file mesh information. More...

	X

	Y

	Z

	MIN

	MAX

MooseEnum	_dim

unsigned int	_nx

unsigned int	_ny

unsigned int	_nz

Real	_xmin

Real	_xmax

Real	_ymin

Real	_ymax

Real	_zmin

Real	_zmax

bool	_gauss_lobatto_grid

Real	_bias_x

Real	_bias_y

Real	_bias_z

bool	_dims_may_have_changed

std::vector< std::unique_ptr< GhostingFunctor > >	_ghosting_functors

std::vector< std::shared_ptr< RelationshipManager > >	_relationship_managers

bool	_built_from_other_mesh

ParallelType	_parallel_type

bool	_use_distributed_mesh

bool	_distribution_overridden

bool	_parallel_type_overridden

std::unique_ptr< libMesh::MeshBase >	_mesh

MooseEnum	_partitioner_name

bool	_partitioner_overridden

std::unique_ptr< Partitioner >	_custom_partitioner

bool	_custom_partitioner_requested

unsigned int	_uniform_refine_level

bool	_skip_refine_when_use_split

bool	_skip_deletion_repartition_after_refine

bool	_is_changed

bool	_is_nemesis

bool	_moose_mesh_prepared

std::unique_ptr< ConstElemPointerRange >	_refined_elements

std::unique_ptr< ConstElemPointerRange >	_coarsened_elements

std::map< const Elem , std::vector< const Elem > >	_coarsened_element_children

std::set< Node *>	_semilocal_node_list

std::unique_ptr< ConstElemRange >	_active_local_elem_range

std::unique_ptr< SemiLocalNodeRange >	_active_semilocal_node_range

std::unique_ptr< NodeRange >	_active_node_range

std::unique_ptr< ConstNodeRange >	_local_node_range

std::unique_ptr< StoredRange< MooseMesh::const_bnd_node_iterator, const BndNode *> >	_bnd_node_range

std::unique_ptr< StoredRange< MooseMesh::const_bnd_elem_iterator, const BndElement *> >	_bnd_elem_range

std::map< dof_id_type, std::vector< dof_id_type > >	_node_to_elem_map

bool	_node_to_elem_map_built

std::map< dof_id_type, std::vector< dof_id_type > >	_node_to_active_semilocal_elem_map

bool	_node_to_active_semilocal_elem_map_built

std::set< SubdomainID >	_mesh_subdomains

std::unique_ptr< std::map< BoundaryID, RealVectorValue > >	_boundary_to_normal_map

std::vector< BndNode *>	_bnd_nodes

std::map< boundary_id_type, std::set< dof_id_type > >	_bnd_node_ids

std::vector< BndElement *>	_bnd_elems

std::unordered_map< boundary_id_type, std::unordered_set< dof_id_type > >	_bnd_elem_ids

std::map< dof_id_type, Node *>	_quadrature_nodes

std::map< dof_id_type, std::map< unsigned int, std::map< dof_id_type, Node *> > >	_elem_to_side_to_qp_to_quadrature_nodes

std::vector< BndNode >	_extra_bnd_nodes

std::map< dof_id_type, std::set< SubdomainID > >	_block_node_list

std::map< boundary_id_type, std::vector< dof_id_type > >	_node_set_nodes

std::set< unsigned int >	_ghosted_boundaries

std::vector< Real >	_ghosted_boundaries_inflation

unsigned int	_patch_size

unsigned int	_ghosting_patch_size

unsigned int	_max_leaf_size

Moose::PatchUpdateType	_patch_update_strategy

std::vector< Node *>	_node_map

bool	_regular_orthogonal_mesh

std::vector< std::vector< Real > >	_bounds

std::vector< std::pair< BoundaryID, BoundaryID > >	_paired_boundary

const bool	_is_split

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

std::set< BoundaryID >	_mesh_boundary_ids

std::set< BoundaryID >	_mesh_sideset_ids

std::set< BoundaryID >	_mesh_nodeset_ids

const Parallel::Communicator &	_communicator

Detailed Description

Mesh generated from parameters.

Definition at line 20 of file EBSDMesh.h.

Constructor & Destructor Documentation

◆ EBSDMesh()

EBSDMesh::EBSDMesh ( const InputParameters & parameters )

Definition at line 42 of file EBSDMesh.C.

   : GeneratedMesh(parameters), _filename(getParam<FileName>("filename"))
 {
   mooseDeprecated(
       "EBSDMesh is deprecated, please use the EBSDMeshGenerator instead. For example:\n\n[Mesh]\n  "
       "type = EBDSMesh\n  filename = my_ebsd_data.dat\n[]\n\nbecomes\n\n[Mesh]\n  [ebsd_mesh]\n    "
       "type = EBDSMeshGenerator\n    filename = my_ebsd_data.dat\n  []\n[]");
 
   if (_nx != 1 || _ny != 1 || _nz != 1)
     mooseWarning("Do not specify mesh geometry information, it is read from the EBSD file.");
 }

◆ ~EBSDMesh()

EBSDMesh::~EBSDMesh ( )

virtual

Definition at line 54 of file EBSDMesh.C.

54 {}

Member Function Documentation

◆ buildMesh()

void EBSDMesh::buildMesh ( )

virtual

Reimplemented from GeneratedMesh.

Definition at line 137 of file EBSDMesh.C.

 {
   readEBSDHeader();
 
   unsigned int uniform_refine = getParam<unsigned int>("uniform_refine");
   _dim = (_geometry.dim == 1 ? "1" : (_geometry.dim == 2 ? "2" : "3"));
 
   std::array<unsigned int, 3> nr;
   nr[0] = _geometry.n[0];
   nr[1] = _geometry.n[1];
   nr[2] = _geometry.n[2];
 
   // set min/max box length
   _xmin = _geometry.min[0];
   _xmax = nr[0] * _geometry.d[0] + _geometry.min[0];
   _ymin = _geometry.min[1];
   _ymax = nr[1] * _geometry.d[1] + _geometry.min[1];
   _zmin = _geometry.min[2];
   _zmax = nr[2] * _geometry.d[2] + _geometry.min[2];
 
   // check if the requested uniform refine level is possible and determine initial grid size
   for (unsigned int i = 0; i < uniform_refine; ++i)
     for (unsigned int j = 0; j < _geometry.dim; ++j)
     {
       if (nr[j] % 2 != 0)
         mooseError("EBSDMesh error. Requested uniform_refine levels not possible.");
       nr[j] /= 2;
     }
 
   _nx = nr[0];
   _ny = nr[1];
   _nz = nr[2];
 
   GeneratedMesh::buildMesh();
 }

◆ getEBSDFilename()

const std::string& EBSDMesh::getEBSDFilename ( ) const

inline

Definition at line 44 of file EBSDMesh.h.

44 { return _filename; }

EBSDMesh::_filename

std::string _filename

Name of the file containing the EBSD data.

Definition: EBSDMesh.h:51

◆ getEBSDGeometry()

const EBSDMeshGenerator::Geometry& EBSDMesh::getEBSDGeometry ( ) const

inline

Definition at line 43 of file EBSDMesh.h.

43 { return _geometry; }

EBSDMesh::_geometry

EBSDMeshGenerator::Geometry _geometry

EBSD data file mesh information.

Definition: EBSDMesh.h:54

◆ readEBSDHeader()

void EBSDMesh::readEBSDHeader ( )

protected

Read the EBSD data file header.

Definition at line 57 of file EBSDMesh.C.

Referenced by buildMesh().

 {
   std::ifstream stream_in(_filename.c_str());
 
   if (!stream_in)
     paramError("filename", "Can't open EBSD file: ", _filename);
 
   // Labels to look for in the header
   std::vector<std::string> labels = {
       "x_step", "x_dim", "y_step", "y_dim", "z_step", "z_dim", "x_min", "y_min", "z_min"};
 
   // Dimension variables to store once they are found in the header
   // X_step, X_Dim, Y_step, Y_Dim, Z_step, Z_Dim
   // We use Reals even though the Dim values should all be integers...
   std::vector<Real> label_vals(labels.size(), 0.0);
 
   std::string line;
   while (std::getline(stream_in, line))
   {
     // We need to process the comment lines that have:
     // X_step, X_Dim
     // Y_step, Y_Dim
     // Z_step, Z_Dim
     // in them. The labels are case insensitive.
     if (line.find("#") == 0)
     {
       // Process lines that start with a comment character (comments and meta data)
       std::transform(line.begin(), line.end(), line.begin(), ::tolower);
 
       for (unsigned i = 0; i < labels.size(); ++i)
         if (line.find(labels[i]) != std::string::npos)
         {
           std::string dummy;
           std::istringstream iss(line);
           iss >> dummy >> dummy >> label_vals[i];
 
           // One label per line, break out of for loop over labels
           break;
         }
     }
     else
       // first non comment line marks the end of the header
       break;
   }
 
   // Copy stuff out of the label_vars array into class variables
   _geometry.d[0] = label_vals[0];
   _geometry.n[0] = label_vals[1];
   _geometry.min[0] = label_vals[6];
 
   _geometry.d[1] = label_vals[2];
   _geometry.n[1] = label_vals[3];
   _geometry.min[1] = label_vals[7];
 
   _geometry.d[2] = label_vals[4];
   _geometry.n[2] = label_vals[5];
   _geometry.min[2] = label_vals[8];
 
   unsigned int dim;
 
   // determine mesh dimension
   for (dim = 3; dim > 0 && _geometry.n[dim - 1] == 0; --dim)
     ;
 
   // check if the data has nonzero stepsizes
   for (unsigned i = 0; i < dim; ++i)
   {
     if (_geometry.n[i] == 0)
       mooseError("Error reading header, EBSD grid size is zero.");
     if (_geometry.d[i] == 0.0)
       mooseError("Error reading header, EBSD data step size is zero.");
   }
 
   if (dim == 0)
     mooseError("Error reading header, EBSD data is zero dimensional.");
 
   _geometry.dim = dim;
 }

◆ validParams()

InputParameters EBSDMesh::validParams ( )

static

Definition at line 18 of file EBSDMesh.C.

 {
   InputParameters params = GeneratedMesh::validParams();
   params.addClassDescription("Mesh generated from a specified DREAM.3D EBSD data file.");
   params.addRequiredParam<FileName>("filename", "The name of the file containing the EBSD data");
   params.addParam<unsigned int>(
       "uniform_refine", 0, "Number of coarsening levels available in adaptive mesh refinement.");
 
   // suppress parameters
   params.suppressParameter<MooseEnum>("dim");
   params.set<MooseEnum>("dim") = MooseEnum("1=1 2 3", "1");
   params.suppressParameter<unsigned int>("nx");
   params.suppressParameter<unsigned int>("ny");
   params.suppressParameter<unsigned int>("nz");
   params.suppressParameter<Real>("xmin");
   params.suppressParameter<Real>("ymin");
   params.suppressParameter<Real>("zmin");
   params.suppressParameter<Real>("xmax");
   params.suppressParameter<Real>("ymax");
   params.suppressParameter<Real>("zmax");
 
   return params;
 }

Member Data Documentation

◆ _filename

std::string EBSDMesh::_filename

protected

Name of the file containing the EBSD data.

Definition at line 51 of file EBSDMesh.h.

Referenced by getEBSDFilename(), and readEBSDHeader().

◆ _geometry

EBSDMeshGenerator::Geometry EBSDMesh::_geometry

protected

EBSD data file mesh information.

Definition at line 54 of file EBSDMesh.h.

Referenced by buildMesh(), getEBSDGeometry(), and readEBSDHeader().

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

phase_field/include/mesh/EBSDMesh.h
phase_field/src/mesh/EBSDMesh.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EBSDMesh()

◆ ~EBSDMesh()

Member Function Documentation

◆ buildMesh()

◆ getEBSDFilename()

◆ getEBSDGeometry()

◆ readEBSDHeader()

◆ validParams()

Member Data Documentation

◆ _filename

◆ _geometry