EBSDReaderAvgDataAux

under construction:Undocumented Class

The EBSDReaderAvgDataAux 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.

!syntax description /AuxKernels/EBSDReaderAvgDataAux

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

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

  • ebsd_readerThe EBSDReader GeneralUserObject

    C++ Type:UserObjectName

    Description:The EBSDReader GeneralUserObject

  • data_nameThe averaged data to be extracted from the EBSD data by this AuxKernel

    C++ Type:MooseEnum

    Description:The averaged data to be extracted from the EBSD data by this AuxKernel

  • grain_trackerThe GrainTracker UserObject

    C++ Type:UserObjectName

    Description:The GrainTracker UserObject

Required Parameters

  • execute_onLINEARThe 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

    C++ Type:ExecFlagEnum

    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

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

  • invalid-1Value to return for points without active grains.

    Default:-1

    C++ Type:double

    Description:Value to return for points without active grains.

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

    C++ Type:std::vector

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

Optional Parameters

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

    C++ Type:std::vector

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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

References