MatVecRealGradAuxKernelAction

buildconstruction:Undocumented Action Class

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

Outputs all components of the gradient of the real standard vector-valued properties specified

Overview

Example Input File Syntax

Outputs all components of the gradient of the real standard vector-valued properties specified

Input Parameters

  • dimthe dimensions of the mesh

    C++ Type:unsigned int

    Controllable:No

    Description:the dimensions of the mesh

  • op_numValue that specifies the number of grains to create

    C++ Type:unsigned int

    Controllable:No

    Description:Value that specifies the number of grains to create

  • propertythe scalar material property names

    C++ Type:std::vector<MaterialPropertyName>

    Unit:(no unit assumed)

    Controllable:No

    Description:the scalar material property names

  • var_name_baseVector specifies the base name of the variables

    C++ Type:std::vector<std::string>

    Controllable:No

    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<std::string>

    Controllable:No

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

  • divergence_propertyScalar material property name for divergence variable

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:Scalar material property name for divergence variable

  • divergence_variableName of divergence variable to generate kernels for

    C++ Type:AuxVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of divergence variable to generate kernels for

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector<std::string>

    Controllable:No

    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

    Controllable:No

    Description:Whether to use displaced mesh in the kernels

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Controllable:No

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

Advanced Parameters