DriftDiffusion

Generic drift-diffusion equation that contains both an electric field driven advection term and a diffusion term (Densities must be in logarithmic form)

Overview

DriftDiffusion is a flux term containing an electric field driven advection and diffusion term used for variables in logarithmic form.

The strong form for an electric field driven advection and diffusion flux is usually defined as

$var element = document.getElementById("moose-equation-68fdcda3-7ef6-4189-9686-36bca730f3ac");katex.render("\\nabla \\cdot \\Gamma = \\nabla \\cdot \\left[ \\text{sign}_{j} \\mu_{j} n_{j} \\ \\vec{E} - D_{j} \\nabla (n_{j}) \\right] \\\\[10pt]", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-193e1a5a-c960-48b4-9c30-4c071c31c6a1");katex.render("\\Gamma", element, {displayMode:false,throwOnError:false});$ is the species' flux, $var element = document.getElementById("moose-equation-a70cb269-3ed0-4b57-82ea-6d6f01d6d7f3");katex.render("\\text{sign}_{j}", element, {displayMode:false,throwOnError:false});$ indicates the advection behavior ( $var element = document.getElementById("moose-equation-f4ee4c41-28d3-4d03-b527-1806c38abb55");katex.render("\\text{+}1", element, {displayMode:false,throwOnError:false});$ for positively charged species and $var element = document.getElementById("moose-equation-1db2f3bc-b20d-474b-b9aa-b7ed4aadb621");katex.render("\\text{-}1", element, {displayMode:false,throwOnError:false});$ for negatively charged species), $var element = document.getElementById("moose-equation-f050242a-b22f-4ce2-9dfb-75527730c072");katex.render("\\mu_{j}", element, {displayMode:false,throwOnError:false});$ is the mobility coefficient, $var element = document.getElementById("moose-equation-e51877da-1790-47ae-b4c1-ea348aa1ffc2");katex.render("n_{j}", element, {displayMode:false,throwOnError:false});$ is the density, $var element = document.getElementById("moose-equation-15f724e8-3365-4ea6-8805-48f3f56b4b26");katex.render("D_{j}", element, {displayMode:false,throwOnError:false});$ is the diffusion coefficient, and $var element = document.getElementById("moose-equation-ddec8266-795e-47e1-869d-26bd60da7970");katex.render("\\vec{E}", element, {displayMode:false,throwOnError:false});$ is the electric field. When converting the density to logarithmic form and applying a scaling factor of the mesh, the strong form for DriftDiffusion is defined as

$var element = document.getElementById("moose-equation-9e8167eb-3ac9-47cd-8d69-fbcfd9260066");katex.render("\\nabla \\cdot \\Gamma = \\nabla \\cdot \\left[ \\text{sign}_{j} \\mu_{j} \\exp(N_{j}) \\ (\\vec{E} / l_{c}) - D_{j} \\exp(N_{j}) \\nabla (N_{j} / l_{c}) \\right]", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-5f04d7ee-7502-4215-87ca-fbc923563fd9");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-77bcd5da-b59a-403f-aaf9-9011d0451484");katex.render("l_{c}", element, {displayMode:false,throwOnError:false});$ is the scaling factor of the mesh.

warning:Untested Class

The DriftDiffusion does not have a formalized test, yet. For this reason, users should be aware of unforeseen bugs when using DriftDiffusion. 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]
  [Electrons_DriftDiffusion]
    type = DriftDiffusion
    variable = electrons
    potential = potential
    position_units = 1.0
  []
[]

Input Parameters

position_unitsUnits of position.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of position.
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>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
diffThe user-defined diffusivity.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The user-defined diffusivity.
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
field_property_namefield_solver_interface_propertyName of the solver interface material property.
Default:field_solver_interface_property
C++ Type:std::string
Controllable:No
Description:Name of the solver interface material property.
muThe user-defined mobility.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The user-defined mobility.
signThe user-defined sign of the charged particle.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The user-defined sign of the charged particle.
use_material_propsTrueWhether to use a material for properties.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to use a material for properties.

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>
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>
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>
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
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
Options:nontime, time
Controllable:No
Description:The tag for the vectors this Kernel should fill

Contribution To Tagged Field Data Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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
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
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
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
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

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
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.

Material Property Retrieval Parameters

Overview
Example Input File Syntax
Input Parameters