EBSDReaderAvgDataAux Class Reference

This kernel makes data from the EBSDReader GeneralUserObject available as AuxVariables. More...

#include <EBSDReaderAvgDataAux.h>

Inheritance diagram for EBSDReaderAvgDataAux:

Public Member Functions
	EBSDReaderAvgDataAux (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()
virtual void	precalculateValue ()

Protected Attributes
const unsigned int	_phase
	Optional phase number needed for global grain index retrieval. More...
const EBSDReader &	_ebsd_reader
	EBSD reader user object. More...
const GrainTrackerInterface &	_grain_tracker
	Grain tracker user object. More...
MooseEnum	_data_name
	MooseEnum that stores the type of data this AuxKernel extracts. More...
MooseSharedPointer< EBSDAvgDataFunctor >	_val
	Accessor functor to fetch the selected data field form the EBSD data point. More...
const Real	_invalid
	Value to return for points without active grains. More...
Real	_value
	precalculated element value More...

Static Private Member Functions
static MooseEnum	getPointDataFieldType ()
static MooseEnum	getAvgDataFieldType ()

Detailed Description

This kernel makes data from the EBSDReader GeneralUserObject available as AuxVariables.

Definition at line 27 of file EBSDReaderAvgDataAux.h.

Constructor & Destructor Documentation

EBSDReaderAvgDataAux()

EBSDReaderAvgDataAux::EBSDReaderAvgDataAux

(

const InputParameters &

parameters

)

Definition at line 33 of file EBSDReaderAvgDataAux.C.

  : AuxKernel(parameters),
    _phase(isParamValid("phase") ? getParam<unsigned int>("phase") : libMesh::invalid_uint),
    _ebsd_reader(getUserObject<EBSDReader>("ebsd_reader")),
    _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker")),
    _data_name(getParam<MooseEnum>("data_name")),
    _val(_ebsd_reader.getAvgDataAccessFunctor(_data_name)),
    _invalid(getParam<Real>("invalid"))
{
}

Member Function Documentation

computeValue()

Real EBSDReaderAvgDataAux::computeValue ( )

protectedvirtual

Definition at line 64 of file EBSDReaderAvgDataAux.C.

{
  return _value;
}

getAvgDataFieldType()

MooseEnum EBSDAccessFunctors::getAvgDataFieldType ( )

staticinherited

Definition at line 19 of file EBSDAccessFunctors.C.

{
  return MooseEnum("phi1 phi phi2 phase symmetry local_id feature_id", "", true);
}

Referenced by validParams< EBSDReaderAvgDataAux >().

getPointDataFieldType()

MooseEnum EBSDAccessFunctors::getPointDataFieldType ( )

staticinherited

Definition at line 13 of file EBSDAccessFunctors.C.

{
  return MooseEnum("phi1 phi phi2 feature_id phase symmetry", "", true);
}

Referenced by validParams< EBSDReaderPointDataAux >().

precalculateValue()

void EBSDReaderAvgDataAux::precalculateValue ( )

protectedvirtual

Definition at line 45 of file EBSDReaderAvgDataAux.C.

{
  // get the dominant grain for the current element/node
  const int grain_id =
      _grain_tracker.getEntityValue(isNodal() ? _current_node->id() : _current_elem->id(),
                                    FeatureFloodCount::FieldType::UNIQUE_REGION,
                                    0);
 
  // no grain found
  if (grain_id < 0)
    _value = _invalid;
 
  // get the data for the grain
  else
    _value = _phase != libMesh::invalid_uint ? (*_val)(_ebsd_reader.getAvgData(_phase, grain_id))
                                             : (*_val)(_ebsd_reader.getAvgData(grain_id));
}

Member Data Documentation

_data_name

MooseEnum EBSDReaderAvgDataAux::_data_name

protected

MooseEnum that stores the type of data this AuxKernel extracts.

Definition at line 46 of file EBSDReaderAvgDataAux.h.

_ebsd_reader

const EBSDReader& EBSDReaderAvgDataAux::_ebsd_reader

protected

EBSD reader user object.

Definition at line 40 of file EBSDReaderAvgDataAux.h.

Referenced by precalculateValue().

_grain_tracker

const GrainTrackerInterface& EBSDReaderAvgDataAux::_grain_tracker

protected

Grain tracker user object.

Definition at line 43 of file EBSDReaderAvgDataAux.h.

Referenced by precalculateValue().

_invalid

const Real EBSDReaderAvgDataAux::_invalid

protected

Value to return for points without active grains.

Definition at line 52 of file EBSDReaderAvgDataAux.h.

Referenced by precalculateValue().

_phase

const unsigned int EBSDReaderAvgDataAux::_phase

protected

Optional phase number needed for global grain index retrieval.

Definition at line 37 of file EBSDReaderAvgDataAux.h.

Referenced by precalculateValue().

_val

MooseSharedPointer<EBSDAvgDataFunctor> EBSDReaderAvgDataAux::_val

protected

Accessor functor to fetch the selected data field form the EBSD data point.

Definition at line 49 of file EBSDReaderAvgDataAux.h.

Referenced by precalculateValue().

_value

Real EBSDReaderAvgDataAux::_value

protected

precalculated element value

Definition at line 55 of file EBSDReaderAvgDataAux.h.

Referenced by computeValue(), and precalculateValue().

---

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

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