tidy3d.components.pml.AbsorberSpec#

class tidy3d.components.pml.AbsorberSpec#

Specifies the generic absorber properties along a single dimension.

Parameters
  • num_layers (NonNegativeInt = None) – Number of layers of standard PML to add to + and - boundaries.

  • parameters (AbsorberParams = None) – Parameters to fine tune the absorber profile and properties.

Show JSON schema
{
   "title": "AbsorberSpec",
   "description": "Specifies the generic absorber properties along a single dimension.\n\nParameters\n----------\nnum_layers : NonNegativeInt = None\n    Number of layers of standard PML to add to + and - boundaries.\nparameters : AbsorberParams = None\n    Parameters to fine tune the absorber profile and properties.",
   "type": "object",
   "properties": {
      "num_layers": {
         "title": "Number of Layers",
         "description": "Number of layers of standard PML to add to + and - boundaries.",
         "minimum": 0,
         "type": "integer"
      },
      "parameters": {
         "title": "Absorber Parameters",
         "description": "Parameters to fine tune the absorber profile and properties.",
         "allOf": [
            {
               "$ref": "#/definitions/AbsorberParams"
            }
         ]
      },
      "type": {
         "title": "Type",
         "default": "AbsorberSpec",
         "enum": [
            "AbsorberSpec"
         ],
         "type": "string"
      }
   },
   "required": [
      "num_layers",
      "parameters"
   ],
   "additionalProperties": false,
   "definitions": {
      "AbsorberParams": {
         "title": "AbsorberParams",
         "description": "Specifies parameters common to Absorbers and PMLs.\n\nParameters\n----------\nsigma_order : NonNegativeInt = 3\n    Order of the polynomial describing the absorber profile (~dist^sigma_order).\nsigma_min : NonNegativeFloat = 0.0\n    [units = 2*EPSILON_0/dt].  Minimum value of the absorber conductivity.\nsigma_max : NonNegativeFloat = 1.5\n    [units = 2*EPSILON_0/dt].  Maximum value of the absorber conductivity.\n\nExample\n-------\n>>> params = AbsorberParams(sigma_order=3, sigma_min=0.0, sigma_max=1.5)",
         "type": "object",
         "properties": {
            "sigma_order": {
               "title": "Sigma Order",
               "description": "Order of the polynomial describing the absorber profile (~dist^sigma_order).",
               "default": 3,
               "minimum": 0,
               "type": "integer"
            },
            "sigma_min": {
               "title": "Sigma Minimum",
               "description": "Minimum value of the absorber conductivity.",
               "default": 0.0,
               "units": "2*EPSILON_0/dt",
               "minimum": 0,
               "type": "number"
            },
            "sigma_max": {
               "title": "Sigma Maximum",
               "description": "Maximum value of the absorber conductivity.",
               "default": 1.5,
               "units": "2*EPSILON_0/dt",
               "minimum": 0,
               "type": "number"
            },
            "type": {
               "title": "Type",
               "default": "AbsorberParams",
               "enum": [
                  "AbsorberParams"
               ],
               "type": "string"
            }
         },
         "additionalProperties": false
      }
   }
}

Fields
attribute num_layers: pydantic.types.NonNegativeInt [Required]#

Number of layers of standard PML to add to + and - boundaries.

Constraints
  • minimum = 0

attribute parameters: tidy3d.components.pml.AbsorberParams [Required]#

Parameters to fine tune the absorber profile and properties.