MediumMonitor to return both permittivity and permeability profiles

Author: weiliangjin2021

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-
+- New `MediumMonitor` that returns both permittivity and permeability profiles.
 ### Changed
 
 ### Fixed

docs/api/monitors.rst

@@ -16,7 +16,8 @@ The types of monitors in Tidy3D include:
 * `Mode`_: Records mode coefficient(s) of the field across a 2D plane
 * `Diffraction`_: Records diffraction coefficient(s) in a periodic simulation
 * `Far-field`_: Various monitors for calculating far-field projection and radiation characteristics
-* `Permittivity`_: Records material properties within a given region
+* `Permittivity`_: Records material permittivity properties within a given region
+* `Medium`_: Records material permittivity and permeability properties within a given region
 
 .. seealso::
 
@@ -255,16 +256,17 @@ Please see the learning center article below for detailed explanations on additi
 
 ~~~~
 
-Permittivity
-------------
+Permittivity and Permeability
+-----------------------------
 
 .. autosummary::
    :toctree: _autosummary/
    :template: module.rst
 
    tidy3d.PermittivityMonitor
+   tidy3d.MediumMonitor
 
-The ``PermittivityMonitor`` is used to record local relative permittivity data in the region of interest. This data can be useful for post-simulation calculations that require permittivity values, such as mode volume and absorption density.
+The ``PermittivityMonitor`` is used to record local relative permittivity data in the region of interest, and the ``MediumMonitor`` can additionally record permeability data. Those data can be useful for post-simulation calculations that require permittivity or permeability values, such as mode volume and absorption density.
 
 .. code-block:: python
 

schemas/EMESimulation.json

@@ -6822,6 +6822,186 @@
       ],
       "type": "object"
     },
+    "MediumMonitor": {
+      "additionalProperties": false,
+      "properties": {
+        "apodization": {
+          "allOf": [
+            {
+              "$ref": "#/definitions/ApodizationSpec"
+            }
+          ],
+          "default": {
+            "attrs": {},
+            "end": null,
+            "start": null,
+            "type": "ApodizationSpec",
+            "width": null
+          }
+        },
+        "attrs": {
+          "default": {},
+          "type": "object"
+        },
+        "center": {
+          "anyOf": [
+            {
+              "items": [
+                {
+                  "anyOf": [
+                    {
+                      "type": "autograd.tracer.Box"
+                    },
+                    {
+                      "type": "number"
+                    }
+                  ]
+                },
+                {
+                  "anyOf": [
+                    {
+                      "type": "autograd.tracer.Box"
+                    },
+                    {
+                      "type": "number"
+                    }
+                  ]
+                },
+                {
+                  "anyOf": [
+                    {
+                      "type": "autograd.tracer.Box"
+                    },
+                    {
+                      "type": "number"
+                    }
+                  ]
+                }
+              ],
+              "maxItems": 3,
+              "minItems": 3,
+              "type": "array"
+            },
+            {
+              "type": "autograd.tracer.Box"
+            }
+          ],
+          "default": [
+            0.0,
+            0.0,
+            0.0
+          ]
+        },
+        "colocate": {
+          "default": false,
+          "enum": [
+            false
+          ],
+          "type": "boolean"
+        },
+        "freqs": {
+          "anyOf": [
+            {
+              "items": {
+                "type": "number"
+              },
+              "type": "array"
+            },
+            {
+              "type": "ArrayLike"
+            }
+          ]
+        },
+        "interval_space": {
+          "default": [
+            1,
+            1,
+            1
+          ],
+          "items": [
+            {
+              "exclusiveMinimum": 0,
+              "type": "integer"
+            },
+            {
+              "exclusiveMinimum": 0,
+              "type": "integer"
+            },
+            {
+              "exclusiveMinimum": 0,
+              "type": "integer"
+            }
+          ],
+          "maxItems": 3,
+          "minItems": 3,
+          "type": "array"
+        },
+        "name": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "size": {
+          "anyOf": [
+            {
+              "items": [
+                {
+                  "anyOf": [
+                    {
+                      "minimum": 0,
+                      "type": "number"
+                    },
+                    {
+                      "type": "autograd.tracer.Box"
+                    }
+                  ]
+                },
+                {
+                  "anyOf": [
+                    {
+                      "minimum": 0,
+                      "type": "number"
+                    },
+                    {
+                      "type": "autograd.tracer.Box"
+                    }
+                  ]
+                },
+                {
+                  "anyOf": [
+                    {
+                      "minimum": 0,
+                      "type": "number"
+                    },
+                    {
+                      "type": "autograd.tracer.Box"
+                    }
+                  ]
+                }
+              ],
+              "maxItems": 3,
+              "minItems": 3,
+              "type": "array"
+            },
+            {
+              "type": "autograd.tracer.Box"
+            }
+          ]
+        },
+        "type": {
+          "default": "MediumMonitor",
+          "enum": [
+            "MediumMonitor"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "freqs",
+        "name",
+        "size"
+      ],
+      "type": "object"
+    },
     "MeshOverrideStructure": {
       "additionalProperties": false,
       "properties": {
@@ -11209,6 +11389,7 @@
             "EMECoefficientMonitor": "#/definitions/EMECoefficientMonitor",
             "EMEFieldMonitor": "#/definitions/EMEFieldMonitor",
             "EMEModeSolverMonitor": "#/definitions/EMEModeSolverMonitor",
+            "MediumMonitor": "#/definitions/MediumMonitor",
             "ModeSolverMonitor": "#/definitions/ModeSolverMonitor",
             "PermittivityMonitor": "#/definitions/PermittivityMonitor"
           },
@@ -11224,6 +11405,9 @@
           {
             "$ref": "#/definitions/EMEModeSolverMonitor"
           },
+          {
+            "$ref": "#/definitions/MediumMonitor"
+          },
           {
             "$ref": "#/definitions/ModeSolverMonitor"
           },