AddCoupledSolidKinSpeciesAction

under construction:Undocumented Action Class

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


# AddCoupledSolidKinSpeciesAction

!syntax description /ReactionNetwork/SolidKineticReactions/AddCoupledSolidKinSpeciesAction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ReactionNetwork/SolidKineticReactions/AddCoupledSolidKinSpeciesAction

Adds solid kinetic Kernels and AuxKernels for primary species

Input Parameters

  • activation_energyThe list of activation energy values for all reactions (J/mol)

    C++ Type:std::vector

    Options:

    Description:The list of activation energy values for all reactions (J/mol)

  • kin_reactionsThe list of solid kinetic reactions

    C++ Type:std::string

    Options:

    Description:The list of solid kinetic reactions

  • kinetic_rate_constantThe list of kinetic rate constant for all reactions (mol/m^2/s)

    C++ Type:std::vector

    Options:

    Description:The list of kinetic rate constant for all reactions (mol/m^2/s)

  • log10_keqThe list of equilibrium constants for all reactions

    C++ Type:std::vector

    Options:

    Description:The list of equilibrium constants for all reactions

  • primary_speciesThe list of primary species to add

    C++ Type:std::vector

    Options:

    Description:The list of primary species to add

  • reference_temperatureThe list of reference temperatures for all reactions (K)

    C++ Type:std::vector

    Options:

    Description:The list of reference temperatures for all reactions (K)

  • specific_reactive_surface_areaThe list of specific reactive surface area for all minerals (m^2/L)

    C++ Type:std::vector

    Options:

    Description:The list of specific reactive surface area for all minerals (m^2/L)

  • system_temperatureThe system temperature for all reactions (K)

    C++ Type:std::vector

    Options:

    Description:The system temperature for all reactions (K)

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

  • gas_constant8.314Gas constant. Default is 8.314 (J/mol/K)

    Default:8.314

    C++ Type:double

    Options:

    Description:Gas constant. Default is 8.314 (J/mol/K)

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector

    Options:

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

  • secondary_speciesThe list of solid kinetic species to be output as aux variables

    C++ Type:std::vector

    Options:

    Description:The list of solid kinetic species to be output as aux variables

Optional Parameters