{
  "title": "AbstractComponentModeler",
  "public_path": "flex_rf.tidy3d.AbstractComponentModeler",
  "lookup_path": "tidy3d.rf.AbstractComponentModeler",
  "slug": "flex_rf/tidy3d/AbstractComponentModeler",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/abstractcomponentmodeler/",
  "object_kind": "class",
  "introduction": "Tool for modeling devices and computing port parameters.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class AbstractComponentModeler(ABC, Tidy3dBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/plugins/smatrix/component_modelers/base.py",
    "url": "",
    "lineno": 49,
    "endlineno": 387
  },
  "bases": [
    "ABC",
    "Tidy3dBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "name",
      "annotation": "str",
      "default": "''",
      "description": "",
      "origin": "declared"
    },
    {
      "name": "simulation",
      "annotation": "Simulation",
      "default": "",
      "description": "Simulation describing the device without any sources present.",
      "origin": "declared"
    },
    {
      "name": "ports",
      "annotation": "tuple[Port | TerminalPortType, ...]",
      "default": "()",
      "description": "Collection of ports describing the scattering matrix elements. For each input mode, one simulation will be run with a modal source.",
      "origin": "declared"
    },
    {
      "name": "freqs",
      "annotation": "FreqArray",
      "default": "",
      "description": "Array or list of frequencies at which to compute port parameters.",
      "origin": "declared"
    },
    {
      "name": "remove_dc_component",
      "annotation": "bool",
      "default": "True",
      "description": "Whether to remove the DC component in the Gaussian pulse spectrum. If `True`, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to `False` results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.",
      "origin": "declared"
    },
    {
      "name": "run_only",
      "annotation": "tuple[IndexType, ...] | None",
      "default": "None",
      "description": "Set of matrix indices that define the simulations to run. If `None`, simulations will be run for all indices in the scattering matrix. If a tuple is given, simulations will be run only for the given matrix indices.",
      "origin": "declared"
    },
    {
      "name": "element_mappings",
      "annotation": "tuple[tuple[ElementType, ElementType, Complex], ...]",
      "default": "()",
      "description": "Tuple of S matrix element mappings, each described by a tuple of (input_element, output_element, coefficient), where the coefficient is the element_mapping coefficient describing the relationship between the input and output matrix element. If all elements of a given column of the scattering matrix are defined by `element_mappings`, the simulation corresponding to this column is skipped automatically.",
      "origin": "declared"
    },
    {
      "name": "custom_source_time",
      "annotation": "SourceTimeType | None",
      "default": "None",
      "description": "If provided, this will be used as specification of the source time-dependence in simulations. Otherwise, a default source time will be constructed.",
      "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"
    }
  ],
  "members": [
    {
      "name": "get_port_by_name",
      "kind": "function",
      "signature": "get_port_by_name(port_name: str)",
      "description": "Get the port from the name."
    },
    {
      "name": "get_task_name",
      "kind": "function",
      "signature": "get_task_name(port: PortType, mode_index: int | None = None, terminal_label: str | None = None)",
      "description": "Generates a standardized task name from a port object."
    },
    {
      "name": "matrix_indices_monitor",
      "kind": "attribute",
      "signature": "matrix_indices_monitor: tuple[IndexType, ...]",
      "description": "Abstract property for all matrix indices that will be used to collect data."
    },
    {
      "name": "matrix_indices_run_sim",
      "kind": "function",
      "signature": "matrix_indices_run_sim()",
      "description": "Tuple of all the matrix indices that will be used to run simulations."
    },
    {
      "name": "matrix_indices_source",
      "kind": "function",
      "signature": "matrix_indices_source()",
      "description": "Tuple of all the source matrix indices, which may be less than the total number of ports."
    },
    {
      "name": "run",
      "kind": "function",
      "signature": "run(path_dir: str = DEFAULT_DATA_DIR, *, folder_name: str = 'default', callback_url: str | None = None, verbose: bool = True, solver_version: str | None = None, pay_type: PayType | str = 'AUTO', priority: int | None = None, local_gradient: bool = False, max_num_adjoint_per_fwd: int | None = None)",
      "description": ""
    },
    {
      "name": "unique_port_names",
      "kind": "attribute",
      "signature": "unique_port_names",
      "description": ""
    },
    {
      "name": "validate_pre_upload",
      "kind": "function",
      "signature": "validate_pre_upload()",
      "description": "Validate the modeler before upload."
    }
  ],
  "group": "flex_rf.tidy3d"
}