{
  "title": "CustomAnisotropicMedium",
  "public_path": "flex_rf.tidy3d.CustomAnisotropicMedium",
  "lookup_path": "tidy3d.CustomAnisotropicMedium",
  "slug": "flex_rf/tidy3d/CustomAnisotropicMedium",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/customanisotropicmedium/",
  "object_kind": "class",
  "introduction": "Diagonally anisotropic medium with spatially varying permittivity in each component.",
  "notes": "Only diagonal anisotropy is currently supported.",
  "examples": "```python\nNx, Ny, Nz = 10, 9, 8\nx = np.linspace(-1, 1, Nx)\ny = np.linspace(-1, 1, Ny)\nz = np.linspace(-1, 1, Nz)\ncoords = dict(x=x, y=y, z=z)\npermittivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)\nconductivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)\nmedium_xx = CustomMedium(permittivity=permittivity, conductivity=conductivity)\nmedium_yy = CustomMedium(permittivity=permittivity, conductivity=conductivity)\nd_epsilon = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)\nf = SpatialDataArray(1+np.random.random((Nx, Ny, Nz)), coords=coords)\ndelta = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)\nmedium_zz = CustomLorentz(eps_inf=permittivity, coeffs=[(d_epsilon,f,delta),])\nanisotropic_dielectric = CustomAnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)\n```",
  "references": "",
  "signature": "class CustomAnisotropicMedium(AbstractCustomMedium, AnisotropicMedium)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/medium.py",
    "url": "",
    "lineno": 6634,
    "endlineno": 6816
  },
  "bases": [
    "AbstractCustomMedium",
    "AnisotropicMedium"
  ],
  "parameter_rows": [
    {
      "name": "xx",
      "annotation": "IsotropicCustomMediumType | CustomMedium",
      "default": "",
      "description": "Medium describing the xx-component of the diagonal permittivity tensor.",
      "origin": "declared"
    },
    {
      "name": "yy",
      "annotation": "IsotropicCustomMediumType | CustomMedium",
      "default": "",
      "description": "Medium describing the yy-component of the diagonal permittivity tensor.",
      "origin": "declared"
    },
    {
      "name": "zz",
      "annotation": "IsotropicCustomMediumType | CustomMedium",
      "default": "",
      "description": "Medium describing the zz-component of the diagonal permittivity tensor.",
      "origin": "declared"
    },
    {
      "name": "interp_method",
      "annotation": "InterpMethod | None",
      "default": "None",
      "description": "When the value is `None` each component will follow its own interpolation method. When the value is other than `None` the interpolation method specified by this field will override the one in each component.",
      "origin": "declared"
    },
    {
      "name": "allow_gain",
      "annotation": "bool | None",
      "default": "None",
      "description": "This field is ignored. Please set `allow_gain` in each component",
      "origin": "declared"
    },
    {
      "name": "subpixel",
      "annotation": "bool | None",
      "default": "None",
      "description": "This field is ignored. Please set `subpixel` in each component",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "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 an `attr` `obj.attrs['foo'] = bar`. Also note that Tidy3D will raise a `TypeError` if `attrs` contain objects that can not be serialized. One can check if `attrs` are serializable by calling `obj.model_dump_json()`.",
      "origin": "inherited"
    },
    {
      "name": "name",
      "annotation": "str | None",
      "default": "None",
      "description": "Optional unique name for medium.",
      "origin": "inherited"
    },
    {
      "name": "frequency_range",
      "annotation": "FreqBound | None",
      "default": "None",
      "description": "Optional range of validity for the medium.",
      "origin": "inherited"
    },
    {
      "name": "nonlinear_spec",
      "annotation": "NonlinearSpec | NonlinearSusceptibility | None",
      "default": "None",
      "description": "Nonlinear spec applied on top of the base medium properties.",
      "origin": "inherited"
    },
    {
      "name": "modulation_spec",
      "annotation": "ModulationSpec | None",
      "default": "None",
      "description": "Modulation spec applied on top of the base medium properties.",
      "origin": "inherited"
    },
    {
      "name": "viz_spec",
      "annotation": "VisualizationSpec | None",
      "default": "None",
      "description": "Plotting specification for visualizing medium.",
      "origin": "inherited"
    },
    {
      "name": "heat_spec",
      "annotation": "ThermalSpecType | None",
      "default": "None",
      "description": "DEPRECATED: Use `MultiPhysicsMedium`. Specification of the medium heat properties. They are used for solving the heat equation via the `HeatSimulation` interface. Such simulations can beused for investigating the influence of heat propagation on the properties of optical systems. Once the temperature distribution in the system is found using `HeatSimulation` object, `Simulation.perturbed_mediums_copy()` can be used to convert mediums with perturbation models defined into spatially dependent custom mediums. Otherwise, the `heat_spec` does not directly affect the running of an optical `Simulation`.",
      "origin": "inherited"
    },
    {
      "name": "derived_from",
      "annotation": "PerturbationMediumType | None",
      "default": "None",
      "description": "If not `None`, it records the parent medium from which this medium was derived.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "eps_dataarray_freq",
      "kind": "function",
      "signature": "eps_dataarray_freq(frequency: float)",
      "description": "Permittivity array at `frequency`."
    },
    {
      "name": "is_isotropic",
      "kind": "function",
      "signature": "is_isotropic()",
      "description": "Whether the medium is isotropic."
    },
    {
      "name": "is_spatially_uniform",
      "kind": "function",
      "signature": "is_spatially_uniform()",
      "description": "Whether the medium is spatially uniform."
    },
    {
      "name": "n_cfl",
      "kind": "function",
      "signature": "n_cfl()",
      "description": "This property computes the index of refraction related to CFL condition, so that the FDTD with this medium is stable when the time step size that doesn't take material factor into account is multiplied by `n_cfl`."
    }
  ],
  "group": "flex_rf.tidy3d"
}