OutputEulerAngles Class Reference

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

#include <OutputEulerAngles.h>

Inheritance diagram for OutputEulerAngles:

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 27 of file OutputEulerAngles.h.

Constructor & Destructor Documentation

OutputEulerAngles()

OutputEulerAngles::OutputEulerAngles

(

const InputParameters &

parameters

)

Definition at line 31 of file OutputEulerAngles.C.

  : AuxKernel(parameters),
    _euler(getUserObject<EulerAngleProvider>("euler_angle_provider")),
    _grain_tracker(getUserObject<GrainTracker>("grain_tracker")),
    _output_euler_angle(getParam<MooseEnum>("output_euler_angle"))
{
}

Member Function Documentation

computeValue()

Real OutputEulerAngles::computeValue ( )

protectedvirtual

Definition at line 58 of file OutputEulerAngles.C.

{
  return _value;
}

precalculateValue()

void OutputEulerAngles::precalculateValue ( )

protectedvirtual

Definition at line 40 of file OutputEulerAngles.C.

{
  // ID of unique grain at current point
  const auto grain_id =
      _grain_tracker.getEntityValue((isNodal() ? _current_node->id() : _current_elem->id()),
                                    FeatureFloodCount::FieldType::UNIQUE_REGION,
                                    0);
 
  // Recover euler angles for current grain
  RealVectorValue angles;
  if (grain_id >= 0)
    angles = _euler.getEulerAngles(grain_id);
 
  // Return specific euler angle
  _value = angles(_output_euler_angle);
}

Member Data Documentation

_euler

const EulerAngleProvider& OutputEulerAngles::_euler

protected

Object providing the Euler angles.

Definition at line 37 of file OutputEulerAngles.h.

Referenced by precalculateValue().

_grain_tracker

const GrainTracker& OutputEulerAngles::_grain_tracker

protected

Grain tracker object.

Definition at line 40 of file OutputEulerAngles.h.

Referenced by precalculateValue().

_output_euler_angle

MooseEnum OutputEulerAngles::_output_euler_angle

protected

Number of grains.

Definition at line 43 of file OutputEulerAngles.h.

Referenced by precalculateValue().

_value

Real OutputEulerAngles::_value

protected

precalculated element value

Definition at line 46 of file OutputEulerAngles.h.

Referenced by computeValue(), and precalculateValue().

---

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

• phase_field/include/auxkernels/OutputEulerAngles.h
• phase_field/src/auxkernels/OutputEulerAngles.C