tidy3d.components.geometry.Circular#

class tidy3d.components.geometry.Circular#

Geometry with circular characteristics (specified by a radius).

Parameters
  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • radius (NonNegativeFloat = None) – [units = um]. Radius of geometry.

Show JSON schema
{
   "title": "Circular",
   "description": "Geometry with circular characteristics (specified by a radius).\n\nParameters\n----------\ncenter : Tuple[float, float, float] = (0.0, 0.0, 0.0)\n    [units = um].  Center of object in x, y, and z.\nradius : NonNegativeFloat = None\n    [units = um].  Radius of geometry.",
   "type": "object",
   "properties": {
      "center": {
         "title": "Center",
         "description": "Center of object in x, y, and z.",
         "default": [
            0.0,
            0.0,
            0.0
         ],
         "units": "um",
         "type": "array",
         "minItems": 3,
         "maxItems": 3,
         "items": [
            {
               "type": "number"
            },
            {
               "type": "number"
            },
            {
               "type": "number"
            }
         ]
      },
      "type": {
         "title": "Type",
         "default": "Circular",
         "enum": [
            "Circular"
         ],
         "type": "string"
      },
      "radius": {
         "title": "Radius",
         "description": "Radius of geometry.",
         "units": "um",
         "minimum": 0,
         "type": "number"
      }
   },
   "required": [
      "radius"
   ],
   "additionalProperties": false
}

Fields
attribute radius: pydantic.types.NonNegativeFloat [Required]#

Radius of geometry.

Constraints
  • minimum = 0

Validated by
  • _radius_not_inf