tidy3d.components.medium.DispersiveMedium#

class tidy3d.components.medium.DispersiveMedium#

A Medium with dispersion (propagation characteristics depend on frequency)

Parameters
  • name (Optional[str] = None) – Optional unique name for medium.

  • frequency_range (Optional[Tuple[float, float]] = None) – [units = (Hz, Hz)]. Optional range of validity for the medium.

Show JSON schema
{
   "title": "DispersiveMedium",
   "description": "A Medium with dispersion (propagation characteristics depend on frequency)\n\nParameters\n----------\nname : Optional[str] = None\n    Optional unique name for medium.\nfrequency_range : Optional[Tuple[float, float]] = None\n    [units = (Hz, Hz)].  Optional range of validity for the medium.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "Optional unique name for medium.",
         "type": "string"
      },
      "frequency_range": {
         "title": "Frequency Range",
         "description": "Optional range of validity for the medium.",
         "units": [
            "Hz",
            "Hz"
         ],
         "type": "array",
         "minItems": 2,
         "maxItems": 2,
         "items": [
            {
               "type": "number"
            },
            {
               "type": "number"
            }
         ]
      },
      "type": {
         "title": "Type",
         "default": "DispersiveMedium",
         "enum": [
            "DispersiveMedium"
         ],
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields
attribute frequency_range: Tuple[float, float] = None#

Optional range of validity for the medium.

attribute name: str = None#

Optional unique name for medium.

Validated by
  • field_has_unique_names

static complex_to_tuple(value: complex) Tuple[float, float]#

Convert a complex number to a tuple of real and imaginary parts.

static tuple_to_complex(value: Tuple[float, float]) complex#

Convert a tuple of real and imaginary parts to complex number.

abstract property pole_residue#

Representation of Medium as a pole-residue model.