tidy3d.GroundVoltage

Contents

tidy3d.GroundVoltage#

class GroundVoltage[source]#

Bases: Tidy3dBaseModel

Ground voltage source (0V reference).

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)