EBSDAccessFunctors.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "MooseObject.h"
#include "MooseEnum.h"
#include "EulerAngles.h"

#include "libmesh/point.h"

class EBSDAccessFunctors
{
public:
  struct EBSDPointData
  {
    Real _phi1;
    Real _Phi;
    Real _phi2;

    Point _p;

    unsigned int _feature_id;
    unsigned int _phase;
    unsigned int _symmetry;

    std::vector<Real> _custom;
  };

  struct EBSDAvgData
  {
    EulerAngles * _angles;

    unsigned int _feature_id;
    unsigned int _phase;
    unsigned int _symmetry;

    unsigned int _local_id;

    unsigned int _n;

    Point _p;

    std::vector<Real> _custom;
  };

  static MooseEnum getPointDataFieldType();
  static MooseEnum getAvgDataFieldType();

  struct EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData &) = 0;
    virtual ~EBSDPointDataFunctor(){};
  };
  struct EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData &) = 0;
    virtual ~EBSDAvgDataFunctor(){};
  };

  // List of specialized access functors (one for each field in EBSDPointData)
  struct EBSDPointDataPhi1 : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._phi1; };
  };
  struct EBSDPointDataPhi : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._Phi; };
  };
  struct EBSDPointDataPhi2 : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._phi2; };
  };
  struct EBSDPointDataFeatureID : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._feature_id; };
  };
  struct EBSDPointDataPhase : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._phase; };
  };
  struct EBSDPointDataSymmetry : EBSDPointDataFunctor
  {
    virtual Real operator()(const EBSDPointData & d) { return d._symmetry; };
  };
  struct EBSDPointDataCustom : EBSDPointDataFunctor
  {
    EBSDPointDataCustom(unsigned int index) : _index(index) {}
    virtual Real operator()(const EBSDPointData & d)
    {
      mooseAssert(_index < d._custom.size(),
                  "Requesting out of bounds index in EBSDPointDataCustom.");
      return d._custom[_index];
    };
    const unsigned int _index;
  };

  // List of specialized access functors (one for each field in EBSDAvgData)
  struct EBSDAvgDataPhi1 : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._angles->phi1; };
  };
  struct EBSDAvgDataPhi : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._angles->Phi; };
  };
  struct EBSDAvgDataPhi2 : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._angles->phi2; };
  };
  struct EBSDAvgDataPhase : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._phase; };
  };
  struct EBSDAvgDataSymmetry : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._symmetry; };
  };
  struct EBSDAvgDataLocalID : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._local_id; };
  };
  struct EBSDAvgDataFeatureID : EBSDAvgDataFunctor
  {
    virtual Real operator()(const EBSDAvgData & a) { return a._feature_id; };
  };
  struct EBSDAvgDataCustom : EBSDAvgDataFunctor
  {
    EBSDAvgDataCustom(unsigned int index) : _index(index) {}
    virtual Real operator()(const EBSDAvgData & a)
    {
      mooseAssert(_index < a._custom.size(),
                  "Requesting out of bounds index in EBSDPointDataCustom.");
      return a._custom[_index];
    };
    const unsigned int _index;
  };
};