DisplacementGradientsAction

under construction:Undocumented Action Class

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


# DisplacementGradientsAction

!syntax description /Modules/PhaseField/DisplacementGradients/DisplacementGradientsAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Modules/PhaseField/DisplacementGradients/DisplacementGradientsAction

Set up variables, kernels, and materials for a the displacement gradients and their elastic free energy derivatives for non-split Cahn-Hilliard problems.

Input Parameters

  • displacement_gradientsVector of displacement gradient variables

    C++ Type:std::vector

    Options:

    Description:Vector of displacement gradient variables

  • displacementsVector of displacement variables

    C++ Type:std::vector

    Options:

    Description:Vector of displacement 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.

  • scaling1Specifies a scaling factor to apply to the displacement gradient variables

    Default:1

    C++ Type:double

    Options:

    Description:Specifies a scaling factor to apply to the displacement gradient variables

Optional Parameters