www.mooseframework.org
PolycrystalEBSD.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
13 
14 // Forward Declarations
15 class PolycrystalEBSD;
16 class EBSDReader;
17 
18 template <>
19 InputParameters validParams<PolycrystalEBSD>();
20 
22 {
23 public:
24  PolycrystalEBSD(const InputParameters & parameters);
25 
26  virtual void getGrainsBasedOnPoint(const Point & point,
27  std::vector<unsigned int> & grains) const override;
28  virtual Real getVariableValue(unsigned int op_index, const Point & p) const override;
29  virtual Real getNodalVariableValue(unsigned int op_index, const Node & n) const override;
30  virtual unsigned int getNumGrains() const override;
31 
32 protected:
33  const unsigned int _phase;
35  const std::map<dof_id_type, std::vector<Real>> & _node_to_grain_weight_map;
36 };
37 
validParams< PolycrystalEBSD >
InputParameters validParams< PolycrystalEBSD >()
Definition: PolycrystalEBSD.C:17
PolycrystalEBSD::getNumGrains
virtual unsigned int getNumGrains() const override
Must be overridden by the deriving class to provide the number of grains in the polycrystal structure...
Definition: PolycrystalEBSD.C:56
PolycrystalEBSD
Definition: PolycrystalEBSD.h:21
PolycrystalEBSD::_node_to_grain_weight_map
const std::map< dof_id_type, std::vector< Real > > & _node_to_grain_weight_map
Definition: PolycrystalEBSD.h:35
PolycrystalEBSD::_ebsd_reader
const EBSDReader & _ebsd_reader
Definition: PolycrystalEBSD.h:34
PolycrystalEBSD::getGrainsBasedOnPoint
virtual void getGrainsBasedOnPoint(const Point &point, std::vector< unsigned int > &grains) const override
Method for retrieving active grain IDs based on some point in the mesh.
Definition: PolycrystalEBSD.C:35
PolycrystalUserObjectBase
This object provides the base capability for creating proper polycrystal ICs.
Definition: PolycrystalUserObjectBase.h:27
PolycrystalEBSD::_phase
const unsigned int _phase
Definition: PolycrystalEBSD.h:33
EBSDReader
A GeneralUserObject that reads an EBSD file and stores the centroid data in a data structure which in...
Definition: EBSDReader.h:36
PolycrystalUserObjectBase.h
PolycrystalEBSD::getVariableValue
virtual Real getVariableValue(unsigned int op_index, const Point &p) const override
Returns the variable value for a given op_index and mesh point.
Definition: PolycrystalEBSD.C:93
PolycrystalEBSD::getNodalVariableValue
virtual Real getNodalVariableValue(unsigned int op_index, const Node &n) const override
Similarly to the getVariableValue method, this method also returns values but may be optimized for re...
Definition: PolycrystalEBSD.C:65
PolycrystalEBSD::PolycrystalEBSD
PolycrystalEBSD(const InputParameters &parameters)
Definition: PolycrystalEBSD.C:26