- position_unitsUnits of position
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Units of position
- potential_unitsUnits of potential (V or kV)
C++ Type:std::string
Controllable:No
Description:Units of potential (V or kV)
- use_molesFalseWhether to convert from units of moles to #.
Default:False
C++ Type:bool
Controllable:No
Description:Whether to convert from units of moles to #.
AddDriftDiffusionAction
buildconstruction:Undocumented Action Class
The AddDriftDiffusionAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
Add a non-linear variable to the simulation.
Overview
Example Input File Syntax
Add a non-linear variable to the simulation.
Input Parameters
- Additional_OutputsCurrent list of available ouputs options in this action: Current, ElectronTemperature, EField
C++ Type:std::vector<std::string>
Controllable:No
Description:Current list of available ouputs options in this action: Current, ElectronTemperature, EField
- First_DriftDiffusionAction_in_blockTrueIs this the first DriftDiffusionAction for this block?If not, then the field solver kernels and Position auxkernel will NOT be supplied by this action.
Default:True
C++ Type:bool
Controllable:No
Description:Is this the first DriftDiffusionAction for this block?If not, then the field solver kernels and Position auxkernel will NOT be supplied by this action.
- Is_field_uniqueFalseIs the field unique to this block?If not, then the field variable should be defined in the Variable Block.
Default:False
C++ Type:bool
Controllable:No
Description:Is the field unique to this block?If not, then the field variable should be defined in the Variable Block.
- NeutralsThe names of the neutrals that should be added
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The names of the neutrals that should be added
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
- blockThe subdomain that this action applies to.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The subdomain that this action applies to.
- charged_particleUser given variable name for energy independent charged particle
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:User given variable name for energy independent charged particle
- eff_fieldsThe effective fields that only affect their respective secondary charged particle.
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The effective fields that only affect their respective secondary charged particle.
- eff_fields_property_namesName of the solver interface material property for the effective fields.
C++ Type:std::vector<std::string>
Controllable:No
Description:Name of the solver interface material property for the effective fields.
- electronsUser given variable name for energy dependent electrons
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:User given variable name for energy dependent electrons
- familyLAGRANGESpecifies the family of FE shape functions to use for this variable
Default:LAGRANGE
C++ Type:MooseEnum
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable
- fieldThe gives the field a variable name
C++ Type:std::string
Controllable:No
Description:The gives the field a variable name
- 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.
- field_solverelectrostaticElectrostatic or electromagnetic field solver (default = electrostatic).
Default:electrostatic
C++ Type:MooseEnum
Controllable:No
Description:Electrostatic or electromagnetic field solver (default = electrostatic).
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
- initial_conditionSpecifies a constant initial condition for this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a constant initial condition for this variable
- initial_from_file_varGives the name of a variable for which to read an initial condition from a mesh file
C++ Type:std::string
Controllable:No
Description:Gives the name of a variable for which to read an initial condition from a mesh file
- mean_energyThe gives the mean energy a variable name
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The gives the mean energy a variable name
- offset20The offset parameter that goes into the exponential function
Default:20
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The offset parameter that goes into the exponential function
- orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
Default:FIRST
C++ Type:MooseEnum
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
- scalingSpecifies a scaling factor to apply to this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable
- secondary_charged_particlesThese are charged particles whose advection term in determined by an effective field.
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:These are charged particles whose advection term in determined by an effective field.
- using_offsetFalseIs the LogStabilizationMoles Kernel being used
Default:False
C++ Type:bool
Controllable:No
Description:Is the LogStabilizationMoles Kernel being used
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.