Install MOOSE link

New Users link

Examples and Tutorials link

Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access link

AddVariableAction

buildconstruction:Undocumented Action Class

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


# AddVariableAction

!syntax description /Variables/AddVariableAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Variables/AddVariableAction

Add a non-linear variable to the simulation.

Input Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

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

    Options:

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

  • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

    Default:LAGRANGE

    C++ Type:MooseEnum

    Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC

    Description:Specifies the family of FE shape functions to use for this variable

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Options:

    Description:If specified blocks matching these identifiers will be skipped.

  • initial_conditionSpecifies the initial condition for this variable

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

    Options:

    Description:Specifies the initial condition for this variable

  • isObjectActionTrueIndicates that this is a MooseObjectAction.

    Default:True

    C++ Type:bool

    Options:

    Description:Indicates that this is a MooseObjectAction.

  • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

    Default:FIRST

    C++ Type:MooseEnum

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

    Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

  • scalingSpecifies a scaling factor to apply to this variable

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

    Options:

    Description:Specifies a scaling factor to apply to this variable