www.mooseframework.org
PolycrystalEBSD.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
3 /* */
4 /* All contents are licensed under LGPL V2.1 */
5 /* See LICENSE for full restrictions */
6 /****************************************************************/
7 #ifndef POLYCRYSTALEBSD_H
8 #define POLYCRYSTALEBSD_H
9 
11 
12 // Forward Declarations
13 class PolycrystalEBSD;
14 class EBSDReader;
15 
16 template <>
17 InputParameters validParams<PolycrystalEBSD>();
18 
20 {
21 public:
22  PolycrystalEBSD(const InputParameters & parameters);
23 
24  virtual void getGrainsBasedOnPoint(const Point & point,
25  std::vector<unsigned int> & grains) const override;
26  virtual Real getVariableValue(unsigned int op_index, const Point & p) const override;
27  virtual Real getNodalVariableValue(unsigned int op_index, const Node & n) const override;
28  virtual unsigned int getNumGrains() const override;
29 
30 protected:
31  const unsigned int _phase;
33  const std::map<dof_id_type, std::vector<Real>> & _node_to_grain_weight_map;
34 };
35 
36 #endif // POLYCRYSTALEBSD_H
virtual Real getVariableValue(unsigned int op_index, const Point &p) const override
Returns the variable value for a given op_index and mesh point.
const unsigned int _phase
This object provides the base capability for creating proper polycrystal ICs.
InputParameters validParams< PolycrystalEBSD >()
const std::map< dof_id_type, std::vector< Real > > & _node_to_grain_weight_map
const EBSDReader & _ebsd_reader
A GeneralUserObject that reads an EBSD file and stores the centroid data in a data structure which in...
Definition: EBSDReader.h:34
PolycrystalEBSD(const InputParameters &parameters)
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...
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.
virtual unsigned int getNumGrains() const override
Must be overridden by the deriving class to provide the number of grains in the polycrystal structure...