EulerAngle2RGBAction Class Reference

Automatically generates all variables, Kernels, and Materials to ensure the correct derivatives of the elastic free energy in a non-split Cahn-Hilliard simulation are assembled. More...

#include <EulerAngle2RGBAction.h>

Inheritance diagram for EulerAngle2RGBAction:

Public Member Functions
	EulerAngle2RGBAction (const InputParameters &params)
virtual void	act ()

Private Attributes
const std::string	_var_name_base

Detailed Description

Automatically generates all variables, Kernels, and Materials to ensure the correct derivatives of the elastic free energy in a non-split Cahn-Hilliard simulation are assembled.

Definition at line 20 of file EulerAngle2RGBAction.h.

Constructor & Destructor Documentation

EulerAngle2RGBAction()

EulerAngle2RGBAction::EulerAngle2RGBAction

(

const InputParameters &

params

)

Definition at line 46 of file EulerAngle2RGBAction.C.

  : Action(params), _var_name_base(getParam<std::string>("auxvariable_name_base"))
{
}

Member Function Documentation

act()

void EulerAngle2RGBAction::act ( )

virtual

Definition at line 52 of file EulerAngle2RGBAction.C.

{
  // Auxvariable suffix names that will automatically become a vector in Paraview
  std::vector<std::string> suffixes = {"_x", "_y", "_z"};
 
  // Three color types that will be outputted
  std::vector<std::string> colors = {"red", "green", "blue"};
 
  for (unsigned int i = 0; i < 3; ++i)
  {
    // Create the auxvariable name
    std::string var_name = _var_name_base + suffixes[i];
 
    if (_current_task == "add_aux_variable")
    {
      auto var_params = _factory.getValidParams("MooseVariableConstMonomial");
      // Create scalar auxvariables for the three components of the RGB vector
      _problem->addAuxVariable("MooseVariableConstMonomial", var_name, var_params);
    }
    else if (_current_task == "add_aux_kernel")
    {
      // Create auxkernels corresponding to each auxvariable
      InputParameters params = _factory.getValidParams("EulerAngleProvider2RGBAux");
      params.set<AuxVariableName>("variable") = var_name;
      params.set<MooseEnum>("sd") = getParam<MooseEnum>("sd");
      params.set<MooseEnum>("crystal_structure") = getParam<MooseEnum>("crystal_structure");
      params.set<MooseEnum>("output_type") = colors[i];
      params.set<UserObjectName>("euler_angle_provider") =
          getParam<UserObjectName>("euler_angle_provider");
      params.set<UserObjectName>("grain_tracker") = getParam<UserObjectName>("grain_tracker");
      params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_TIMESTEP_END};
      params.set<Point>("no_grain_color") = getParam<Point>("no_grain_color");
      if (isParamValid("phase"))
        params.set<unsigned int>("phase") = getParam<unsigned int>("phase");
      _problem->addAuxKernel("EulerAngleProvider2RGBAux", var_name, params);
    }
    else
      mooseError("Internal error in EulerAngle2RGBAction.");
  }
}

Member Data Documentation

_var_name_base

const std::string EulerAngle2RGBAction::_var_name_base

private

Definition at line 28 of file EulerAngle2RGBAction.h.

Referenced by act().

---

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

• phase_field/include/action/EulerAngle2RGBAction.h
• phase_field/src/action/EulerAngle2RGBAction.C