- data_providerThe name of the UserObject that supplies the rate constant for this timestep.
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The name of the UserObject that supplies the rate constant for this timestep.
- data_typeChoose the electron diffusivity or mobility to fetch from Bolsig+ results. Options: diffusivity or mobility.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Choose the electron diffusivity or mobility to fetch from Bolsig+ results. Options: diffusivity or mobility.
- variableThe name of the variable that this kernel operates on
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this kernel operates on
BolsigValueScalar
buildconstruction:Undocumented Class
The BolsigValueScalar 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
- execute_onLINEARThe 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:LINEAR
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.
- sample_valueFalseWhether or not to sample outputs. (If output_table = false in BoltzmannSolverScalar, this should be false.)
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to sample outputs. (If output_table = false in BoltzmannSolverScalar, this should be false.)
- sample_variableThe variable being used to sample rate coefficient values. Traditionally either reduced electric field or electron temperature.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The variable being used to sample rate coefficient values. Traditionally either reduced electric field or electron temperature.
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.
- 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.
- 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.