Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

AddPrimarySpeciesAction

under construction:Undocumented Action Class

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


# AddPrimarySpeciesAction

!syntax description /ReactionNetwork/AqueousEquilibriumReactions/AddPrimarySpeciesAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ReactionNetwork/AqueousEquilibriumReactions/AddPrimarySpeciesAction

Adds Variables for all primary species

Input Parameters

  • primary_speciesThe list of primary variables to add

    C++ Type:std::vector

    Options:

    Description:The list of primary variables to add

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

  • 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

    Options:

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

  • 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

    Options:

    Description:Specifies a scaling factor to apply to this variable

Optional Parameters