Tricrystal2CircleGrainsICAction

under construction:Undocumented Action Class

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


# Tricrystal2CircleGrainsICAction

!syntax description /ICs/PolycrystalICs/Tricrystal2CircleGrainsIC/Tricrystal2CircleGrainsICAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/PolycrystalICs/Tricrystal2CircleGrainsIC/Tricrystal2CircleGrainsICAction

!syntax description /ICs/PolycrystalICs/Tricrystal2CircleGrainsIC/Tricrystal2CircleGrainsICAction

Input Parameters

  • op_numnumber of order parameters to create

    C++ Type:unsigned int

    Options:

    Description:number of order parameters to create

  • var_name_basespecifies the base name of the variables

    C++ Type:std::string

    Options:

    Description: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.

Optional Parameters