CartesianFDFDGeometry#

class CartesianFDFDGeometry(Nx, Ny, Npmlx, Npmly, dx, dy, bloch_x=0.0, bloch_y=0.0)[source]#

Bases: GeometryHyperparameters

Cartesian FDFD geometry specification.

Parameters:

Nx (int)
Ny (int)
Npmlx (int)
Npmly (int)
dx (float)
dy (float)
bloch_x (float)
bloch_y (float)

Nx#

Number of pixels along the x direction.

Type:: int

Ny#

Number of pixels along the y direction.

Type:: int

Npmlx#

Size of the x direction PML in pixels.

Type:: int

Npmly#

Size of the y direction PML in pixels.

Type:: int

dx#

Finite difference grid pixel size in x direction, in units of 1.

Type:: float

dy#

Finite difference grid pixel size in y direction, in units of 1.

Type:: float

bloch_x#

x-direction phase shift associated with the periodic boundary conditions. Default: 0.0

Type:: float

bloch_y#

y-direction phase shift associated with the periodic boundary conditions. Default: 0.0

Type:: float

Attributes Summary

`Npmlx`
`Npmly`
`Nx`
`Ny`
`bloch_x`
`bloch_y`
`dx`
`dy`

Methods Summary

`get_grid_size`()	Return grid dimensions.
`get_pixel_areas`()	Return the area of each pixel in the grid.

Attributes Documentation

Npmlx: int = <dataclasses._MISSING_TYPE object>#

Npmly: int = <dataclasses._MISSING_TYPE object>#

Nx: int = <dataclasses._MISSING_TYPE object>#

Ny: int = <dataclasses._MISSING_TYPE object>#

bloch_x: float = 0.0#

bloch_y: float = 0.0#

dx: float = <dataclasses._MISSING_TYPE object>#

dy: float = <dataclasses._MISSING_TYPE object>#

Methods Documentation

get_grid_size()[source]#

Return grid dimensions.

Returns:: Grid dimensions (Nx, Ny).
Return type:: tuple of int

get_pixel_areas()[source]#

Return the area of each pixel in the grid.

Returns:: Flattened array of pixel areas (all equal to dx * dy).
Return type:: ndarray of float