- 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
Controllable:No
Description:The potential units.
- speciesAll of the charged species that interact with this boundary.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:All of the charged species that interact with this boundary.
ADSurfaceCharge
Adds a surface charge material property based on the rate of change of the total charged flux to a boundary. (NOTE: this material is meant to be boundary-restricted.)
Overview
ADSurfaceCharge calculates the surface charge at a boundary. The surface charge material property is labeled surface_charge.
The surface charge is defined as
Where:
is the surface charge,
is the total current density,
the subscript represents properties of a plasma species,
is the charge of the species,
is the drift-diffusion flux,
is the outward pointing unit normal on the boundary,
indicates the advection behavior ( for positively charged species and for negatively charged species),
is the mobility coefficient,
is the diffusion coefficient,
is the electric field, and
is the species density.
Using the midpoint method for integration, the surface charge calculation becomes
Where:
is the surface charge of the current time step,
is the surface of the previous time step, and
is the difference between time steps.
When converting the density to logarithmic form and applying a scaling factor of the mesh, the drift-diffusion flux of ADSurfaceCharge is redefined as
Where:
is the molar density of the species in logarithmic form,
is Avogadro's number, and
is the scaling factor of the mesh.
Example Input File Syntax
[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
[surface_charge_material]
type = ADSurfaceCharge<<<{"description": "Adds a surface charge material property based on the rate of change of the total charged flux to a boundary. (NOTE: this material is meant to be boundary-restricted.)", "href": "ADSurfaceCharge.html"}>>>
species<<<{"description": "All of the charged species that interact with this boundary."}>>> = 'neg pos'
position_units<<<{"description": "Units of position."}>>> = ${dom0Scale}
boundary<<<{"description": "The list of boundaries (ids or names) from the mesh where this object applies"}>>> = 'plasma_right'
[]
[](test/tests/surface_charge/dbd_test.i)Input Parameters
- bc_typeHagelaarThe name of the family of BCs being used in this model. Options: Hagelaar (DEFAULT), Sakiyama, Lymberopoulos.
Default:Hagelaar
C++ Type:std::string
Controllable:No
Description:The name of the family of BCs being used in this model. Options: Hagelaar (DEFAULT), Sakiyama, Lymberopoulos.
- 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
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
- constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
- declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.
- 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.
- ksThe recombination coefficient (for Lymberopoulos-type BC)
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The recombination coefficient (for Lymberopoulos-type BC)
- r_electron0The electron reflection coefficient on this boundary.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The electron reflection coefficient on this boundary.
- r_ion0The ion reflection coefficient on this boundary.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The ion reflection coefficient on this boundary.
- secondary_electronsTrueWhether or not to include secondary electron emission in the surface charge calculation. Note that this should be consistent with the selected boundary conditions; if a secondary electron BC is used on this boundary, this should be true. DEFAULT: true.
Default:True
C++ Type:bool
Controllable:No
Description:Whether or not to include secondary electron emission in the surface charge calculation. Note that this should be consistent with the selected boundary conditions; if a secondary electron BC is used on this boundary, this should be true. DEFAULT: true.
Optional 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.
- 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
- search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
Default:nearest_node_connected_sides
C++ Type:MooseEnum
Controllable:No
Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
- 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
- output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
- outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
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
Outputs 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.