Class Simulation

python/simulation.py:1220–4982

The `Simulation` [class](#classes) contains all the attributes that you can set to control various parameters of the Meep computation.

class Simulation:
    """
    The `Simulation` [class](#classes) contains all the attributes that you can set to
    control various parameters of the Meep computation.
    """

    def __init__(
        self,
        cell_size: Vector3Type = None,
        resolution: float = None,
        geometry: Optional[List[GeometricObject]] = None,
        sources: Optional[List[Source]] = None,
        eps_averaging: bool = True,
        dimensions: int = 3,
        boundary_layers: Optional[List[PML]] = None,
        symmetries: Optional[List[Symmetry]] = None,
        force_complex_fields: bool = False,
        default_material: Medium = mp.Medium(),
        m: float = 0,
        bfast_scaled_k: Optional[Vector3Type] = None,
        k_point: Union[Vector3Type, bool] = False,
        kz_2d: str = "complex",
        extra_materials: Optional[List[Medium]] = None,
        material_function: Optional[Callable[[Vector3Type], Medium]] = None,
        epsilon_func: Optional[Callable[[Vector3Type], float]] = None,
        epsilon_input_file: str = "",
        progress_interval: float = 4,
        subpixel_tol: float = 1e-4,
        subpixel_maxeval: int = 100000,
        loop_tile_base_db: int = 0,
        loop_tile_base_eh: int = 0,
        ensure_periodicity: bool = True,
        num_chunks: int = 0,
        Courant: float = 0.5,
        accurate_fields_near_cylorigin: bool = False,
        filename_prefix: Optional[str] = None,
        output_volume: Optional[Volume] = None,
        output_single_precision: bool = False,
        geometry_center: Vector3Type = Vector3(),
        force_all_components: bool = False,
        split_chunks_evenly: bool = True,
        chunk_layout=None,
        collect_stats: bool = False,
    ):
        """
        All `Simulation` attributes are described in further detail below. In brackets
        after each variable is the type of value that it should hold. The classes, complex
        datatypes like `GeometricObject`, are described in a later subsection. The basic
        datatypes, like `integer`, `boolean`, `complex`, and `string` are defined by
        Python. `Vector3` is a `meep` class.

        + **`geometry` [ list of `GeometricObject` class ]** — Specifies the geometric
          objects making up the structure being simulated. When objects overlap, later
          objects in the list take precedence. Defaults to no objects (empty list).

        + **`geometry_center` [ `Vector3` class ]** — Specifies the coordinates of the
          center of the cell. Defaults to (0, 0, 0), but changing this allows you to shift
          the coordinate system used in Meep (for example, to put the origin at the