MaterialVectorAuxKernelAction

buildconstruction:Undocumented Action Class

The MaterialVectorAuxKernelAction 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 standard vector-valued properties specified

Overview

Example Input File Syntax

Outputs all components of the standard vector-valued properties specified

Input Parameters

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

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

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

  • propertyThe material property names.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The material property names.

  • variable_baseVector specifies the base name of the variables.

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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

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

Advanced Parameters