tidy3d.FieldMonitor#

class tidy3d.FieldMonitor#

Monitor that records electromagnetic fields in the frequency domain.

Parameters

center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.
size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.
name (ConstrainedStrValue) – Unique name for monitor.
freqs (Union[Tuple[float, ...], Array]) – [units = Hz]. Array or list of frequencies stored by the field monitor.
fields (Tuple[Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz'], ...] = ['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']) – Collection of field components to store in the monitor.
interval_space (Tuple[PositiveInt, PositiveInt, PositiveInt] = (1, 1, 1)) – Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, fields will be downsampled and automatically colocated.
colocate (Optional[bool] = None) – Toggle whether fields should be colocated to grid cell centers. Default: False if interval_space is 1 in each direction, True if interval_space is greater than one in any direction.

Example

>>> monitor = FieldMonitor(
...     center=(1,2,3),
...     size=(2,2,2),
...     fields=['Hx'],
...     freqs=[250e12, 300e12],
...     name='steady_state_monitor')

Show JSON schema

{
   "title": "FieldMonitor",
   "description": ":class:`Monitor` that records electromagnetic fields in the frequency domain.\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n    [units = um].  Center of object in x, y, and z.\nsize : Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]\n    [units = um].  Size in x, y, and z directions.\nname : ConstrainedStrValue\n    Unique name for monitor.\nfreqs : Union[Tuple[float, ...], Array]\n    [units = Hz].  Array or list of frequencies stored by the field monitor.\nfields : Tuple[Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz'], ...] = ['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']\n    Collection of field components to store in the monitor.\ninterval_space : Tuple[PositiveInt, PositiveInt, PositiveInt] = (1, 1, 1)\n    Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, fields will be downsampled and automatically colocated.\ncolocate : Optional[bool] = None\n    Toggle whether fields should be colocated to grid cell centers. Default: ``False`` if ``interval_space`` is 1 in each direction, ``True`` if ``interval_space`` is greater than one in any direction.\n\nExample\n-------\n>>> monitor = FieldMonitor(\n...     center=(1,2,3),\n...     size=(2,2,2),\n...     fields=['Hx'],\n...     freqs=[250e12, 300e12],\n...     name='steady_state_monitor')",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "default": "FieldMonitor",
         "enum": [
            "FieldMonitor"
         ],
         "type": "string"
      },
      "center": {
         "title": "Center",
         "description": "Center of object in x, y, and z.",
         "default": [
            0.0,
            0.0,
            0.0
         ],
         "units": "um",
         "type": "array",
         "minItems": 3,
         "maxItems": 3,
         "items": [
            {
               "type": "number"
            },
            {
               "type": "number"
            },
            {
               "type": "number"
            }
         ]
      },
      "size": {
         "title": "Size",
         "description": "Size in x, y, and z directions.",
         "units": "um",
         "type": "array",
         "minItems": 3,
         "maxItems": 3,
         "items": [
            {
               "type": "number",
               "minimum": 0
            },
            {
               "type": "number",
               "minimum": 0
            },
            {
               "type": "number",
               "minimum": 0
            }
         ]
      },
      "name": {
         "title": "Name",
         "description": "Unique name for monitor.",
         "minLength": 1,
         "type": "string"
      },
      "freqs": {
         "title": "Frequencies",
         "description": "Array or list of frequencies stored by the field monitor.",
         "units": "Hz",
         "anyOf": [
            {
               "type": "array",
               "items": {
                  "type": "number"
               }
            },
            {
               "title": "Array Like",
               "description": "Accepts sequence (tuple, list, numpy array) and converts to tuple.",
               "type": "tuple",
               "properties": {},
               "required": []
            }
         ]
      },
      "fields": {
         "title": "Field Components",
         "description": "Collection of field components to store in the monitor.",
         "default": [
            "Ex",
            "Ey",
            "Ez",
            "Hx",
            "Hy",
            "Hz"
         ],
         "type": "array",
         "items": {
            "enum": [
               "Ex",
               "Ey",
               "Ez",
               "Hx",
               "Hy",
               "Hz"
            ],
            "type": "string"
         }
      },
      "interval_space": {
         "title": "Spatial interval",
         "description": "Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, fields will be downsampled and automatically colocated.",
         "default": [
            1,
            1,
            1
         ],
         "type": "array",
         "minItems": 3,
         "maxItems": 3,
         "items": [
            {
               "type": "integer",
               "exclusiveMinimum": 0
            },
            {
               "type": "integer",
               "exclusiveMinimum": 0
            },
            {
               "type": "integer",
               "exclusiveMinimum": 0
            }
         ]
      },
      "colocate": {
         "title": "Colocate fields",
         "description": "Toggle whether fields should be colocated to grid cell centers. Default: ``False`` if ``interval_space`` is 1 in each direction, ``True`` if ``interval_space`` is greater than one in any direction.",
         "type": "boolean"
      }
   },
   "required": [
      "size",
      "name",
      "freqs"
   ],
   "additionalProperties": false
}

Fields

storage_size(num_cells: int, tmesh: tidy3d.components.types.Array) → int#

Size of monitor storage given the number of points after discretization.

Parameters

num_cells (int) – Number of grid cells within the monitor after discretization by a Simulation.
tmesh (Array) – The discretized time mesh of a Simulation.

Returns

Number of bytes to be stored in monitor.

Return type

int

surfaces() → Tuple[tidy3d.components.monitor.FieldMonitor, ...]#

Returns a list of 6 monitors corresponding to each surface of the field monitor. The output monitors are stored in the order [x-, x+, y-, y+, z-, z+], where x, y, and z denote which axis is perpendicular to that surface, while “-” and “+” denote the direction of the normal vector of that surface. Each output monitor will have the same frequency/time data as the calling object. Its name will be that of the calling object appended with the above symbols. E.g., if the calling object’s name is “field”, the x+ monitor’s name will be “field_x+”. Does not work when the calling monitor has zero volume.

Returns: List of 6 surface monitors for each side of the field monitor.
Return type: Tuple[FieldMonitor, …]

Example

>>> volume_monitor = FieldMonitor(center=(0,0,0), size=(1,2,3), freqs=[2e14], name='field')
>>> surface_monitors = volume_monitor.surfaces()

Tidy3D Electromagnetic Solver

tidy3d.FieldMonitor

tidy3d.FieldMonitor#