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:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	EulerAngle2RGBAction (const InputParameters &params)

virtual void	act ()

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

PerfGraph &	perfGraph ()

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

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 47 of file EulerAngle2RGBAction.C.

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

Member Function Documentation

◆ act()

void EulerAngle2RGBAction::act ( )

virtual

Implements Action.

Definition at line 53 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");
       var_params.applySpecificParameters(_pars, {"block"});
       // 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.");
   }
 }

◆ validParams()

InputParameters EulerAngle2RGBAction::validParams ( )

static

Definition at line 21 of file EulerAngle2RGBAction.C.

 {
   InputParameters params = Action::validParams();
   params.addParam<std::string>("auxvariable_name_base", "RGB", "Base name of the auxvariables");
   params.addClassDescription("Set up auxvariables and auxkernels to output Euler angles as RGB "
                              "values interpolated across inverse pole figure");
   params.addParam<unsigned int>("phase", "The phase to use for all queries.");
   MooseEnum sd_enum = MooseEnum("100=1 010=2 001=3", "001");
   params.addParam<MooseEnum>("sd", sd_enum, "Reference sample direction");
   MooseEnum structure_enum = MooseEnum(
       "cubic=43 hexagonal=62 tetragonal=42 trigonal=32 orthorhombic=22 monoclinic=2 triclinic=1");
   params.addRequiredParam<MooseEnum>(
       "crystal_structure", structure_enum, "Crystal structure of the material");
   params.addRequiredParam<UserObjectName>("euler_angle_provider",
                                           "Name of Euler angle provider user object");
   params.addRequiredParam<UserObjectName>("grain_tracker",
                                           "The GrainTracker UserObject to get values from.");
   params.addParam<Point>(
       "no_grain_color",
       Point(0, 0, 0),
       "RGB value of color used to represent area with no grains, defaults to black");
   params.addParam<std::vector<SubdomainName>>(
       "block", {}, "Block restriction for the variables and kernels");
   return params;
 }

Member Data Documentation

◆ _var_name_base

const std::string EulerAngle2RGBAction::_var_name_base

private

Definition at line 30 of file EulerAngle2RGBAction.h.

Referenced by act().

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

phase_field/include/actions/EulerAngle2RGBAction.h
phase_field/src/actions/EulerAngle2RGBAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes