tidy3d.AbsorberParams
tidy3d.AbsorberParams#
- class tidy3d.AbsorberParams#
Specifies parameters common to Absorbers and PMLs.
- Parameters
sigma_order (NonNegativeInt = 3) – Order of the polynomial describing the absorber profile (~dist^sigma_order).
sigma_min (NonNegativeFloat = 0.0) – [units = 2*EPSILON_0/dt]. Minimum value of the absorber conductivity.
sigma_max (NonNegativeFloat = 1.5) – [units = 2*EPSILON_0/dt]. Maximum value of the absorber conductivity.
Example
>>> params = AbsorberParams(sigma_order=3, sigma_min=0.0, sigma_max=1.5)
Show JSON schema
{ "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 }
- attribute sigma_max: pydantic.types.NonNegativeFloat = 1.5#
Maximum value of the absorber conductivity.
- Constraints
minimum = 0
- attribute sigma_min: pydantic.types.NonNegativeFloat = 0.0#
Minimum value of the absorber conductivity.
- Constraints
minimum = 0
- attribute sigma_order: pydantic.types.NonNegativeInt = 3#
Order of the polynomial describing the absorber profile (~dist^sigma_order).
- Constraints
minimum = 0