AddCoupledEqSpeciesAction

under construction:Undocumented Action Class

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


# AddCoupledEqSpeciesAction

!syntax description /ReactionNetwork/AqueousEquilibriumReactions/AddCoupledEqSpeciesAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ReactionNetwork/AqueousEquilibriumReactions/AddCoupledEqSpeciesAction

Adds coupled equilibrium Kernels and AuxKernels for 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

  • gravity0 0 0Gravity vector (default is (0, 0, 0))

    Default:0 0 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:Gravity vector (default is (0, 0, 0))

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • pressurePressure variable

    C++ Type:std::vector

    Options:

    Description:Pressure variable

  • reactionsThe list of aqueous equilibrium reactions

    C++ Type:std::string

    Options:

    Description:The list of aqueous equilibrium reactions

  • secondary_speciesThe list of aqueous equilibrium species to be output as aux variables

    C++ Type:std::vector

    Options:

    Description:The list of aqueous equilibrium species to be output as aux variables

Optional Parameters