CircuitDirichletPotential

Dirichlet circuit boundary condition for potential (The current is given through a UserObject)

Overview

CircuitDirichletPotential is a Dirichlet boundary condition for a potential based on Kirchoff's voltage law.

The formulation of the potential at the wall is:

$var element = document.getElementById("moose-equation-1bd86a96-4a0b-4400-be50-74ae845e7c45");katex.render("V_\\text{source} + V_\\text{cathode} = e \\Gamma A R", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-e7b03cc0-e908-433e-91a9-f47cd7fa5610");katex.render("V_\\text{source}", element, {displayMode:false,throwOnError:false});$ is driven the potential, $var element = document.getElementById("moose-equation-9c315999-6334-47be-a42a-4f251bcacf4f");katex.render("V_\\text{cathode}", element, {displayMode:false,throwOnError:false});$ is the potential at cathode, $var element = document.getElementById("moose-equation-6a21cf1d-ef01-4e2f-b756-579bcc242cb1");katex.render("\\Gamma", element, {displayMode:false,throwOnError:false});$ is the charged particle flux at the boundary, $var element = document.getElementById("moose-equation-47a5273e-fba6-49fb-bb37-8cb297cc8479");katex.render("e", element, {displayMode:false,throwOnError:false});$ is the elemental charge, $var element = document.getElementById("moose-equation-d733a436-550b-461c-8130-95a0ccec246d");katex.render("A", element, {displayMode:false,throwOnError:false});$ is the cross-sectional area of the plasma, and $var element = document.getElementById("moose-equation-79c2df50-e046-4220-b971-189728999f79");katex.render("R", element, {displayMode:false,throwOnError:false});$ is the ballast resistance. When converting the density to log-molar form and applying a scaling factor for both the mesh and voltage, CircuitDirichletPotential is defined as

$var element = document.getElementById("moose-equation-e77f0760-26c7-4b59-8c91-a3019f403ae4");katex.render("V_\\text{source} + V_\\text{cathode} = e N_{A} \\Gamma \\frac{A}{l_{c}^2} \\frac{R}{V_{c}}", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-2a670349-2c20-40af-81fa-7d551510875c");katex.render("N_{A}", element, {displayMode:false,throwOnError:false});$ is Avogadro's number, $var element = document.getElementById("moose-equation-b8b56726-235f-4893-a1f9-1423aad1cb71");katex.render("l_{c}", element, {displayMode:false,throwOnError:false});$ is the scaling factor of the mesh, and $var element = document.getElementById("moose-equation-f00d7d8e-32a2-40f5-9339-fcfeb58f50a6");katex.render("V_{c}", element, {displayMode:false,throwOnError:false});$ is the scaling factor of the potential.

The charged particle flux is supplied as a Postprocessor (usually the SideCurrent Postprocessor).

warning:Untested Class

The CircuitDirichletPotential does not have a formalized test, yet. For this reason, users should be aware of unforeseen bugs when using CircuitDirichletPotential. 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


[BCs]
  [circuit_potential]
    type = CircuitDirichletPotential
    variable = potential
    current = SideCurrent
    position_units = 1.0
    potential_units = V
    resist = 100 #in Ohms
    surface = anode
    surface_potential = 100 #in V
    boundary = 'electrode'
  []
[]

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
currentThe postprocessor response for calculating the current passing through the needle surface.
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The postprocessor response for calculating the current passing through the needle surface.
position_unitsUnits of position
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of position
potential_unitsThe potential units.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The potential units.
resistThe ballast resistance in Ohms
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The ballast resistance in Ohms
surfaceWhether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Whether you are specifying the potential on the anode or the cathode with the requirement that the other metal surface be grounded.
surface_potentialThe electrical potential applied to the surface if no current was flowing in the circuit.
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The electrical potential applied to the surface if no current was flowing in the circuit.
use_molesFalseWhether to convert from units of moles to #.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to convert from units of moles to #.
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

A1For 1D calculations, an area has to be passed. This area also must match the units convention of position_units.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:For 1D calculations, an area has to be passed. This area also must match the units convention of position_units.
diag_save_inThe name of auxiliary variables to save this BC'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 BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
save_inThe name of auxiliary variables to save this BC'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 BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

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_tagssystem timeThe tag for the matrices this Kernel should fill
Default:system time
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, system, time
Controllable:No
Description:The tag for the matrices this Kernel should fill
vector_tagsresidualThe tag for the vectors this Kernel should fill
Default:residual
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Options:nontime, time, residual
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.
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
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