www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OutputEulerAngles Class Reference

Output euler angles from user object to an AuxVariable. More...

#include <OutputEulerAngles.h>

Inheritance diagram for OutputEulerAngles:
[legend]

Public Member Functions

 OutputEulerAngles (const InputParameters &parameters)
 

Protected Member Functions

virtual Real computeValue ()
 
virtual void precalculateValue ()
 

Protected Attributes

const EulerAngleProvider_euler
 Object providing the Euler angles. More...
 
const GrainTracker_grain_tracker
 Grain tracker object. More...
 
MooseEnum _output_euler_angle
 Number of grains. More...
 
Real _value
 precalculated element value More...
 

Detailed Description

Output euler angles from user object to an AuxVariable.

Definition at line 25 of file OutputEulerAngles.h.

Constructor & Destructor Documentation

OutputEulerAngles::OutputEulerAngles ( const InputParameters &  parameters)

Definition at line 26 of file OutputEulerAngles.C.

27  : AuxKernel(parameters),
28  _euler(getUserObject<EulerAngleProvider>("euler_angle_provider")),
29  _grain_tracker(getUserObject<GrainTracker>("grain_tracker")),
30  _output_euler_angle(getParam<MooseEnum>("output_euler_angle"))
31 {
32 }
const EulerAngleProvider & _euler
Object providing the Euler angles.
MooseEnum _output_euler_angle
Number of grains.
const GrainTracker & _grain_tracker
Grain tracker object.

Member Function Documentation

Real OutputEulerAngles::computeValue ( )
protectedvirtual

Definition at line 53 of file OutputEulerAngles.C.

54 {
55  return _value;
56 }
Real _value
precalculated element value
void OutputEulerAngles::precalculateValue ( )
protectedvirtual

Definition at line 35 of file OutputEulerAngles.C.

36 {
37  // ID of unique grain at current point
38  const auto grain_id =
39  _grain_tracker.getEntityValue((isNodal() ? _current_node->id() : _current_elem->id()),
41  0);
42 
43  // Recover euler angles for current grain
44  RealVectorValue angles;
45  if (grain_id >= 0)
46  angles = _euler.getEulerAngles(grain_id);
47 
48  // Return specific euler angle
49  _value = angles(_output_euler_angle);
50 }
const EulerAngleProvider & _euler
Object providing the Euler angles.
MooseEnum _output_euler_angle
Number of grains.
Real _value
precalculated element value
virtual Real getEntityValue(dof_id_type node_id, FieldType field_type, std::size_t var_index=0) const override
Definition: GrainTracker.C:84
const GrainTracker & _grain_tracker
Grain tracker object.
virtual const EulerAngles & getEulerAngles(unsigned int) const =0

Member Data Documentation

const EulerAngleProvider& OutputEulerAngles::_euler
protected

Object providing the Euler angles.

Definition at line 35 of file OutputEulerAngles.h.

Referenced by precalculateValue().

const GrainTracker& OutputEulerAngles::_grain_tracker
protected

Grain tracker object.

Definition at line 38 of file OutputEulerAngles.h.

Referenced by precalculateValue().

MooseEnum OutputEulerAngles::_output_euler_angle
protected

Number of grains.

Definition at line 41 of file OutputEulerAngles.h.

Referenced by precalculateValue().

Real OutputEulerAngles::_value
protected

precalculated element value

Definition at line 44 of file OutputEulerAngles.h.

Referenced by computeValue(), and precalculateValue().


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