CreateDisplacedProblemAction

under construction:Undocumented Action Class

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


# CreateDisplacedProblemAction

!syntax description /Mesh/CreateDisplacedProblemAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Mesh/CreateDisplacedProblemAction

!syntax description /Mesh/CreateDisplacedProblemAction

Input 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

  • displacementsThe variables corresponding to the x y z displacements of the mesh. If this is provided then the displacements will be taken into account during the computation. Creation of the displaced mesh can be suppressed even if this is set by setting 'use_displaced_mesh = false'.

    C++ Type:std::vector

    Options:

    Description:The variables corresponding to the x y z displacements of the mesh. If this is provided then the displacements will be taken into account during the computation. Creation of the displaced mesh can be suppressed even if this is set by setting 'use_displaced_mesh = false'.

  • 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_meshTrueCreate the displaced mesh if the 'displacements' parameter is set. If this is 'false', a displaced mesh will not be created, regardless of whether 'displacements' is set.

    Default:True

    C++ Type:bool

    Options:

    Description:Create the displaced mesh if the 'displacements' parameter is set. If this is 'false', a displaced mesh will not be created, regardless of whether 'displacements' is set.