ipkiss3.all.device_sim.Tidy3DFDTDSimulation

class ipkiss3.all.device_sim.Tidy3DFDTDSimulation

Define a simulation for use with Tidy3D’s FDTD cloud solutions.

Parameters:

geometry: SimulationGeometry, required

The geometrical setup (objects, materials, …) we want to simulate

extend_structure_in_z: optional

Extend the structure in z direction, bottom and top

use_stl: ( bool, bool_ or int ), optional

Use STL to export the geometry

center_wavelength: float and number > 0, optional

Central frequency for the simulation

task_folder_name: str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters, optional

Folder Name of the Tidy3D task in web GUI

task_name: str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters, optional

Name of the Tidy3D task

project_folder: str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters, optional

Path to the project files

solver: str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters, optional

Engine used for the simulations

solver_material_map: dict, optional

Mapping of ipkiss TECH.MATERIALS items onto names that represent a native material in a electromagnetic solver. If specified, this map is used to reuse the native materials in the solver. Default is empty, which means we use the information available from TECH.MATERIALS to create the different materials in the solver.

setup_macros: list and List with type restriction, allowed types: (<class ‘ipkiss3.simulation.device._simapi.Macro’>, <class ‘ipkiss3.simulation.device._simapi.MacroFile’>), optional

Tool-specific macros to run as part of the job setup.

outputs: list, optional

Outputs of the simulation.

monitors: list, optional

Monitors to capture the fields within a simulation

Other Parameters:

engine: locked

The engine to use with the solver