GenericParams#

class simpleEMS.components.GenericParams(*, substrate_eps_r: float, substrate_tand: float, substrate_thickness_mm: float, substrate_cells: int = 7, unit: float = 0.001, num_points: int = 1000, backend_engine: str = 'FDTD', simulation_box: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None, FEM_num_solve_points: int = 10, FEM_max_solve_points: int | None = None, FEM_boundary: str = 'silver_muller', FEM_symmetry: tuple | None = None, FEM_fe_order: int = 1, FEM_air_pad_frac: float = 0.25, FEM_air_pad_mm: float | tuple | None = None, FEM_elems_per_wavelength: float = 16.0, FEM_mesh_freq: float | None = None, FEM_mesh_fine_scale: float = 1.0, FEM_min_layers: int = 3, FEM_port_type: str = 'lumpedport', FEM_port_mode_modes: int = 6, FEM_port_mode_index: int = 0, FEM_port_mode_zc: float | None = None, FEM_port_mode_eps_eff: float | None = None, FEM_waveport_width_mm: float | None = None, FEM_waveport_height_mm: float | None = None, FDTD_timestep: int = 90000000, FDTD_end_criteria: float = 0.0001, FDTD_mesh_resolution_factor: int = 10, FDTD_metal_mesh_resolution_factor: int = 40, copper_thickness_mm: float = 0.035, min_trace_width_mm: float = 0.1, min_trace_spacing_mm: float = 0.089, fp_precision: int = 3, charac_imp: float = 50, min_freq: float, max_freq: float, target_freq: float, substrate_width_mm: float, substrate_length_mm: float)#

Bases: SimParams

Generic parameters for arbitrary structures built with primitives.

Unlike the structure-specific subclasses (InsetFedPatchParams, MicrostripLineParams, etc.), this class lets the user provide substrate dimensions and frequency parameters directly, making it suitable for any geometry assembled from the primitives in GenericStructure.

Parameters:

min_freq (float) – Minimum frequency of the simulation range in Hz.
max_freq (float) – Maximum frequency of the simulation range in Hz.
target_freq (float) – Frequency the structure is designed for, in Hz. It sizes the mesh.
substrate_width_mm (float) – Substrate width in mm.
substrate_length_mm (float) – Substrate length in mm.

Attributes Summary

`FDTD_end_criteria`
`FDTD_mesh_resolution_factor`
`FDTD_metal_mesh_resolution_factor`
`FDTD_timestep`
`FEM_air_pad_frac`
`FEM_air_pad_mm`
`FEM_boundary`
`FEM_elems_per_wavelength`
`FEM_fe_order`
`FEM_max_solve_points`
`FEM_mesh_fine_scale`
`FEM_mesh_freq`
`FEM_min_layers`
`FEM_num_solve_points`
`FEM_port_mode_eps_eff`
`FEM_port_mode_index`
`FEM_port_mode_modes`
`FEM_port_mode_zc`
`FEM_port_type`
`FEM_symmetry`
`FEM_waveport_height_mm`
`FEM_waveport_width_mm`
`backend_engine`
`charac_imp`
`copper_thickness_mm`
`fem_options`	Bundle the flat `FEM_*` fields into a `FEMOptions` instance.
`fp_precision`
`freq_range`	Return the simulation frequency range.
`main_freq`	Return the primary frequency of interest.
`min_trace_spacing_mm`
`min_trace_width_mm`
`num_points`
`simulation_bounds`	Return `simulation_box` as per-axis `[min, max]` bounds.
`simulation_box`
`substrate_cells`
`unit`

Attributes Documentation

FDTD_end_criteria: float = 0.0001#

FDTD_mesh_resolution_factor: int = 10#

FDTD_metal_mesh_resolution_factor: int = 40#

FDTD_timestep: int = 90000000#

FEM_air_pad_frac: float = 0.25#

FEM_air_pad_mm: float | tuple | None = None#

FEM_boundary: str = 'silver_muller'#

FEM_elems_per_wavelength: float = 16.0#

FEM_fe_order: int = 1#

FEM_max_solve_points: int | None = None#

FEM_mesh_fine_scale: float = 1.0#

FEM_mesh_freq: float | None = None#

FEM_min_layers: int = 3#

FEM_num_solve_points: int = 10#

FEM_port_mode_eps_eff: float | None = None#

FEM_port_mode_index: int = 0#

FEM_port_mode_modes: int = 6#

FEM_port_mode_zc: float | None = None#

FEM_port_type: str = 'lumpedport'#

FEM_symmetry: tuple | None = None#

FEM_waveport_height_mm: float | None = None#

FEM_waveport_width_mm: float | None = None#

backend_engine: str = 'FDTD'#

charac_imp: float = 50#

copper_thickness_mm: float = 0.035#

fem_options#: Bundle the flat FEM_* fields into a FEMOptions instance.

fp_precision: int = 3#

freq_range#

Return the simulation frequency range.

Returns:: (min_freq, max_freq) in Hz.
Return type:: tuple[float, float]

main_freq#

Return the primary frequency of interest.

Returns:: target_freq in Hz.
Return type:: float

min_trace_spacing_mm: float = 0.089#

min_trace_width_mm: float = 0.1#

num_points: int = 1000#

simulation_bounds#

Return simulation_box as per-axis [min, max] bounds.

A (3,) box of sizes is centred on the origin.

Returns:: Array of shape (3, 2), [[xmin, xmax], [ymin, ymax], [zmin, zmax]] in mm, or None when no simulation box is defined.
Return type:: NDArray or None

simulation_box: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None#

substrate_cells: int = 7#

unit: float = 0.001#

GenericParams#

This Page