camfr_stack_expr_for_structure

ipkiss3.all.device_sim.camfr_stack_expr_for_structure(structure, discretisation_resolution, environment, material_stack_to_material_map, window_size_info=None, process_flow=None, material_stack_factory=None, include_growth=0.0, visualize=False)

For a given layout, call virtual fabrication and return a camfr.Expression that can be used to run a simulation. Any camfr global settings (like PML thickness) must be set beforehand.

Parameters:

structure : LayoutView

Layout of the structure that will be simulated.

discretisation_resolution : int

1 / discretisation_resolution defines what is the minimal change between the widths and lengths of consecutive slabs of a longitudinally variant structure.

environment : Environment

Environment object, used to specify the wavelength.

material_stack_to_material_map : dict

Mapping from a material stack to an effective material with a (model) for an effective index of refraction. Needs to be specified for each stack.

window_size_info : InfoSize, optional

Defines the computational domain. If smaller than the actual structure it defines the simulation region.

process_flow : VFabricationProcessFlow, optional

Defines the virtual fabrication stacks. The default is TECH.VFABRICATION.PROCESS_FLOW.

material_stack_factory : MaterialStackFactory, optional

A set of material stacks that define the virtual fabrication. The default is TECH.MATERIAL_STACKS.

include_growth : float, optional

Grows the simulation region, default 0.0.

visualize : bool, optional

If True, visualizes the discretised structure. Default False.

Returns:

camfr.Expression()

Camfr expression for stacked slabs, which are defined by discretising the geometry. To be used with camfr.Stack()