fdtdx.PeriodicBoundary

Bases: BaseBoundary

Implements periodic boundary conditions.

The periodic boundary connects opposite sides of the simulation domain, making waves that exit one side reenter from the opposite side.

Attributes:
  • axis (int) –

    Principal axis for periodicity (0=x, 1=y, 2=z)

  • direction (Literal['+', '-']) –

    Direction along axis ("+" or "-")

  • color (tuple[float, float, float] | None) –

    RGB color tuple for visualization. Defaults to light blue.

descriptive_name property 

descriptive_name: str

Gets a human-readable name describing this periodic boundary's location.

Returns:
  • str( str ) –

    Description like "min_x" or "max_z" indicating position

thickness property 

thickness: int

Gets the thickness of the periodic boundary layer in grid points.

Returns:
  • int( int ) –

    Number of grid points in the boundary layer (always 1 for periodic)