fdtdx.PositionConstraint#
- class fdtdx.PositionConstraint(*, object, other_object, axes, object_positions, other_object_positions, margins, grid_margins)[source]#
Bases:
objectDefines a positional relationship between two simulation objects.
A constraint that positions one object relative to another, with optional margins and offsets. Used to specify how objects should be placed in the simulation volume relative to each other.
Quick Reference#
Attributes
Methods
Attributes#
-
PositionConstraint.object:
str# The “child” object whose position is being adjusted
-
PositionConstraint.other_object:
str# The “parent” object that serves as reference
-
PositionConstraint.axes:
tuple[int,...]# Which axes (x,y,z) this constraint applies to
-
PositionConstraint.object_positions:
tuple[float,...]# Relative positions on child object (-1 to 1)
-
PositionConstraint.other_object_positions:
tuple[float,...]# Relative positions on parent object (-1 to 1)
-
PositionConstraint.margins:
tuple[float,...]# Optional real-space margins between objects
-
PositionConstraint.grid_margins:
tuple[int,...]# Optional grid-space margins between objects
Methods#
If you find any errors in the documentation, please report them in the Github Issues!