MaterialVectorGradAuxKernelAction

under construction:Undocumented Action Class

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


# MaterialVectorGradAuxKernelAction

!syntax description /AuxKernels/MaterialVectorGradAuxKernel/MaterialVectorGradAuxKernelAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /AuxKernels/MaterialVectorGradAuxKernel/MaterialVectorGradAuxKernelAction

!syntax description /AuxKernels/MaterialVectorGradAuxKernel/MaterialVectorGradAuxKernelAction

Input Parameters

  • grain_numValue that specifies the number of grains to create aux kernels for.

    C++ Type:unsigned int

    Options:

    Description:Value that specifies the number of grains to create aux kernels for.

  • propertyThe material property names.

    C++ Type:std::vector

    Options:

    Description:The material property names.

  • variable_baseVector specifies the base name of the variables.

    C++ Type:std::vector

    Options:

    Description:Vector specifies the base name of the variables.

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

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • use_displaced_meshFalseWhether to use displaced mesh in the kernels.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether to use displaced mesh in the kernels.

Optional Parameters