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

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

#include <EBSDReaderPointDataAux.h>

Inheritance diagram for EBSDReaderPointDataAux:
[legend]

Public Member Functions

 EBSDReaderPointDataAux (const InputParameters &parameters)
 

Protected Member Functions

virtual Real computeValue ()
 
virtual void precalculateValue ()
 

Protected Attributes

const EBSDReader_ebsd_reader
 
MooseEnum _data_name
 MooseEnum that stores the type of data this AuxKernel extracts. More...
 
MooseSharedPointer< EBSDPointDataFunctor > _val
 Accessor functor to fetch the selected data field form the EBSD data point. 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 26 of file EBSDReaderPointDataAux.h.

Constructor & Destructor Documentation

◆ EBSDReaderPointDataAux()

EBSDReaderPointDataAux::EBSDReaderPointDataAux ( const InputParameters &  parameters)

Definition at line 26 of file EBSDReaderPointDataAux.C.

27  : AuxKernel(parameters),
28  _ebsd_reader(getUserObject<EBSDReader>("ebsd_reader")),
29  _data_name(getParam<MooseEnum>("data_name")),
31 {
32 }
const EBSDReader & _ebsd_reader
MooseSharedPointer< EBSDPointDataFunctor > getPointDataAccessFunctor(const MooseEnum &field_name) const
Factory function to return a point functor specified by name.
Definition: EBSDReader.C:388
MooseSharedPointer< EBSDPointDataFunctor > _val
Accessor functor to fetch the selected data field form the EBSD data point.
MooseEnum _data_name
MooseEnum that stores the type of data this AuxKernel extracts.

Member Function Documentation

◆ computeValue()

Real EBSDReaderPointDataAux::computeValue ( )
protectedvirtual

Definition at line 45 of file EBSDReaderPointDataAux.C.

46 {
47  return _value;
48 }
Real _value
precalculated element value

◆ getAvgDataFieldType()

MooseEnum EBSDAccessFunctors::getAvgDataFieldType ( )
staticinherited

Definition at line 18 of file EBSDAccessFunctors.C.

Referenced by validParams< EBSDReaderAvgDataAux >().

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

◆ getPointDataFieldType()

MooseEnum EBSDAccessFunctors::getPointDataFieldType ( )
staticinherited

Definition at line 12 of file EBSDAccessFunctors.C.

Referenced by validParams< EBSDReaderPointDataAux >().

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

◆ precalculateValue()

void EBSDReaderPointDataAux::precalculateValue ( )
protectedvirtual

Definition at line 35 of file EBSDReaderPointDataAux.C.

36 {
37  // EBSD data is defined at element centroids, so this only makes
38  // sense as an Element AuxKernel
39  Point p = _current_elem->centroid();
40 
41  _value = (*_val)(_ebsd_reader.getData(p));
42 }
const EBSDReader & _ebsd_reader
Real _value
precalculated element value
const EBSDPointData & getData(const Point &p) const
Get the requested type of data at the point p.
Definition: EBSDReader.C:228

Member Data Documentation

◆ _data_name

MooseEnum EBSDReaderPointDataAux::_data_name
protected

MooseEnum that stores the type of data this AuxKernel extracts.

Definition at line 38 of file EBSDReaderPointDataAux.h.

◆ _ebsd_reader

const EBSDReader& EBSDReaderPointDataAux::_ebsd_reader
protected

Definition at line 35 of file EBSDReaderPointDataAux.h.

Referenced by precalculateValue().

◆ _val

MooseSharedPointer<EBSDPointDataFunctor> EBSDReaderPointDataAux::_val
protected

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

Definition at line 41 of file EBSDReaderPointDataAux.h.

◆ _value

Real EBSDReaderPointDataAux::_value
protected

precalculated element value

Definition at line 44 of file EBSDReaderPointDataAux.h.

Referenced by computeValue(), and precalculateValue().


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