Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

EulerAngle2RGBAction

under construction:Undocumented Action Class

The EulerAngle2RGBAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# EulerAngle2RGBAction

!syntax description /Modules/PhaseField/EulerAngles2RGB/EulerAngle2RGBAction

## Overview

!! Replace these lines with information regarding the EulerAngle2RGBAction action.

## Example Input File Syntax

!! Describe and include an example of how to use the EulerAngle2RGBAction action.

!syntax parameters /Modules/PhaseField/EulerAngles2RGB/EulerAngle2RGBAction

Set up auxvariables and auxkernels to output Euler angles as RGB values interpolated across inverse pole figure

Input Parameters

  • crystal_structureCrystal structure of the material

    C++ Type:MooseEnum

    Options:triclinic monoclinic orthorhombic trigonal tetragonal cubic hexagonal

    Description:Crystal structure of the material

  • euler_angle_providerName of Euler angle provider user object

    C++ Type:UserObjectName

    Options:

    Description:Name of Euler angle provider user object

  • grain_trackerThe GrainTracker UserObject to get values from.

    C++ Type:UserObjectName

    Options:

    Description:The GrainTracker UserObject to get values from.

Required Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector

    Options:

    Description:If specified only the blocks named will be visited and made active

  • auxvariable_name_baseRGBBase name of the auxvariables

    Default:RGB

    C++ Type:std::string

    Options:

    Description:Base name of the auxvariables

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

    Description:If specified blocks matching these identifiers will be skipped.

  • no_grain_color0 0 0RGB value of color used to represent area with no grains, defaults to black

    Default:0 0 0

    C++ Type:libMesh::Point

    Options:

    Description:RGB value of color used to represent area with no grains, defaults to black

  • phaseThe phase to use for all queries.

    C++ Type:unsigned int

    Options:

    Description:The phase to use for all queries.

  • sd001Reference sample direction

    Default:001

    C++ Type:MooseEnum

    Options:100 010 001

    Description:Reference sample direction

Optional Parameters