pya.DTrans(submask_pos - submask_layout.wafer_center + self.wafer_center))
)
+ maskextra_cell: pya.Cell = self.layout.create_cell("MaskExtra")
+ marker_region = self._add_all_markers_to_mask(maskextra_cell)
+
self._insert_mask_name_label(self.top_cell, default_layers["mask_graphical_rep"], 'G')
# add chips from chips_map
- self._add_chips_from_map(self.chips_map, self.chip_size, None, self.align_to)
+ self._add_chips_from_map(self.chips_map, self.chip_size, None, self.align_to, marker_region)
for (chips_map, chip_size, align, align_to) in self.extra_chips_maps:
- self._add_chips_from_map(chips_map, chip_size, align, align_to)
+ self._add_chips_from_map(chips_map, chip_size, align, align_to, marker_region)
# add chips outside chips_map
for name, pos, *optional in self.extra_chips:
@@ -747,7 +750,7 @@ Source code for kqcircuits.masks.mask_layout
self.region_covered -= self._add_chip(name, pos, trans, position_label)[1]
self.chip_counts[name] += 1
- maskextra_cell: pya.Cell = self.layout.create_cell("MaskExtra")
+ self.region_covered -= marker_region
self._mask_create_covered_region(maskextra_cell, self.region_covered, self.layers_to_mask)
convert_child_instances_to_static(self.layout, maskextra_cell, only_elements=True, prune=True)
merge_layout_layers_on_face(self.layout, maskextra_cell, self.face())
@@ -848,7 +851,7 @@ Source code for kqcircuits.masks.mask_layout
region_covered = pya.Region(pya.DPolygon(points).to_itype(self.layout.dbu))
return region_covered
- def _add_chips_from_map(self, chips_map, chip_size, align, align_to):
+ def _add_chips_from_map(self, chips_map, chip_size, align, align_to, marker_region):
orig = pya.DVector(-self.wafer_rad, self.wafer_rad) - self.chips_map_offset
if align_to:
orig = pya.DVector(*align_to)
@@ -884,6 +887,9 @@ Source code for kqcircuits.masks.mask_layout
elif pos.y + chip_size > self._mask_name_box_bottom_y:
print(f" Warning, dropping chip {name} at ({i}, {j}), '{self.face_id}' - too close to mask label "
f" {(pos.y + chip_size):.2f} < {self._mask_name_box_bottom_y}")
+ elif pya.Region(pya.Box(pos.x, pos.y, pos.x + chip_size, pos.y + chip_size) * (1 / self.layout.dbu)) \
+ & marker_region:
+ print(f" Warning, dropping chip {name} at ({i}, {j}), '{self.face_id}' - overlaps with marker ")
else:
added_chip, region_chip = self._add_chip(name, position, self.chip_trans)
region_used += region_chip
@@ -909,6 +915,21 @@ Source code for kqcircuits.masks.mask_layout
return True, chip_region
return False, chip_region
+ def _add_all_markers_to_mask(self, maskextra_cell):
+ marker_region = pya.Region()
+ for marker, m_kwargs in self.mask_markers_dict.items():
+ # load values into kwargs
+ m_kwargs['window'] = m_kwargs.get("window", True)
+ m_kwargs['face_ids'] = m_kwargs.get("face_ids", [self.face_id])
+ m_kwargs['wafer_rad'] = m_kwargs.get("wafer_rad", self.wafer_rad)
+ m_kwargs['edge_clearance'] = m_kwargs.get("edge_clearance", self.edge_clearance)
+ cell_marker = marker.create(self.layout, **m_kwargs)
+ marker_transes = marker.get_marker_locations(cell_marker, **m_kwargs)
+ for trans in marker_transes:
+ inst = maskextra_cell.insert(pya.DCellInstArray(cell_marker.cell_index(), trans))
+ marker_region += marker.get_marker_region(inst, **m_kwargs)
+ return marker_region
+
def _mask_create_covered_region(self, maskextra_cell, region_covered, layers_dict):
dbu = self.layout.dbu
@@ -930,19 +951,6 @@ Source code for kqcircuits.masks.mask_layout
for a in range(0, 64 + 1)], 100)
maskextra_cell.shapes(self.layout.layer(default_layers["mask_graphical_rep"])).insert(circle)
- # add all markers to the mask
- for marker, m_kwargs in self.mask_markers_dict.items():
- # load values into kwargs
- m_kwargs['window'] = m_kwargs.get("window", True)
- m_kwargs['face_ids'] = m_kwargs.get("face_ids", [self.face_id])
- m_kwargs['wafer_rad'] = m_kwargs.get("wafer_rad", self.wafer_rad)
- m_kwargs['edge_clearance'] = m_kwargs.get("edge_clearance", self.edge_clearance)
- cell_marker = marker.create(self.layout, **m_kwargs)
- marker_transes = marker.get_marker_locations(cell_marker, **m_kwargs)
- for trans in marker_transes:
- inst = maskextra_cell.insert(pya.DCellInstArray(cell_marker.cell_index(), trans))
- region_covered -= marker.get_marker_region(inst, **m_kwargs)
-
maskextra_cell.shapes(self.layout.layer(default_layers["mask_graphical_rep"])).insert(region_covered)
# remove unwanted circle boundary and filling from `layers_to_mask` which have been excluded in
# `covered_region_excluded_layers`
diff --git a/_modules/kqcircuits/masks/mask_set.html b/_modules/kqcircuits/masks/mask_set.html
index 144348bb8..1e5b30996 100644
--- a/_modules/kqcircuits/masks/mask_set.html
+++ b/_modules/kqcircuits/masks/mask_set.html
@@ -725,18 +725,22 @@ Source code for kqcircuits.masks.mask_set
'display_name': variant_name,
'name_copy': None,
}
- if chip_params:
- params.update(chip_params)
-
if mock_chips:
- chip_params = chip_class().pcell_params_by_name(**params)
- mock_params = {k: chip_params[k] for k in ['box', 'face_boxes', 'frames_enabled', 'frames_marker_dist',
- 'frames_diagonal_squares', 'frames_mirrored', 'face_ids']}
- mock_params['with_grid'] = False
+ mock_params = chip_class().pcell_params_by_name(Chip, **params)
+ if chip_params:
+ # Pass through parameters only if they exist in Chip
+ mock_params.update({k: v for k, v in chip_params.items() if k in mock_params})
+ mock_params.update({
+ 'with_grid': False,
+ 'with_gnd_bumps': False,
+ 'with_gnd_tsvs': False,
+ })
cell = Chip.create(layout, **mock_params)
else:
+ if chip_params:
+ params.update(chip_params)
cell = chip_class.create(layout, **params)
- else: # its a file name, load it
+ else: # it's a file name, load it
load_opts = pya.LoadLayoutOptions()
if hasattr(pya.LoadLayoutOptions, "CellConflictResolution"):
load_opts.cell_conflict_resolution = pya.LoadLayoutOptions.CellConflictResolution.RenameCell
diff --git a/_modules/kqcircuits/simulations/export/ansys/ansys_export.html b/_modules/kqcircuits/simulations/export/ansys/ansys_export.html
index d75886e62..8a3010e48 100644
--- a/_modules/kqcircuits/simulations/export/ansys/ansys_export.html
+++ b/_modules/kqcircuits/simulations/export/ansys/ansys_export.html
@@ -575,8 +575,9 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
frequency_units="GHz", frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30,
maximum_passes=12, minimum_passes=1, minimum_converged_passes=1,
sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating',
- max_delta_f=0.1, n_modes=2, gap_max_element_length=None, substrate_loss_tangent=0,
- dielectric_surfaces=None, simulation_flags=None, ansys_project_template=None):
+ max_delta_f=0.1, n_modes=2, mesh_size=None, substrate_loss_tangent=0,
+ dielectric_surfaces=None, simulation_flags=None, ansys_project_template=None,
+ integrate_energies=False):
r"""
Export Ansys simulation into json and gds files.
@@ -599,8 +600,8 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
sweep_type: choices are "interpolating", "discrete" or "fast"
max_delta_f: Maximum allowed relative difference in eigenfrequency (%). Used when ``ansys_tool`` is *eigenmode*.
n_modes: Number of eigenmodes to solve. Used when ``ansys_tool`` is 'pyepr'.
- gap_max_element_length: Largest mesh element length allowed in the gaps given in simulation units
- (if None is given, then the mesh element size is not restricted in the gap).
+ mesh_size(dict): Dictionary to determine manual mesh refinement on layers. Set key as the layer name and
+ value as the maximal mesh element length inside the layer.
substrate_loss_tangent: Bulk loss tangent (:math:`\tan{\delta}`) material parameter. 0 is off.
dielectric_surfaces: Material parameters for TLS interfaces, used in post-processing field calculations
from the participation sheets. Default is None. Input is of the form::
@@ -622,6 +623,7 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
},
simulation_flags: Optional export processing, given as list of strings
ansys_project_template: path to the simulation template
+ integrate_energies: Calculate energy integrals over each layer and save them into a file
Returns:
Path to exported json file.
@@ -652,10 +654,11 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
'max_delta_f': max_delta_f,
'n_modes': n_modes,
},
- 'gap_max_element_length': gap_max_element_length,
+ 'mesh_size': {} if mesh_size is None else mesh_size,
'substrate_loss_tangent': substrate_loss_tangent,
'dielectric_surfaces': dielectric_surfaces,
- 'simulation_flags': simulation_flags
+ 'simulation_flags': simulation_flags,
+ 'integrate_energies': integrate_energies
}
if ansys_project_template is not None:
@@ -756,12 +759,12 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
frequency_units="GHz", frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30,
maximum_passes=12, minimum_passes=1, minimum_converged_passes=1,
sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating',
- max_delta_f=0.1, n_modes=2, gap_max_element_length=None, substrate_loss_tangent=0,
+ max_delta_f=0.1, n_modes=2, mesh_size=None, substrate_loss_tangent=0,
dielectric_surfaces=None, exit_after_run=False,
ansys_executable=r"%PROGRAMFILES%\AnsysEM\v232\Win64\ansysedt.exe",
import_script='import_and_simulate.py', post_process_script='export_batch_results.py',
intermediate_processing_command=None, use_rel_path=True, simulation_flags=None,
- ansys_project_template=None, skip_errors=False):
+ ansys_project_template=None, integrate_energies=False, skip_errors=False):
r"""
Export Ansys simulations by writing necessary scripts and json, gds, and bat files.
@@ -786,8 +789,8 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
sweep_type: choices are "interpolating", "discrete" or "fast"
max_delta_f: Maximum allowed relative difference in eigenfrequency (%). Used when ``ansys_tool`` is *eigenmode*.
n_modes: Number of eigenmodes to solve. Used when ``ansys_tool`` is 'eigenmode'.
- gap_max_element_length: Largest mesh element length allowed in the gaps given in simulation units
- (if None is given, then the mesh element size is not restricted in the gap).
+ mesh_size(dict): Dictionary to determine manual mesh refinement on layers. Set key as the layer name and
+ value as the maximal mesh element length inside the layer.
substrate_loss_tangent: Bulk loss tangent (:math:`\tan{\delta}`) material parameter. 0 is off.
dielectric_surfaces: Material parameters for TLS interfaces, used in post-processing field calculations
from the participation sheets. Default is None. Input is of the form::
@@ -821,6 +824,7 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
use_rel_path: Determines if to use relative paths.
simulation_flags: Optional export processing, given as list of strings. See Simulation Export in docs.
ansys_project_template: path to the simulation template
+ integrate_energies: Calculate energy integrals over each layer and save them into a file
skip_errors: Skip simulations that cause errors. Default is False.
.. warning::
@@ -845,11 +849,12 @@ Source code for kqcircuits.simulations.export.ansys.ansys_export
sweep_enabled=sweep_enabled, sweep_start=sweep_start,
sweep_end=sweep_end, sweep_count=sweep_count, sweep_type=sweep_type,
max_delta_f=max_delta_f, n_modes=n_modes,
- gap_max_element_length=gap_max_element_length,
+ mesh_size=mesh_size,
substrate_loss_tangent=substrate_loss_tangent,
dielectric_surfaces=dielectric_surfaces,
simulation_flags=simulation_flags,
- ansys_project_template=ansys_project_template))
+ ansys_project_template=ansys_project_template,
+ integrate_energies=integrate_energies))
except (IndexError, ValueError, Exception) as e: # pylint: disable=broad-except
if skip_errors:
logging.warning(
diff --git a/_modules/kqcircuits/simulations/export/elmer/elmer_export.html b/_modules/kqcircuits/simulations/export/elmer/elmer_export.html
index a0085b3c6..08b39e7ec 100644
--- a/_modules/kqcircuits/simulations/export/elmer/elmer_export.html
+++ b/_modules/kqcircuits/simulations/export/elmer/elmer_export.html
@@ -580,6 +580,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
p_element_order=1,
frequency=5,
mesh_size=None,
+ boundary_conditions=None,
workflow=None,
percent_error=0.005,
max_error_scale=2,
@@ -599,6 +600,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
p_element_order(int): polynomial order of p-elements (Default: 1)
frequency: Units are in GHz. To set up multifrequency analysis, use list of numbers.
mesh_size(dict): Parameters to determine mesh element sizes
+ boundary_conditions(dict): Parameters to determine boundary conditions
workflow(dict): Parameters for simulation workflow
percent_error(float): Stopping criterion in adaptive meshing.
max_error_scale(float): Maximum element error, relative to percent_error, allowed in individual elements.
@@ -640,6 +642,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
**simulation.get_simulation_data(),
**({'layers': {k: (v.layer, v.datatype) for k, v in layers.items()}} if is_cross_section else {}),
'mesh_size': {} if mesh_size is None else mesh_size,
+ 'boundary conditions': boundary_conditions,
'workflow': {} if workflow is None else workflow,
'percent_error': percent_error,
'max_error_scale': max_error_scale,
@@ -943,6 +946,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
file_prefix='simulation',
script_file='scripts/run.py',
mesh_size=None,
+ boundary_conditions=None,
workflow=None,
percent_error=0.005,
max_error_scale=2,
@@ -966,6 +970,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
file_prefix: File prefix of the script file to be created.
script_file: Name of the script file to run.
mesh_size(dict): Parameters to determine mesh element sizes
+ boundary_conditions(dict): Parameters to determine boundary conditions
workflow(dict): Parameters for simulation workflow
percent_error(float): Stopping criterion in adaptive meshing.
max_error_scale(float): Maximum element error, relative to percent_error, allowed in individual elements.
@@ -1027,6 +1032,7 @@ Source code for kqcircuits.simulations.export.elmer.elmer_export
p_element_order=p_element_order,
frequency=frequency,
mesh_size=mesh_size,
+ boundary_conditions=boundary_conditions,
workflow=workflow,
percent_error=percent_error,
max_error_scale=max_error_scale,
diff --git a/_modules/kqcircuits/simulations/simulation.html b/_modules/kqcircuits/simulations/simulation.html
index f58556a34..219dbe57b 100644
--- a/_modules/kqcircuits/simulations/simulation.html
+++ b/_modules/kqcircuits/simulations/simulation.html
@@ -676,7 +676,8 @@ Source code for kqcircuits.simulations.simulation
airbridge_height = Param(pdt.TypeDouble, "Height of airbridges.", 3.4, unit="µm")
metal_height = Param(pdt.TypeList, "Height of metal sheet on each face.", [0.0], unit="µm")
dielectric_height = Param(pdt.TypeList, "Height of insulator dielectric on each face.", [0.0], unit="µm")
- dielectric_material = Param(pdt.TypeList, "Material of insulator dielectric on each face.", ['silicon'], unit="µm")
+ dielectric_material = Param(pdt.TypeList, "Material of insulator dielectric on each face.", ['silicon'], unit="µm",
+ docstring="Use only keywords introduced in material_dict.")
waveguide_length = Param(pdt.TypeDouble, "Length of waveguide stubs or distance between couplers and waveguide "
"turning point", 100, unit="µm")
@@ -684,8 +685,19 @@ Source code for kqcircuits.simulations.simulation
vertical_over_etching = Param(pdt.TypeDouble, "Vertical over-etching into substrates at gaps.", 0, unit="μm")
hollow_tsv = Param(pdt.TypeBoolean, "Make TSVs hollow with vacuum inside and thin metal boundary.", False)
- participation_sheet_distance = Param(pdt.TypeDouble, "Distance to non-model TLS interface sheet.", 0.0, unit="µm")
- participation_sheet_thickness = Param(pdt.TypeDouble, "Thickness of non-model TLS interface sheet.", 0.0, unit="µm")
+ metal_edge_region_dimensions = Param(pdt.TypeList, "Dimensions of metal edge region", [], unit="µm",
+ docstring="Metal edge region is disabled if the list is empty. The terms in "
+ "the list correspond to expansion dimensions into direction of gap, "
+ "vacuum, metal, and substrate, respectively. The implementation "
+ "uses the modulo operator in indexing, so one can set the list as "
+ "[r] meaning that r is the expansion to all directions, or set as "
+ "[r_lat, r_vert] to separate lateral and vertical expansions.")
+ tls_layer_thickness = Param(pdt.TypeList, "Thickness of TLS interface layers (MA, MS, and SA, respectively)", [0.0],
+ unit="µm")
+ tls_layer_material = Param(pdt.TypeList, "Materials of TLS interface layers (MA, MS, and SA, respectively)", None,
+ docstring="Use None to create non-model layers. Otherwise, use only keywords "
+ "introduced in material_dict.")
+ tls_sheet_approximation = Param(pdt.TypeBoolean, "Approximate TLS interface layers as sheets", False)
minimum_point_spacing = Param(pdt.TypeDouble, "Tolerance for merging adjacent points in polygon", 0.01, unit="µm")
polygon_tolerance = Param(pdt.TypeDouble, "Tolerance for merging adjacent polygons in a layer", 0.004, unit="µm")
@@ -987,7 +999,7 @@ Source code for kqcircuits.simulations.simulation
# insert TSVs and indium bumps
tsv_params = {'edge_material': 'pec'} if self.hollow_tsv else {'material': 'pec'}
tsv_region = self.insert_layers_between_faces(i, i - sign, "through_silicon_via", **tsv_params)
- self.insert_layers_between_faces(i, i + sign, "indium_bump", material='pec')
+ bump_region = self.insert_layers_between_faces(i, i + sign, "indium_bump", material='pec')
for j, face_id in enumerate(face_ids):
ground_box_region = pya.Region(self._face_box(i).to_itype(self.layout.dbu))
@@ -1028,18 +1040,19 @@ Source code for kqcircuits.simulations.simulation
dielectric_region = ground_box_region - self.simplified_region(
self.region_from_layer(face_id, "dielectric_etch"))
- # Create gap region. Subtract TSVs and ground-grid from regions.
- gap_region = ground_box_region - signal_region - ground_region
+ # Create gap and etch regions and update metals
+ gap_region = ground_box_region - signal_region - ground_region # excluding ground grid
+ if self.with_grid:
+ ground_region -= self.ground_grid_region(face_id)
+ etch_region = ground_box_region - signal_region - ground_region # including ground grid
signal_region -= tsv_region
ground_region -= tsv_region
dielectric_region -= tsv_region
- if self.with_grid:
- ground_region -= self.ground_grid_region(face_id)
# Insert signal, ground, and dielectric layers to model via splitter
if j == 0 and self.vertical_over_etching > 0.0:
- self.add_layer_to_splitter(splitter, ground_box_region - signal_region - ground_region,
- face_id + "_etch", thickness=-sign * self.vertical_over_etching)
+ self.add_layer_to_splitter(splitter, etch_region, face_id + "_etch",
+ thickness=-sign * self.vertical_over_etching)
metal_thickness = z[face_id][1] - z[face_id][0]
self.add_layer_to_splitter(splitter, signal_region, face_id + "_signal", thickness=metal_thickness,
@@ -1059,27 +1072,91 @@ Source code for kqcircuits.simulations.simulation
# Insert airbridges
bridge_z = sign * self.airbridge_height
- self.insert_layer(
- self.simplified_region(self.region_from_layer(face_id, "airbridge_flyover")) & ground_box_region,
- face_id + "_airbridge_flyover", z=z[face_id][1] + bridge_z, thickness=0.0, material='pec')
- self.insert_layer(
- self.simplified_region(self.region_from_layer(face_id, "airbridge_pads")) & ground_box_region,
- face_id + "_airbridge_pads", z=z[face_id][1], thickness=bridge_z, material='pec')
-
- # Insert participation layers (no material)
- if j == 0 and self.participation_sheet_distance + self.participation_sheet_thickness > 0.0:
- self.insert_layer(signal_region + ground_region, face_id + "_layerMA",
- z=z[face_id][1] + sign * self.participation_sheet_distance,
- thickness=sign * self.participation_sheet_thickness)
- self.insert_layer(signal_region + ground_region, face_id + "_layerMS",
- z=z[face_id][0] - sign * self.participation_sheet_distance,
- thickness=-sign * self.participation_sheet_thickness)
- self.insert_layer(ground_box_region - signal_region - ground_region, face_id + "_layerSA",
- z=z[face_id][0] + sign * self.participation_sheet_distance,
- thickness=sign * self.participation_sheet_thickness)
+ ab_flyover_region = self.simplified_region(self.region_from_layer(face_id, "airbridge_flyover")
+ ) & ground_box_region
+ self.insert_layer(ab_flyover_region, face_id + "_airbridge_flyover", z=z[face_id][1] + bridge_z,
+ thickness=0.0, material='pec')
+ ab_pads_region = self.simplified_region(self.region_from_layer(face_id, "airbridge_pads")
+ ) & ground_box_region
+ self.insert_layer(ab_pads_region, face_id + "_airbridge_pads", z=z[face_id][1], thickness=bridge_z,
+ material='pec')
self.insert_splitter_layers(splitter, z[i + 1])
+ # Rest of the features are not available with multilayer stack-up
+ if len(face_ids) != 1:
+ continue
+ face_id = face_ids[0]
+
+ # Create metal edge region
+ metal_region = signal_region + ground_region
+ me_region = pya.Region()
+ n_terms = len(self.metal_edge_region_dimensions)
+ if n_terms > 0:
+ r_gap = float(self.metal_edge_region_dimensions[0])
+ r_metal = float(self.metal_edge_region_dimensions[2 % n_terms])
+ me_region = (metal_region.sized(r_gap / self.layout.dbu) & etch_region.sized(r_metal / self.layout.dbu)
+ & ground_box_region)
+
+ # Insert TLS interface layers
+ for layer_num, layer_id in enumerate(['MA', 'MS', 'SA']):
+ layer_name = face_id + "_layer" + layer_id
+ layer_z = [z[face_id][1], z[face_id][0], z[face_id][0] - sign * self.vertical_over_etching][layer_num]
+ thickness = float(self.ith_value(self.tls_layer_thickness, layer_num))
+ signed_thickness = [sign, -sign, -sign][layer_num] * thickness
+ if self.tls_sheet_approximation:
+ params = {'z': layer_z + signed_thickness,
+ 'thickness': 0.0}
+ elif thickness != 0.0:
+ material = self.ith_value(self.tls_layer_material, layer_num)
+ params = {'z': layer_z,
+ 'thickness': signed_thickness,
+ **(dict() if material is None else {'material': material})}
+
+ # Insert wall layer
+ wall_height = [z[face_id][0] - z[face_id][1], 0.0, sign * self.vertical_over_etching][layer_num]
+ if wall_height != 0.0:
+ wall_region = metal_region.sized(thickness / self.layout.dbu) & etch_region
+ self.insert_layer(wall_region, layer_name + "wall", z=layer_z, thickness=wall_height,
+ **(dict() if material is None else {'material': material}))
+ else:
+ continue
+
+ # Insert layer
+ layer_region = [metal_region.sized(thickness / self.layout.dbu) & (metal_region + etch_region -
+ bump_region - ab_pads_region),
+ metal_region, etch_region][layer_num]
+ me_layer_region = me_region & layer_region
+ if me_layer_region.is_empty():
+ self.insert_layer(layer_region, layer_name, **params)
+ else:
+ self.insert_layer(me_layer_region, layer_name + "mer", **params)
+ self.insert_layer(layer_region - me_region, layer_name, **params)
+
+ # Insert substrate and vacuum inside metal edge region
+ if not me_region.is_empty():
+ r_vacuum = float(self.metal_edge_region_dimensions[1 % n_terms])
+ r_substrate = float(self.metal_edge_region_dimensions[3 % n_terms])
+
+ if r_substrate != 0.0:
+ layers = ['_etch', '_through_silicon_via']
+ cond_layers = ['_layerMSmer', '_layerSAmer']
+ subtract = [k for k, v in self.layers.items() if face_id + '_' in k and
+ (any(k.endswith(t) for t in layers) or
+ (any(k.endswith(t) for t in cond_layers) and v.get('material', None) is not None))]
+ self.insert_layer(me_region, face_id + "_substratemer", z=z[face_id][0] - sign * r_substrate,
+ thickness=sign * r_substrate,
+ material=self.ith_value(self.substrate_material,
+ (i + int(self.lower_box_height <= 0)) // 2),
+ **({'subtract': subtract} if subtract else dict()))
+
+ if r_vacuum + r_substrate != 0.0:
+ subtract = [n for n, v in self.layers.items() if face_id + '_' in n and
+ v.get('material', None) is not None and v.get('thickness', 0.0) != 0.0]
+ self.insert_layer(me_region, face_id + "_vacuummer", z=z[face_id][0] - sign * r_substrate,
+ thickness=sign * (r_vacuum + r_substrate), material='vacuum',
+ **({'subtract': subtract} if subtract else dict()))
+
# Insert substrates
for i in range(int(self.lower_box_height > 0), len(face_stack) + 1, 2):
# faces around the substrate
@@ -1090,8 +1167,11 @@ Source code for kqcircuits.simulations.simulation
faces += face_stack[i-1]
# find layers to be subtracted from substrate
- layers = ['etch', 'through_silicon_via']
- subtract = [k for k in self.layers if any(t in k for t in layers) and any(t in k for t in faces)]
+ layers = ['_etch', '_through_silicon_via']
+ cond_layers = ['_layerMS', '_layerSA', '_layerMSmer', '_layerSAmer', '_substratemer']
+ subtract = [k for k, v in self.layers.items() if any(t + '_' in k for t in faces) and
+ (any(k.endswith(t) for t in layers) or
+ (any(k.endswith(t) for t in cond_layers) and v.get('material', None) is not None))]
# insert substrate layer
name = 'substrate' if len(face_stack) - int(self.lower_box_height > 0) < 2 else f'substrate_{i // 2}'
diff --git a/api/kqcircuits.simulations.export.ansys.ansys_export.html b/api/kqcircuits.simulations.export.ansys.ansys_export.html
index 67c851691..e5f158a96 100644
--- a/api/kqcircuits.simulations.export.ansys.ansys_export.html
+++ b/api/kqcircuits.simulations.export.ansys.ansys_export.html
@@ -557,7 +557,7 @@
-
-kqcircuits.simulations.export.ansys.ansys_export.export_ansys_json(simulation: kqcircuits.simulations.simulation.Simulation, path: pathlib.Path, ansys_tool='hfss', frequency_units='GHz', frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30, maximum_passes=12, minimum_passes=1, minimum_converged_passes=1, sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating', max_delta_f=0.1, n_modes=2, gap_max_element_length=None, substrate_loss_tangent=0, dielectric_surfaces=None, simulation_flags=None, ansys_project_template=None)[source]¶
+kqcircuits.simulations.export.ansys.ansys_export.export_ansys_json(simulation: kqcircuits.simulations.simulation.Simulation, path: pathlib.Path, ansys_tool='hfss', frequency_units='GHz', frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30, maximum_passes=12, minimum_passes=1, minimum_converged_passes=1, sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating', max_delta_f=0.1, n_modes=2, mesh_size=None, substrate_loss_tangent=0, dielectric_surfaces=None, simulation_flags=None, ansys_project_template=None, integrate_energies=False)[source]¶
Export Ansys simulation into json and gds files.
- Parameters
@@ -580,8 +580,8 @@
sweep_type – choices are “interpolating”, “discrete” or “fast”
max_delta_f – Maximum allowed relative difference in eigenfrequency (%). Used when ansys_tool is eigenmode.
n_modes – Number of eigenmodes to solve. Used when ansys_tool is ‘pyepr’.
gap_max_element_length – Largest mesh element length allowed in the gaps given in simulation units
-(if None is given, then the mesh element size is not restricted in the gap).
mesh_size (dict) – Dictionary to determine manual mesh refinement on layers. Set key as the layer name and
+value as the maximal mesh element length inside the layer.
substrate_loss_tangent – Bulk loss tangent (\(\tan{\delta}\)) material parameter. 0 is off.
dielectric_surfaces –
Material parameters for TLS interfaces, used in post-processing field calculations
from the participation sheets. Default is None. Input is of the form:
@@ -605,6 +605,7 @@
simulation_flags – Optional export processing, given as list of strings
ansys_project_template – path to the simulation template
integrate_energies – Calculate energy integrals over each layer and save them into a file
- Returns
@@ -646,7 +647,7 @@
-
-kqcircuits.simulations.export.ansys.ansys_export.export_ansys(simulations, path: pathlib.Path, ansys_tool='hfss', import_script_folder='scripts', file_prefix='simulation', frequency_units='GHz', frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30, maximum_passes=12, minimum_passes=1, minimum_converged_passes=1, sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating', max_delta_f=0.1, n_modes=2, gap_max_element_length=None, substrate_loss_tangent=0, dielectric_surfaces=None, exit_after_run=False, ansys_executable='%PROGRAMFILES%\\AnsysEM\\v232\\Win64\\ansysedt.exe', import_script='import_and_simulate.py', post_process_script='export_batch_results.py', intermediate_processing_command=None, use_rel_path=True, simulation_flags=None, ansys_project_template=None, skip_errors=False)[source]¶
+kqcircuits.simulations.export.ansys.ansys_export.export_ansys(simulations, path: pathlib.Path, ansys_tool='hfss', import_script_folder='scripts', file_prefix='simulation', frequency_units='GHz', frequency=5, max_delta_s=0.1, percent_error=1, percent_refinement=30, maximum_passes=12, minimum_passes=1, minimum_converged_passes=1, sweep_enabled=True, sweep_start=0, sweep_end=10, sweep_count=101, sweep_type='interpolating', max_delta_f=0.1, n_modes=2, mesh_size=None, substrate_loss_tangent=0, dielectric_surfaces=None, exit_after_run=False, ansys_executable='%PROGRAMFILES%\\AnsysEM\\v232\\Win64\\ansysedt.exe', import_script='import_and_simulate.py', post_process_script='export_batch_results.py', intermediate_processing_command=None, use_rel_path=True, simulation_flags=None, ansys_project_template=None, integrate_energies=False, skip_errors=False)[source]¶
Export Ansys simulations by writing necessary scripts and json, gds, and bat files.
- Parameters
@@ -671,8 +672,8 @@
sweep_type – choices are “interpolating”, “discrete” or “fast”
max_delta_f – Maximum allowed relative difference in eigenfrequency (%). Used when ansys_tool is eigenmode.
n_modes – Number of eigenmodes to solve. Used when ansys_tool is ‘eigenmode’.
gap_max_element_length – Largest mesh element length allowed in the gaps given in simulation units
-(if None is given, then the mesh element size is not restricted in the gap).
mesh_size (dict) – Dictionary to determine manual mesh refinement on layers. Set key as the layer name and
+value as the maximal mesh element length inside the layer.
substrate_loss_tangent – Bulk loss tangent (\(\tan{\delta}\)) material parameter. 0 is off.
dielectric_surfaces –
Material parameters for TLS interfaces, used in post-processing field calculations
from the participation sheets. Default is None. Input is of the form:
@@ -708,6 +709,7 @@
use_rel_path – Determines if to use relative paths.
simulation_flags – Optional export processing, given as list of strings. See Simulation Export in docs.
ansys_project_template – path to the simulation template
integrate_energies – Calculate energy integrals over each layer and save them into a file
skip_errors –
Skip simulations that cause errors. Default is False.
Warning
diff --git a/api/kqcircuits.simulations.export.elmer.elmer_export.html b/api/kqcircuits.simulations.export.elmer.elmer_export.html
index 863d3b2b8..4a9a34d9e 100644
--- a/api/kqcircuits.simulations.export.elmer.elmer_export.html
+++ b/api/kqcircuits.simulations.export.elmer.elmer_export.html
@@ -554,7 +554,7 @@
-
-kqcircuits.simulations.export.elmer.elmer_export.export_elmer_json(simulation, path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=1, frequency=5, mesh_size=None, workflow=None, percent_error=0.005, max_error_scale=2, max_outlier_fraction=0.001, maximum_passes=1, minimum_passes=1, dielectric_surfaces=None, is_axisymmetric=False)[source]¶
+kqcircuits.simulations.export.elmer.elmer_export.export_elmer_json(simulation, path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=1, frequency=5, mesh_size=None, boundary_conditions=None, workflow=None, percent_error=0.005, max_error_scale=2, max_outlier_fraction=0.001, maximum_passes=1, minimum_passes=1, dielectric_surfaces=None, is_axisymmetric=False)[source]¶
Export Elmer simulation into json and gds files.
- Parameters
@@ -566,6 +566,7 @@
p_element_order (int) – polynomial order of p-elements (Default: 1)
frequency – Units are in GHz. To set up multifrequency analysis, use list of numbers.
mesh_size (dict) – Parameters to determine mesh element sizes
boundary_conditions (dict) – Parameters to determine boundary conditions
workflow (dict) – Parameters for simulation workflow
percent_error (float) – Stopping criterion in adaptive meshing.
max_error_scale (float) – Maximum element error, relative to percent_error, allowed in individual elements.
-
-kqcircuits.simulations.export.elmer.elmer_export.export_elmer(simulations: Sequence[kqcircuits.simulations.simulation.Simulation], path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=3, frequency=5, file_prefix='simulation', script_file='scripts/run.py', mesh_size=None, workflow=None, percent_error=0.005, max_error_scale=2, max_outlier_fraction=0.001, maximum_passes=1, minimum_passes=1, dielectric_surfaces=None, is_axisymmetric=False, skip_errors=False)[source]¶
+kqcircuits.simulations.export.elmer.elmer_export.export_elmer(simulations: Sequence[kqcircuits.simulations.simulation.Simulation], path: pathlib.Path, tool='capacitance', linear_system_method='bicgstab', p_element_order=3, frequency=5, file_prefix='simulation', script_file='scripts/run.py', mesh_size=None, boundary_conditions=None, workflow=None, percent_error=0.005, max_error_scale=2, max_outlier_fraction=0.001, maximum_passes=1, minimum_passes=1, dielectric_surfaces=None, is_axisymmetric=False, skip_errors=False)[source]¶
Exports an elmer simulation model to the simulation path.
- Parameters
@@ -636,6 +637,7 @@
file_prefix – File prefix of the script file to be created.
script_file – Name of the script file to run.
mesh_size (dict) – Parameters to determine mesh element sizes
boundary_conditions (dict) – Parameters to determine boundary conditions
workflow (dict) – Parameters for simulation workflow
percent_error (float) – Stopping criterion in adaptive meshing.
max_error_scale (float) – Maximum element error, relative to percent_error, allowed in individual elements.
airbridge_height (Double) - Height of airbridges., default=3.4, unit=µm
metal_height (List) - Height of metal sheet on each face., default=[0.0], unit=µm
dielectric_height (List) - Height of insulator dielectric on each face., default=[0.0], unit=µm
dielectric_material (List) - Material of insulator dielectric on each face., default=['silicon'], unit=µm
dielectric_material (List) - Use only keywords introduced in material_dict., default=['silicon'], unit=µm
waveguide_length (Double) - Length of waveguide stubs or distance between couplers and waveguide turning point, default=100, unit=µm
over_etching (Double) - Expansion of metal gaps (negative to shrink the gaps)., default=0, unit=μm
vertical_over_etching (Double) - Vertical over-etching into substrates at gaps., default=0, unit=μm
hollow_tsv (Boolean) - Make TSVs hollow with vacuum inside and thin metal boundary., default=False
participation_sheet_distance (Double) - Distance to non-model TLS interface sheet., default=0.0, unit=µm
participation_sheet_thickness (Double) - Thickness of non-model TLS interface sheet., default=0.0, unit=µm
metal_edge_region_dimensions (List) - Metal edge region is disabled if the list is empty. The terms in the list correspond to expansion dimensions into direction of gap, vacuum, metal, and substrate, respectively. The implementation uses the modulo operator in indexing, so one can set the list as [r] meaning that r is the expansion to all directions, or set as [r_lat, r_vert] to separate lateral and vertical expansions., default=[], unit=µm
tls_layer_thickness (List) - Thickness of TLS interface layers (MA, MS, and SA, respectively), default=[0.0], unit=µm
tls_layer_material (List) - Use None to create non-model layers. Otherwise, use only keywords introduced in material_dict., default=None
tls_sheet_approximation (Boolean) - Approximate TLS interface layers as sheets, default=False
minimum_point_spacing (Double) - Tolerance for merging adjacent points in polygon, default=0.01, unit=µm
polygon_tolerance (Double) - Tolerance for merging adjacent polygons in a layer, default=0.004, unit=µm
extra_json_data (None) - This field may be used to store ‘virtual’ parameters useful for your simulations, default=None