Method get_array

python/simulation.py:3892–4011

Returns a slice of the materials or time-domain fields over a subregion of the cell at the current simulation time as a NumPy array. The materials/fields are centered on the Yee-grid voxels using a bilinear interpolation of the nearest Yee-grid points. + **`componen

(
        self,
        component: int = None,
        vol: Volume = None,
        center: Vector3Type = None,
        size: Vector3Type = None,
        cmplx: bool = None,
        arr: Optional[np.ndarray] = None,
        frequency: float = 0,
        snap: bool = False,
    )

        return convert_h5(rm_h5, cmd, *step_funcs)

    def get_array(
        self,
        component: int = None,
        vol: Volume = None,
        center: Vector3Type = None,
        size: Vector3Type = None,
        cmplx: bool = None,
        arr: Optional[np.ndarray] = None,
        frequency: float = 0,
        snap: bool = False,
    ):
        """
        Returns a slice of the materials or time-domain fields over a subregion of the cell at the
        current simulation time as a NumPy array. The materials/fields are centered on the Yee-grid voxels
        using a bilinear interpolation of the nearest Yee-grid points.

        + **`component` [ `component` constant ]** — The field or material component (e.g., `meep.Ex`,
          `meep.Hy`, `meep.Sz`, `meep.Dielectric`, etc) of the array data. No default.

        + **`vol` [ `Volume` ]** — The rectilinear subregion/slice of the cell volume.
          The return value of `get_array` has the same dimensions as the `Volume`'s `size`
          attribute. If `None` (default), then a `size` and `center` must be specified.

        + **`center`, `size` [ `Vector3` ]** — If both are specified, the method will construct
          an appropriate `Volume`. This is a convenience feature and alternative to
          supplying a `Volume`.

        + **`cmplx` [ `boolean` ]** — If `True`, return complex-valued data otherwise return
          real-valued data (default).

        + **`arr` [ `numpy.ndarray` ]** — Optional parameter to pass a pre-allocated NumPy array of the correct size and
          type (either `numpy.float32` or `numpy.float64` depending on the [floating-point precision
          of the fields and materials](Build_From_Source.md#floating-point-precision-of-the-fields-and-materials-arrays))
          which will be overwritten with the field/material data instead of allocating a
          new array.  Normally, this will be the array returned from a previous call to
          `get_array` for a similar slice, allowing one to re-use `arr` (e.g., when
          fetching the same slice repeatedly at different times).

        + **`frequency` [ `number` ]** — The frequency at which the average eigenvalue of the
          $\\varepsilon$ and $\\mu$ tensors are evaluated. Defaults to 0 which is the
          instantaneous $\\varepsilon$.

        + **`snap` [ `boolean` ]** — Empty dimensions of the grid slice are "collapsed"
          into a single element. However, if `snap` is set to `True`, this
          interpolation behavior is disabled and the grid slice is instead "snapped"
          everywhere to the nearest grid point. (Empty slice dimensions are still of size
          one.) This feature is mainly useful for comparing results with the
          [`output_` routines](#output-functions) (e.g., `output_epsilon`, `output_efield_z`, etc.).

        For convenience, the following wrappers for `get_array` over the entire cell are
        available: `get_epsilon()`, `get_mu()`, `get_hpwr()`, `get_dpwr()`,
        `get_tot_pwr()`, `get_Xfield()`, `get_Xfield_x()`, `get_Xfield_y()`,
        `get_Xfield_z()`, `get_Xfield_r()`, `get_Xfield_p()` where `X` is one of `h`, `b`,
        `e`, `d`, or `s`. The routines `get_Xfield_*` all return an array type consistent
        with the fields (real or complex). The routines `get_epsilon()` and `get_mu()`
        accept the optional argument `frequency` (defaults to 0) and all routines accept
        `snap` (defaults to `False`).