tidy3d.DCVoltageSource

class DCVoltageSource

Bases: Tidy3dBaseModel

DC voltage source in volts.

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

• name (Optional[str] = None) – voltage : ArrayLike[dtype=float, ndim=1] [units = V]. DC voltage usually used as source in ‘VoltageBC’ boundary conditions.

• units (Literal['V'] = V)

Notes

This voltage refers to potential above the equivalent simulation ground. Currently, electrical ports are not defined.

Examples

>>> import tidy3d as td
>>> voltages = [-0.5, 0, 1, 2, 3, 4]
>>> voltage_source = td.DCVoltageSource(voltage=voltages)

Attributes

attrs

Methods

check_voltage(val)

Inherited Common Usage

name

voltage

units

classmethod check_voltage(val)

__hash__()

Hash method.