Skip to main content

LumpedPort

Description​

Applies a rectangular lumped port boundary condition to selected surfaces of the electromagnetic model.

A lumped port provides an excitation and reference impedance for electromagnetic analysis. The port is characterized by its dimensions, voltage, impedance, and orientation.

Construction​

port = LumpedPort()port = LumpedPort(boundary)port = LumpedPort(boundary, property_name = property_value)

port = LumpedPort()

port = LumpedPort() Creates a rectangular lumped port with default parameters and without a boundary assignment.

port = LumpedPort(boundary)

port = LumpedPort(boundary) Creates a rectangular lumped port and assigns it to the specified mesh boundary.

port = LumpedPort(boundary, property_name = property_value)

port = LumpedPort(boundary, property_name = property_value) Creates a rectangular lumped port with the specified property value.

Constructor Inputs​

NameTypeUnitRequiredDefaultDescription

boundary

int | list[int]

Optional

None

Mesh boundary IDs identifying the surfaces where the lumped port is applied.

width

float

m

Optional

1e-3

Width of the rectangular port perpendicular to the voltage direction.

height

float

m

Optional

1e-3

Height of the rectangular port along the voltage direction.

impedance

float | complex

Ω

Optional

50.0

Reference impedance of the lumped port.

voltage

float

V

Optional

1.0

Excitation voltage applied to the lumped port.

voltage_direction

list[float] | str

Optional

[0.0, 0.0, 1.0]

Direction from the ground conductor to the signal conductor. Specify a direction vector or one of “x”, “y”, “z”, “-x”, “-y”, “-z”.

power_flow_direction

list[float] | str

Optional

[1.0, 0.0, 0.0]

Positive power propagation direction toward the device under test. Specify a direction vector or one of “x”, “y”, “z”, “-x”, “-y”, “-z”.

Properties​

boundary

Type int | list[int]Access read/write

Mesh boundary IDs identifying the surfaces where the lumped port is applied.

width

Type floatAccess read/writeUnit m

Width of the rectangular port perpendicular to the voltage direction. Must be positive.

height

Type floatAccess read/writeUnit m

Height of the rectangular port along the voltage direction. Must be positive.

impedance

Type float | complexAccess read/writeUnit Ω

Reference impedance of the lumped port.

voltage

Type floatAccess read/writeUnit V

Excitation voltage applied to the lumped port.

voltage_direction

Type list[float] | strAccess read/write

Direction from the ground conductor to the signal conductor. Accepts a direction vector or an axis string.

power_flow_direction

Type list[float] | strAccess read/write

Positive power propagation direction toward the device under test. Accepts a direction vector or an axis string.

Examples​

Define a rectangular lumped port
port = LumpedPort(
    boundary=1,
    width=1e-3,
    height=2e-3,
    impedance=50.0,
    voltage=1.0,
    voltage_direction="z",
    power_flow_direction="x"
)

Mathematical Definition​

For a rectangular lumped port, the port voltage is defined by the electric field across the port surface:

V=1w∫ΓpE⋅l^ dS.(1)V = \frac{1}{w} \int_{\Gamma_p} \vb{E}\cdot\vu{l}\,\mathrm{d}S. \tag{1}

where VV is the port voltage, ww is the port width, Γp\Gamma_p is the rectangular port surface, E\vb{E} is the electric field, and l^\vu{l} is the unit vector along the voltage direction. The port height hh is measured along l^\vu{l}.

Notes​

The lumped port formulation assumes a rectangular port surface. The specified width and height should correspond to the dimensions of the assigned mesh boundary.

The current implementation does not validate whether the assigned boundary surface is rectangular. Users are responsible for ensuring that the port geometry is consistent with the rectangular lumped port formulation.

The voltage_direction and power_flow_direction parameters accept the axis strings "x", "y", "z", "-x", "-y", and "-z", in addition to direction vectors.

Errors / Exceptions​

Error / Exceptions List
tanager:validatormessage:MustBeDataType
Condition

boundary, width, height, impedance, voltage, voltage_direction, or power_flow_direction has an invalid data type.

Resolution

Use the supported data type specified in the corresponding input argument.

tanager:validatormessage:MustBePositive
Condition

width or height is zero or negative.

Resolution

Specify a positive floating-point value for width and height.

tanager:validatormessage:mustBeValidDirection
Condition

voltage_direction or power_flow_direction contains an unsupported direction string.

Resolution

Use “x”, “y”, “z”, “-x”, “-y”, or “-z”, or specify a numeric direction vector.