- boltzmann_input_fileThe name of the input file to Bolsig+.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The name of the input file to Bolsig+.
- cross_section_dataThe name of the cross section file that Bolsig+ will use.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The name of the cross section file that Bolsig+ will use.
- number_reactionsThe number of reactions being computed by Bolsig+.
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:The number of reactions being computed by Bolsig+.
- reaction_numberAn array containing the number of the reaction in the list. (e.g. 1, 3, 4)
C++ Type:std::vector<int>
Unit:(no unit assumed)
Controllable:No
Description:An array containing the number of the reaction in the list. (e.g. 1, 3, 4)
- reaction_speciesThe name of the species.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The name of the species.
- reaction_typeThe type of reaction for the corresponding reaction_species.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:The type of reaction for the corresponding reaction_species.
BoltzmannSolverScalar
buildconstruction:Undocumented Class
The BoltzmannSolverScalar 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 a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
Overview
Example Input File Syntax
Input Parameters
- conversion_factor1Units of rate coefficients output by Bolsig+ default to m^3/s. This will be used to convert those values to your desired units.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of rate coefficients output by Bolsig+ default to m^3/s. This will be used to convert those values to your desired units.
- cutoff_time-1If the simulation time is over this value, BOLSIG+ will not run.
Default:-1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:If the simulation time is over this value, BOLSIG+ will not run.
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- ionization_fractionThe AuxVariable representing the ionization fraction of the plasma. (Currently: n_e / n_tot)
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The AuxVariable representing the ionization fraction of the plasma. (Currently: n_e / n_tot)
- mole_fractionsThe AuxVariables representing the mole fractions of the species being considered in Bolsig+.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The AuxVariables representing the mole fractions of the species being considered in Bolsig+.
- n_steps1Bolsig+ will be updated and run every n_steps. Default: 1 (runs every timestep).
Default:1
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:Bolsig+ will be updated and run every n_steps. Default: 1 (runs every timestep).
- neutral_densityThe neutral density of the plasma (background + excited states).
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The neutral density of the plasma (background + excited states).
- output_tableFalseWhether or not the rate coefficients should be output as a table. If False, single values are output.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not the rate coefficients should be output as a table. If False, single values are output.
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- reduced_fieldThe Variable/AuxVariable representing the reduced field. (Optional.)
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The Variable/AuxVariable representing the reduced field. (Optional.)
- table_variableThe variable being used to tabulate rate coefficient data. Options: reduced_field or electron_temperature.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The variable being used to tabulate rate coefficient data. Options: reduced_field or electron_temperature.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- 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.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.