AddNavierStokesVariablesAction

under construction:Undocumented Action Class

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


# AddNavierStokesVariablesAction

!syntax description /Modules/NavierStokes/Variables/AddNavierStokesVariablesAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Modules/NavierStokes/Variables/AddNavierStokesVariablesAction

This class allows us to have a section of the input file like the following which automatically adds all the required nonlinear variables with the appropriate scaling.

Input Parameters

  • scalingSpecifies a scaling factor to apply to this variable

    C++ Type:std::vector

    Options:

    Description:Specifies a scaling factor to apply to this variable

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

  • blockThe list of block ids (SubdomainID) on which this action will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) on which this action will be applied

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

    Default:LAGRANGE

    C++ Type:MooseEnum

    Options:LAGRANGE

    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

    Options:

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

  • 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:FIRST

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

Optional Parameters