EulerAngleProvider2RGBAux

under construction:Undocumented Class

The EulerAngleProvider2RGBAux has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Output RGB representation of crystal orientation from user object to an AuxVariable. The entire domain must have the same crystal structure.

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

    Description:The name of the variable that this object applies to

  • euler_angle_providerName of Euler angle provider user object

    C++ Type:UserObjectName

    Options:

    Description:Name of Euler angle provider user object

  • crystal_structureCrystal structure of the material

    C++ Type:MooseEnum

    Options:triclinic monoclinic orthorhombic trigonal tetragonal cubic hexagonal

    Description:Crystal structure of the material

  • grain_trackerThe GrainTracker UserObject to get values from.

    C++ Type:UserObjectName

    Options:

    Description:The GrainTracker UserObject to get values from.

Required Parameters

  • 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

  • output_typescalarType of value that will be outputted

    Default:scalar

    C++ Type:MooseEnum

    Options:red green blue scalar

    Description:Type of value that will be outputted

  • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • sd001Reference sample direction

    Default:001

    C++ Type:MooseEnum

    Options:100 010 001

    Description:Reference sample direction

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files

References