tidy3d.GroundVoltage

class GroundVoltage

Bases: Tidy3dBaseModel

Ground voltage source (0V reference).

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

Notes

This source explicitly sets the ground reference (0V) for the simulation. It is equivalent to DCVoltageSource(voltage=0) but more explicit about establishing the ground reference.

If no GroundVoltage is specified, the smallest voltage among all sources will be considered as the ground reference. Note that the boundary conditions defined using a voltage array will be ignored during this process and cannot be used as a default ground.

Example

>>> import tidy3d as td
>>> ground_source = td.GroundVoltage()
>>> voltage_bc = td.VoltageBC(source=ground_source)

Attributes

attrs

Methods

Inherited Common Usage

__hash__()

Hash method.