fdtdx.GridCoordinateConstraint

Contents

fdtdx.GridCoordinateConstraint#

class fdtdx.GridCoordinateConstraint(*, object, axes, sides, coordinates)[source]#

Bases: object

Constrains an object’s position to specific grid coordinates.

Forces specific sides of an object to align with given grid coordinates. Used for precise positioning in the discretized simulation space.

Quick Reference#

Attributes

object
axes
sides
coordinates

Methods

Attributes#

GridCoordinateConstraint.object: str#: The object to position

GridCoordinateConstraint.axes: tuple[int, ...]#: Which axes to constrain

GridCoordinateConstraint.sides: tuple[Literal['+', '-'], ...]#: Which side of each axis (‘+’ or ‘-‘)

GridCoordinateConstraint.coordinates: tuple[int, ...]#: Grid coordinates to align with

Methods#

If you find any errors in the documentation, please report them in the Github Issues!