- reaction_coefficient_formatThe format of the reaction coefficient. Options: rate or townsend.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The format of the reaction coefficient. Options: rate or townsend.
- reactionsThe list of reactions to be added
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The list of reactions to be added
- speciesList of (tracked) species included in reactions (both products and reactants)
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:List of (tracked) species included in reactions (both products and reactants)
ChemicalReactions
buildconstruction:Undocumented Action Class
The ChemicalReactions 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.
This Action automatically adds the necessary kernels and materials for a reaction network.
Overview
Example Input File Syntax
This Action automatically adds the necessary kernels and materials for a reaction network.
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified only the blocks named will be visited and made active
- electron_densityThe variable used for density of electrons.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The variable used for density of electrons.
- electron_energyElectron energy, used for energy-dependent reaction rates.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Electron energy, used for energy-dependent reaction rates.
- equation_constantsThe constants included in the reaction equation(s).
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The constants included in the reaction equation(s).
- equation_valuesThe values of the constants included in the reaction equation(s).
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The values of the constants included in the reaction equation(s).
- equation_variablesAny nonlinear variables that appear in the equations.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Any nonlinear variables that appear in the equations.
- familyLAGRANGESpecifies the family of FE shape functions to use for this variable
Default:LAGRANGE
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable
- file_location.The location of the reaction rate files. Default: the current directory.
Default:.
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:The location of the reaction rate files. Default: the current directory.
- gas_fractionThe initial fraction of each gas species.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The initial fraction of each gas species.
- gas_speciesAll of the background gas species in the system.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:All of the background gas species in the system.
- gas_temperatureFalseIf false, neutral gas temperature is not a solution variable.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If false, neutral gas temperature is not a solution variable.
- gas_temperature_variableThe gas temperature variable (if applicable).
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The gas temperature variable (if applicable).
- gas_trackingFalseIf false, neutral gas is treated as uniform background (_n_gas).
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If false, neutral gas is treated as uniform background (_n_gas).
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
- include_electronsFalseWhether or not electrons are being considered.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not electrons are being considered.
- initial_conditionSpecifies a constant initial condition for this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a constant initial condition for this variable
- orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
Default:FIRST
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
- position_units1The units of position.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The units of position.
- potentialThe electric potential, used for energy-dependent reaction rates.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The electric potential, used for energy-dependent reaction rates.
- rate_provider_varThe name of the variable used to sample from BOLOS files.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable used to sample from BOLOS files.
- reaction_coefficientThe reaction coefficients.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The reaction coefficients.
- sampling_formatreduced_fieldSample rate constants with E/N (reduced_field) or Te (electron_energy).
Default:reduced_field
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Sample rate constants with E/N (reduced_field) or Te (electron_energy).
- scalar_problemFalseThe problem is scalar if it is a pure ODE problem (Global/0D).
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:The problem is scalar if it is a pure ODE problem (Global/0D).
- scalingSpecifies a scaling factor to apply to this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable
- species_energyList of (tracked) energy values. (Optional; requires 'track_energy' to be True.)
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:List of (tracked) energy values. (Optional; requires 'track_energy' to be True.)
- track_electron_energyFalseWhether or not to track electron energy.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to track electron energy.
- track_energyFalseWhether or not to track gas energy/temperature.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to track gas energy/temperature.
- use_logFalseWhether or not to use logarithmic densities. (N = exp(n))
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to use logarithmic densities. (N = exp(n))
- use_molesFalseWhether to use molar units.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to use molar units.
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- isObjectActionTrueIndicates that this is a MooseObjectAction.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Indicates that this is a MooseObjectAction.