tidy3d.VoltageBC#

class VoltageBC[source]#

Bases: HeatChargeBC

Constant electric potential (voltage) \(= \text{V}\) boundary condition. Sets a potential at the specified boundary.

Parameters:

attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().
source (DCVoltageSource) – [units = V]. Electric potential to be applied at the specified boundary.

Notes

In charge simulations it also accepts an array of voltages. In this case, a solution for each of these voltages will be computed.

Example

>>> import tidy3d as td
>>> voltage_source = td.DCVoltageSource(voltage=1)
>>> voltage_bc = td.VoltageBC(source=voltage_source)

Attributes

Methods

Inherited Common Usage

tidy3d.VoltageBC