fdtdx.SizeExtensionConstraint#
- class fdtdx.SizeExtensionConstraint(*, object, other_object, axis, direction, other_position, offset, grid_offset)[source]#
Bases:
objectDefines how an object extends toward another object or boundary.
A constraint that extends one object’s size until it reaches another object or the simulation boundary. Can extend in positive or negative direction along an axis.
Quick Reference#
Attributes
Methods
Attributes#
-
SizeExtensionConstraint.object:
str# The object being extended
-
SizeExtensionConstraint.other_object:
str|None# Optional target object to extend to
-
SizeExtensionConstraint.axis:
int# Which axis to extend along
-
SizeExtensionConstraint.direction:
Literal['+','-']# Direction to extend (‘+’ or ‘-‘)
-
SizeExtensionConstraint.other_position:
float# Relative position on target (-1 to 1)
-
SizeExtensionConstraint.offset:
float# Additional real-space offset
-
SizeExtensionConstraint.grid_offset:
int# Additional grid-space offset
Methods#
If you find any errors in the documentation, please report them in the Github Issues!