tidy3d.FluxTimeMonitor#

class tidy3d.FluxTimeMonitor#

Monitor that records power flux through a plane in the time 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] = None) – [units = um]. Size in x, y, and z directions.

  • name (ConstrainedStrValue = None) – Unique name for monitor.

  • start (NonNegativeFloat = 0.0) – [units = sec]. Time at which to start monitor recording.

  • stop (Optional[NonNegativeFloat] = None) – [units = sec]. Time at which to stop monitor recording. If not specified, record until end of simulation.

  • interval (PositiveInt = 1) – Number of time step intervals between monitor recordings.

Example

>>> monitor = FluxTimeMonitor(
...     center=(1,2,3),
...     size=(2,2,0),
...     start=1e-13,
...     stop=5e-13,
...     interval=2,
...     name='flux_vs_time')

Show JSON schema
{
   "title": "FluxTimeMonitor",
   "description": ":class:`Monitor` that records power flux through a plane in the time 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] = None\n    [units = um].  Size in x, y, and z directions.\nname : ConstrainedStrValue = None\n    Unique name for monitor.\nstart : NonNegativeFloat = 0.0\n    [units = sec].  Time at which to start monitor recording.\nstop : Optional[NonNegativeFloat] = None\n    [units = sec].  Time at which to stop monitor recording.  If not specified, record until end of simulation.\ninterval : PositiveInt = 1\n    Number of time step intervals between monitor recordings.\n\nExample\n-------\n>>> monitor = FluxTimeMonitor(\n...     center=(1,2,3),\n...     size=(2,2,0),\n...     start=1e-13,\n...     stop=5e-13,\n...     interval=2,\n...     name='flux_vs_time')",
   "type": "object",
   "properties": {
      "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"
            }
         ]
      },
      "type": {
         "title": "Type",
         "default": "FluxTimeMonitor",
         "enum": [
            "FluxTimeMonitor"
         ],
         "type": "string"
      },
      "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"
      },
      "start": {
         "title": "Start time",
         "description": "Time at which to start monitor recording.",
         "default": 0.0,
         "units": "sec",
         "minimum": 0,
         "type": "number"
      },
      "stop": {
         "title": "Stop time",
         "description": "Time at which to stop monitor recording.  If not specified, record until end of simulation.",
         "units": "sec",
         "minimum": 0,
         "type": "number"
      },
      "interval": {
         "title": "Time interval",
         "description": "Number of time step intervals between monitor recordings.",
         "default": 1,
         "exclusiveMinimum": 0,
         "type": "integer"
      }
   },
   "required": [
      "size",
      "name"
   ],
   "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