PenaltyCircuitPotential

Circuit boundary condition for potential multiplied by a penalty term

Overview

PenaltyCircuitPotential is a PenaltyDirichlBC for a potential based on Kirchoff's voltage law.

The formulation of the potential at the wall is:

Where is driven the potential, is the potential at cathode, is the current density, is the cross-sectional area of the plasma, and is the ballast resistance. The current density is supplied through the CurrentDensityShapeSideUserObject.

Example Input File Syntax

[BCs]
  [potential_left]
    boundary = left
    type = PenaltyCircuitPotential
    variable = potential
    current = current_density_user_object
    surface_potential = -${vhigh}
    surface = 'cathode'
    penalty = 1000
    data_provider = data_provider
    electrons = em
    ions = Arp
    electron_energy = mean_en
    area = ${area}
    potential_units = 'kV'
    position_units = ${dom0Scale}
    resistance = ${resistance}
  []
[]
(test/tests/1d_dc/NonlocalPotentialBCWithSchottky.i)

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

  • currentThe postprocessor response for calculating the current passing through the needle surface.

    C++ Type:UserObjectName

    Controllable:No

    Description:The postprocessor response for calculating the current passing through the needle surface.

  • data_providerThe name of the UserObject that can provide some data to materials, bcs, etc.

    C++ Type:UserObjectName

    Controllable:No

    Description:The name of the UserObject that can provide some data to materials, bcs, etc.

  • electron_energyThe mean electron energy density in log form.

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The mean electron energy density in log form.

  • electronsThe electron density in log form.

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The electron density in log form.

  • ionsThe ion density in log form.

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The ion density in log form.

  • penaltyThe constant multiplying the penalty term.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The constant multiplying the penalty term.

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

  • resistanceThe 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

    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:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The electrical potential applied to the surface if no current was flowing in the circuit.

  • 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

  • areaMust be provided when the number of dimensions equals 1.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Must be provided when the number of dimensions equals 1.

  • displacementsThe displacements

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The displacements

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

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

  • 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

  • skip_execution_outside_variable_domainFalseWhether to skip execution of this boundary condition when the variable it applies to is not defined on the boundary. This can facilitate setups with moving variable domains and fixed boundaries. Note that the FEProblem boundary-restricted integrity checks will also need to be turned off if using this option

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to skip execution of this boundary condition when the variable it applies to is not defined on the boundary. This can facilitate setups with moving variable domains and fixed boundaries. Note that the FEProblem boundary-restricted integrity checks will also need to be turned off if using this option

  • 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

Input Files