API#
|
Applies parameters to devices and updates source states. |
|
Container for simulation field arrays and states. |
|
Wrapper around tc.autoinit that preserves parameter requirement information |
|
Performs 3D binary median filtering on the design. |
|
Creates boundary objects from a boundary configuration. |
|
Configuration class for boundary conditions. |
|
Applies 2D brush-based constraints to ensure minimum feature sizes. |
|
Creates a circular binary mask/brush for morphological operations. |
|
Maps continuous latent values to nearest allowed material indices. |
|
Color representation with multiple format support. |
|
Computes the total electromagnetic energy density of the field. |
|
Compute optical modes of a waveguide cross-section. |
|
Calculates the Poynting vector (energy flux) from E and H fields. |
|
Connects floating polymer regions and ensures air holes connect to outside. |
|
Sampled waveform temporal profile for arbitrary time signals. |
|
A cylindrical optical fiber with configurable properties. |
|
Base class for electromagnetic field detectors in FDTD simulations. |
|
Abstract base class for devices with optimizable permittivity distributions. |
|
Enforce diagonal symmetry by effectively halving the parameter space. |
|
Compression module that converts data types of field values. |
|
Detector for measuring electromagnetic energy distribution. |
|
Convenience function to export a snapshot of FDTD simulation arrays to a VTI file. |
|
Create a dictionary from the given object for exporting to JSON. |
Create a json string from the given object. |
|
|
Export a 3D boolean matrix to an STL file. |
|
Export a dictionary of arrays to a VTI (VTK ImageData) file. |
|
A polygon object specified by a list of vertices. |
|
A wrapper for pytreeclass fields. |
|
Detector for measuring field components of electromagnetic fields in the time domain. |
|
Creates a field that automatically freezes on set and unfreezes on get. |
|
Creates a field that automatically freezes on set and unfreezes on get, sets the default to None and init to False. |
|
Perform full backward FDTD propagation from current state to start time. |
|
|
|
Gaussian pulse temporal profile with carrier wave. |
|
Applies Gaussian smoothing to 2D parameter arrays. |
|
Configuration for gradient computation in simulations. |
|
Constrains an object's position to specific grid coordinates. |
|
|
|
Time step filter that performs linear reconstruction between sampled steps. |
|
Logger for managing experiment outputs and visualization. |
|
Represents an electromagnetic material with specific electrical and magnetic properties. |
|
Calculate efficiency metrics between input and output detectors. |
|
Detector for measuring the overlap of a waveguide mode with the simulation fields. |
|
|
|
Normalizes electromagnetic fields by their total energy. |
|
Normalize fields so the integrated Poynting flux along |
|
Container for managing simulation objects and their relationships. |
|
|
|
Implements a Convolutional Perfectly Matched Layer (CPML) boundary condition. |
alias of |
|
|
Detector for measuring frequency components of electromagnetic fields using an efficient Phasor Implementation. |
|
Constraint module for mapping pillar structures to allowed configurations. |
|
Places simulation objects according to specified constraints and initializes containers. |
|
Creates a visualization of the simulation setup showing objects in XY, XZ and YZ planes. |
|
Creates a visualization of the simulation setup from a single viewing side. |
|
Creates a visualization of the simulation setup from a single viewing side. |
|
Creates a visualization of material distribution from a single viewing side. |
|
Creates a visualization of material distribution showing slices in XY, XZ and YZ planes. |
|
Plots a single component of the electromagnetic field. |
|
Creates a visualization of electromagnetic field components. |
|
Defines a positional relationship between two simulation objects. |
|
Detector for measuring Poynting flux in electromagnetic simulations. |
|
Creates a field that sets the default to None and init to False. |
|
Constrains an object's position to specific real-space coordinates. |
|
Records and compresses simulation data over time using a sequence of processing modules. |
|
Container for simulation recording state data. |
|
Finds all material that floats in the air and sets their permittivity to air. |
|
|
|
Resolve object constraints into grid slices and shapes. |
|
Configuration settings for FDTD simulations. |
|
Abstract base class for objects in a 3D simulation environment. |
Built-in immutable sequence. |
|
|
Background material for the entire simulation volume. |
|
Simple sinusoidal temporal profile at a single frequency. |
|
Defines a size relationship between two simulation objects. |
|
Defines how an object extends toward another object or boundary. |
|
A sphere or ellipsoid object with configurable properties. |
|
Maps standard [0,1] range to custom range [min_value, max_value]. |
Maps standard [0,1] range to inverse permittivity range. |
|
Maps standard [0,1] range to [-1,1] range. |
|
|
This function is adapted from the Meep repository: NanoComp/meep |
|
Tanh projection filter. |
Base class for temporal profiles of sources. |
|
|
Extended tree class with improved attribute setting functionality. |
|
|
|
|
|
Class describing a wavelength/period/frequency in free space. |
|
Convert wavelength to time period using speed of light. |