EulerAngleVariables2RGBAux

under construction:Undocumented Class

The EulerAngleVariables2RGBAux 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 a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# EulerAngleVariables2RGBAux

!syntax description /AuxKernels/EulerAngleVariables2RGBAux

## Overview

!! Replace these lines with information regarding the EulerAngleVariables2RGBAux object.

## Example Input File Syntax

!! Describe and include an example of how to use the EulerAngleVariables2RGBAux object.

!syntax parameters /AuxKernels/EulerAngleVariables2RGBAux

!syntax inputs /AuxKernels/EulerAngleVariables2RGBAux

!syntax children /AuxKernels/EulerAngleVariables2RGBAux

!syntax description /AuxKernels/EulerAngleVariables2RGBAux

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

Required Parameters

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
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
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, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
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, PRE_DISPLACE.
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
phaseGrain phase index
C++ Type:std::vector
Options:
Description:Grain phase index
phiEuler angle 2
C++ Type:std::vector
Options:
Description:Euler angle 2
phi1Euler angle 1
C++ Type:std::vector
Options:
Description:Euler angle 1
phi2Euler angle 3
C++ Type:std::vector
Options:
Description:Euler angle 3
sd001Reference sample direction
Default:001
C++ Type:MooseEnum
Options:100 010 001
Description:Reference sample direction
symmetryGrain symmetry identifier
C++ Type:std::vector
Options:
Description:Grain symmetry identifier

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

modules/phase_field/test/tests/reconstruction/EulerAngleVariables2RGBAux.i

modules/phase_field/test/tests/reconstruction/EulerAngleVariables2RGBAux.i

[Mesh]
  type = EBSDMesh
  filename = IN100_001_28x28_Clean_Marmot.txt
[]

[UserObjects]
  [./ebsd]
    type = EBSDReader
  [../]
[]

[AuxVariables]
  [./phi1]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./phi]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./phi2]
    family = MONOMIAL
    order = CONSTANT
  [../]

  [./phase]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./symmetry]
    order = CONSTANT
    family = MONOMIAL
  [../]

  [./rgb]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[AuxKernels]
  [./phi1_aux]
    type = EBSDReaderPointDataAux
    variable = phi1
    ebsd_reader = ebsd
    data_name = phi1
    execute_on = initial
  [../]
  [./phi_aux]
    type = EBSDReaderPointDataAux
    variable = phi
    ebsd_reader = ebsd
    data_name = phi
    execute_on = initial
  [../]
  [./phi2_aux]
    type = EBSDReaderPointDataAux
    variable = phi2
    ebsd_reader = ebsd
    data_name = phi2
    execute_on = initial
  [../]

  [./phase_aux]
    type = EBSDReaderPointDataAux
    variable = phase
    ebsd_reader = ebsd
    data_name = phase
    execute_on = initial
  [../]

  [./symmetry_aux]
    type = EBSDReaderPointDataAux
    variable = symmetry
    ebsd_reader = ebsd
    data_name =  symmetry
    execute_on = initial
  [../]

  [./rgb]
    type = EulerAngleVariables2RGBAux
    variable = rgb
    phi1 = phi1
    phi = phi
    phi2 = phi2
    phase = phase
    symmetry = symmetry
    execute_on = initial
  [../]
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Outputs]
  exodus = true
  show = 'rgb'
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools