tidy3d.FluxTimeMonitor#
- class FluxTimeMonitor[source]#
Bases:
AbstractFluxMonitor
,TimeMonitor
Monitor
that records power flux in the time domain.- Parameters:
attrs (dict = {}) โ Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields,
attrs
are mutable. For example, the following is allowed for setting anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.json()
.center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) โ [units = um]. Center of object in x, y, and z.
size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) โ [units = um]. Size in x, y, and z directions.
name (ConstrainedStrValue) โ Unique name for monitor.
interval_space (Tuple[Literal[1], Literal[1], Literal[1]] = (1, 1, 1)) โ Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, the step will be applied, but the first and last point of the monitor grid are always included. Not all monitors support values different from 1.
colocate (Literal[True] = True) โ Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid) on-the-fly during a solver run. Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.
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 (Optional[PositiveInt] = None) โ Sampling rate of the monitor: number of time steps between each measurement. Set
interval
to 1 for the highest possible resolution in time. Higher integer values downsample the data by measuring everyinterval
time steps. This can be useful for reducing data storage as needed by the application.normal_dir (Optional[Literal['+', '-']] = None) โ Direction of the surface monitorโs normal vector w.r.t. the positive x, y or z unit vectors. Must be one of
'+'
or'-'
. Applies to surface monitors only, and defaults to'+'
if not provided.exclude_surfaces (Optional[Tuple[Literal['x-', 'x+', 'y-', 'y+', 'z-', 'z+'], ...]] = None) โ Surfaces to exclude in the integration, if a volume monitor.
Notes
If the monitor geometry is a 2D box, the total flux through this plane is returned, with a positive sign corresponding to power flow in the positive direction along the axis normal to the plane. If the geometry is a 3D box, the total power coming out of the box is returned by integrating the flux over all box surfaces (except the ones defined in
exclude_surfaces
).Example
>>> monitor = FluxTimeMonitor( ... center=(1,2,3), ... size=(2,2,0), ... start=1e-13, ... stop=5e-13, ... interval=2, ... name='flux_vs_time')
Attributes
Methods
storage_size
(num_cells,ย tmesh)Size of monitor storage given the number of points after discretization.
Inherited Common Usage
- storage_size(num_cells, tmesh)[source]#
Size of monitor storage given the number of points after discretization.
- __hash__()#
Hash method.