ElectronEnergyTermRate

Electron energy loss term for inelastic collisions using reaction rate coefficients. Threshold energy is the energy lost in Volts in a single collision (Densities must be in logarithmic form)

Overview

ElectronEnergyTermRate calculates the electron energy loss from elastic collisions using reaction rate coefficients for electrons in logarithmic form.

Electron energy loss from elastic collisions can be described as

$var element = document.getElementById("moose-equation-b920e422-8161-4d22-a183-8cc033144e5c");katex.render("S_\\text{Loss} = k \\epsilon n_{e} n_{j}", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-21a3fbd7-9e33-4e79-83ec-39d384abf98e");katex.render("S_\\text{Loss}", element, {displayMode:false,throwOnError:false});$ is the loss term of the electron mean energy density, $var element = document.getElementById("moose-equation-61ccfb06-798f-47b1-b10b-8fc34e7719e5");katex.render("k", element, {displayMode:false,throwOnError:false});$ is the reaction rate coefficient, $var element = document.getElementById("moose-equation-f5e4c66a-b752-466d-9f70-311fe80f5768");katex.render("n_{e}", element, {displayMode:false,throwOnError:false});$ is the electron density, $var element = document.getElementById("moose-equation-124dde77-7e44-4a61-bf06-798e2dfefbd6");katex.render("n_{j}", element, {displayMode:false,throwOnError:false});$ is the colliding species density, and $var element = document.getElementById("moose-equation-2094b311-b3e9-4e21-b258-e4c869c2a5b0");katex.render("\\epsilon", element, {displayMode:false,throwOnError:false});$ the electron energy lost in the collision. When converting the density to logarithmic form and applying a scaling factor of the mesh, the strong form for ElectronEnergyTermRate is defined as

$var element = document.getElementById("moose-equation-94ecab86-3ec1-4ca5-a945-54f86608eead");katex.render("S_\\text{Loss} = k \\epsilon \\exp(N_{e}) \\exp(N_{j})", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-70799e54-0882-47dc-b9af-9191fefd39e8");katex.render("N_{j}", element, {displayMode:false,throwOnError:false});$ is the molar density of the species in logarithmic form and $var element = document.getElementById("moose-equation-783c880d-9cb2-40a4-bc11-89ff6290fdb4");katex.render("l_{c}", element, {displayMode:false,throwOnError:false});$ is the scaling factor of the mesh.

note

When coupling Zapdos with CRANE, ElectronEnergyTermRate serves the same function as CRANE's ADEEDFEnergyLog.

warning:Untested Class

The ElectronEnergyTermRate does not have a formalized test, yet. For this reason, users should be aware of unforeseen bugs when using ElectronEnergyTermRate. To report a bug or discuss future contributions to Zapdos, please refer to the Zapdos GitHub Discussions page. For standards of how to contribute to Zapdos and the MOOSE framework, please refer to the MOOSE Contributing page.

Example Input File Syntax


[Kernels]
  [mean_en_ionization]
    type = ElectronEnergyTermRate
    variable = mean_en
    em = electrons
    v = Ar
    reaction = ionization
    threshold_energy = -15.7
    position_units = 1
  []
[]

Input Parameters

emThe electron density.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The electron density.
position_unitsUnits of position.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of position.
reactionThe reaction that is adding/removing energy.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The reaction that is adding/removing energy.
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
elastic_collisionFalseIf the collision is elastic.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If the collision is elastic.
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.
threshold_energy0Energy required for reaction to take place.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Energy required for reaction to take place.
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.
vThe second reactant species.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The second reactant species.

Optional Parameters

absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, system
Controllable:No
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, time
Controllable:No
Description:The tag for the vectors this Kernel should fill

Tagging 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.
diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
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.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
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.

Advanced Parameters

Overview
Example Input File Syntax
Input Parameters