www.mooseframework.org
OutputEulerAngles.C
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 #include "OutputEulerAngles.h"
11 #include "GrainTracker.h"
12 #include "EulerAngleProvider.h"
13 
14 registerMooseObject("PhaseFieldApp", OutputEulerAngles);
15 
18 {
20  params.addClassDescription("Output Euler angles from user object to an AuxVariable.");
21  params.addRequiredParam<UserObjectName>("euler_angle_provider",
22  "Name of Euler angle provider user object");
23  params.addRequiredParam<UserObjectName>("grain_tracker",
24  "The GrainTracker UserObject to get values from.");
25  MooseEnum euler_angles("phi1 Phi phi2");
26  params.addRequiredParam<MooseEnum>("output_euler_angle", euler_angles, "Euler angle to output");
27  return params;
28 }
29 
31  : AuxKernel(parameters),
32  _euler(getUserObject<EulerAngleProvider>("euler_angle_provider")),
33  _grain_tracker(getUserObject<GrainTracker>("grain_tracker")),
34  _output_euler_angle(getParam<MooseEnum>("output_euler_angle"))
35 {
36 }
37 
38 void
40 {
41  // ID of unique grain at current point
42  const auto grain_id =
45  0);
46 
47  // Recover euler angles for current grain
48  RealVectorValue angles;
49  if (grain_id >= 0)
50  angles = _euler.getEulerAngles(grain_id);
51 
52  // Return specific euler angle
53  _value = angles(_output_euler_angle);
54 }
55 
56 Real
58 {
59  return _value;
60 }
virtual Real computeValue()
const Node *const & _current_node
const EulerAngleProvider & _euler
Object providing the Euler angles.
void addRequiredParam(const std::string &name, const std::string &doc_string)
virtual void precalculateValue()
MooseEnum _output_euler_angle
Number of grains.
Real _value
precalculated element value
OutputEulerAngles(const InputParameters &parameters)
registerMooseObject("PhaseFieldApp", OutputEulerAngles)
Output euler angles from user object to an AuxVariable.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual const EulerAngles & getEulerAngles(unsigned int) const =0
static InputParameters validParams()
const Elem *const & _current_elem
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()
Abstract base class for user objects that implement the Euler Angle provider interface.
virtual Real getEntityValue(dof_id_type node_id, FieldType field_type, std::size_t var_index=0) const override
Definition: GrainTracker.C:120
const GrainTracker & _grain_tracker
Grain tracker object.