SideTotFluxIntegral

Returns the flux of a defined species at a boundary

Overview

SideTotFluxIntegral computes the surface integrated flux of a species on a boundary.

The surface flux is defined as:

$var element = document.getElementById("moose-equation-f9cec8e7-a7ad-4437-87b8-c2882bac2ddd");katex.render("a = \\begin{cases} 1, & \\text{sign}_{j} \\vec{E} \\cdot \\textbf{n} > 0\\\\ 0, & \\text{sign}_{j} \\vec{E} \\cdot \\textbf{n} \\leq 0\\\\ \\end{cases} \\\\[10pt] v_{\\text{th},j} = \\sqrt{\\frac{8k_{B}T_{j}}{\\pi m_{j}}} \\\\[10pt] \\Gamma_{j} \\cdot \\textbf{n} = \\frac{1-r}{1+r} \\left[ (2 a-1) \\ \\text{sign}_{j} \\mu_{j} \\vec{E} \\cdot \\textbf{n} \\ n_{j} + \\frac{1}{2}v_{\\text{th},j} n_{j} \\right] \\\\[10pt]", element, {displayMode:true,throwOnError:false});$

Where:

the subscript $var element = document.getElementById("moose-equation-57c430d6-3971-4170-902e-5a31c56f44f3");katex.render("j", element, {displayMode:false,throwOnError:false});$ represents the properties of the chosen species,
$var element = document.getElementById("moose-equation-5e9ab1a2-ec2a-4a4e-a714-27416cfbeb17");katex.render("\\Gamma", element, {displayMode:false,throwOnError:false});$ is the species flux,
$var element = document.getElementById("moose-equation-d0cf56c1-fd2e-4abf-8559-cc6372c14109");katex.render("\\textbf{n}", element, {displayMode:false,throwOnError:false});$ is the normal vector of the boundary,
$var element = document.getElementById("moose-equation-fe153c47-b63d-4e46-b05a-b8df58f8ff74");katex.render("\\mu", element, {displayMode:false,throwOnError:false});$ is the mobility coefficient,
$var element = document.getElementById("moose-equation-3c2a464d-8f55-43c1-acce-060ae642ce95");katex.render("n", element, {displayMode:false,throwOnError:false});$ is the species density,
$var element = document.getElementById("moose-equation-312ab22d-62ec-4db5-a4b8-56c79b828e36");katex.render("\\vec{E}", element, {displayMode:false,throwOnError:false});$ is the electric field,
$var element = document.getElementById("moose-equation-d13ccba4-3f28-403d-bb08-b2ca4d712c0d");katex.render("v_\\text{th}", element, {displayMode:false,throwOnError:false});$ is the thermal velocity of the species,
$var element = document.getElementById("moose-equation-d651595e-6c85-4a9a-a759-b1ac47a00cb4");katex.render("k_{B}", element, {displayMode:false,throwOnError:false});$ is the Boltzmann constant,
$var element = document.getElementById("moose-equation-45767d61-8cb6-4bf2-9f79-611d2413a6a9");katex.render("m", element, {displayMode:false,throwOnError:false});$ is the species mass,
$var element = document.getElementById("moose-equation-8a96beb9-4b7c-4fb0-b3de-e67ba6bb8b01");katex.render("T", element, {displayMode:false,throwOnError:false});$ is the species temperature,
$var element = document.getElementById("moose-equation-9d740dbb-c8a1-4fb8-bada-1b2c331f23e1");katex.render("a", element, {displayMode:false,throwOnError:false});$ is defined such that the outflow is non-zero when the drift velocity is directed towards the wall and zero otherwise, and
$var element = document.getElementById("moose-equation-a9164b0a-eaec-4376-880f-e7a701e22d30");katex.render("r", element, {displayMode:false,throwOnError:false});$ is defined as the fraction of particles reflected by the surface.

When converting the density to molar logarithmic form and applying a scaling factor of the mesh, the following changes are applied to SideTotFluxIntegral:

$var element = document.getElementById("moose-equation-63623a55-856a-4d22-beaf-71cb5300ed3d");katex.render("\\Gamma_{j} \\cdot \\textbf{n} = \\frac{1-r}{1+r} \\left[ (2 a-1) \\ \\text{sign}_{j} \\mu_{j} \\vec{E} \\cdot \\textbf{n} \\ \\exp \\left(N_{j}\\right) + \\frac{1}{2}v_{\\text{th},j} \\exp \\left(N_{j}\\right) \\right]", element, {displayMode:true,throwOnError:false});$

Where:

$var element = document.getElementById("moose-equation-9656833b-c5e7-4368-a80a-92cb20e8190c");katex.render("N", element, {displayMode:false,throwOnError:false});$ is the molar density of the species in logarithmic form, and
$var element = document.getElementById("moose-equation-d432ccfe-b316-4ad4-984b-1a5977fb86c4");katex.render("l_{c}", element, {displayMode:false,throwOnError:false});$ is the scaling factor of the mesh.

warning:Untested Class

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

Example Input File Syntax


[Postprocessors]
  [electrode_ion_current]
    type = SideTotFluxIntegral
    variable = ions
    mobility = muions
    r = 0.0
    position_units = 1.0
    field_property_name = electric_field
    boundary = electrode
  []
[]

Input Parameters

boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
mobilityThe name of the mobility material property that will be used in the flux computation.
C++ Type:std::string
Controllable:No
Description:The name of the mobility material property that will be used in the flux computation.
position_unitsUnits of position.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of position.
rThe reflection coefficient
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The reflection coefficient
variableThe name of the variable which this postprocessor integrates
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable which this postprocessor integrates

Required Parameters

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.
user_velocity-1Optional parameter if user wants to specify the thermal velocity
Default:-1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Optional parameter if user wants to specify the thermal velocity

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
execute_onTIMESTEP_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:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, TRANSFER
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.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
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