- potentialThe potential responsible for charge advection
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The potential responsible for charge advection
- uThe drift-diffusing species.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The drift-diffusing species.
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
DriftDiffusionFluxAux
Returns the drift-diffusion flux of the specified species
Overview
DriftDiffusionFluxAux returns the simplified drift-diffusion flux of a species. DriftDiffusionFluxAux assumes a mobility and diffusion coefficient of unity, the electrostatic approximation for the electric field, and a non-scaled version of the specie's density.
The electrostatic flux is defined as
Where is the flux assuming drift-diffusion formulation, indicates the advection behavior ( for positively charged species and for negatively charged species), is the potential, and is the density.
commentnote
When calculating the drift-diffusion flux for scaled densities and non-unity coefficients, please refer to TotalFlux.
warningwarning:Undocumented Test
The DriftDiffusionFluxAux does not have a formalized test, yet. For this reason, users should be aware of unforeseen bugs when using DriftDiffusionFluxAux. To report bugs 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
[AuxKernels]
[Electron_Flux]
type = DriftDiffusionFluxAux
variable = electron_flux
u = electrons
potential = potential
positive_charge = false
component = 0
[]
[]
Input 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
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- component0The flux component you want to see.
Default:0
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:The flux component you want to see.
- execute_onLINEAR TIMESTEP_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:LINEAR 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.
- positive_chargeTrueWhether the potential is advecting positive charges. Should be set to false if charges are negative.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the potential is advecting positive charges. Should be set to false if charges are negative.
- 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.
- 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
- 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.
- 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.