DirectionalCouplerCircuitModel

DirectionalCouplerCircuitModel(
    *,
    coupling_region_model: photonforge.Model = Tidy3DModel(
        run_time=None,
        medium=None,
        symmetry=(0, 0, 0),
        boundary_spec=None,
        monitors=(),
        structures=(),
        grid_spec=None,
        shutoff=None,
        subpixel=None,
        courant=None,
        port_symmetries=(),
        bounds=((None, None, None), (None, None, None)),
        source_gap=None,
        simulation_updates=None,
        autograd_config=None,
        verbose=True,
    ),
    arms_model: photonforge.Model
    | dict[str, photonforge.Model] = Tidy3DModel(
        run_time=None,
        medium=None,
        symmetry=(0, 0, 0),
        boundary_spec=None,
        monitors=(),
        structures=(),
        grid_spec=None,
        shutoff=None,
        subpixel=None,
        courant=None,
        port_symmetries=(),
        bounds=((None, None, None), (None, None, None)),
        source_gap=None,
        simulation_updates=None,
        autograd_config=None,
        verbose=True,
    ),
    circuit_model: photonforge.Model = CircuitModel(
        mesh_refinement=None, verbose=True, port_map=None
    ),
) -> None

Model for directional couplers based on circuit decomposition.

The coupler is subdivided into 5 parts: the 4 arms and the coupling region. Each is simulated separately, and the final S parameters are computed by a CircuitModel.

The component geometry is expected to be composed of at least 2 paths connecting 2 ports each. The paths must start far apart, come close together in the coupling region, and separate again. The distance between paths is used to determine the extents of the arms and coupling region.

Args

• coupling_region_model: Model used to compute the S parameters in the coupling region.
• arms_model: Model used for the arms. A dictionary mapping port names to models can be used to set a specific models for each arm.
• circuit_model: Model used to merge all component parts.

Methods

Method	Description
autograd_smatrix	Compute an autograd-compatible S matrix for traced parameters.
estimate_cost	Estimate the cost for S matrix computation.
get_circuit	Build the circuit equivalent for a component.
s_matrix	Compute the S matrix for a component using this model.
setup_time_stepper	Obtain a time stepper for a component using this model.
start	Start computing the S matrix response from a component.
transform	Apply a transformation to this model.
update	Update this model.

autograd_smatrix

autograd_smatrix(
    self,
    *,
    component,
    traced_params,
    frequencies,
    component_for_params,
    param_names,
    show_progress=True,
    model_kwargs=None,
)

Compute an autograd-compatible S matrix for traced parameters.

Important

This is an abstract method that must be implemented by derived classes that support autograd-based S-matrix computation.

Args

• component (Component): Nominal component associated with this autograd evaluation.
• traced_params (ndarray): Traced parameter vector used by autograd.
• frequencies (Sequence[float]): Frequency values at which to calculate the scattering parameters (in Hz).
• component_for_params (Callable[[ndarray], Component]): Callback that returns the component for a given traced parameter vector.
• param_names (Sequence[str]): Flattened traced parameter names aligned with traced_params.
• show_progress (bool): Progress display hint from Component.s_matrix.
• model_kwargs (dict[str, Any] | None): Model-specific keyword arguments forwarded from Component.s_matrix.

Returns

AutogradSMatrix: Autograd-compatible S matrix.

estimate_cost

estimate_cost(self, *args, **kwargs)

Estimate the cost for S matrix computation.

All arguments are passed to the model’s start method with the addition of the keyword argument cost_estimation=True.

Returns

float: Cost estimation.

get_circuit

get_circuit(
    self,
    component: photonforge.Component,
    classification: Literal['optical', 'electrical'] = 'optical',
) -> photonforge.Component

Build the circuit equivalent for a component.

Args

• component: Component to subdivide into arms and coupling region.
• classification: Frequency classification to use.

Returns

Subdivided component.

s_matrix

s_matrix(self, component, frequencies, show_progress=True, model_kwargs={})

Compute the S matrix for a component using this model.

Args

• component (Component): Component to perform the calculation.
• frequencies (Sequence[float]): Frequency values at which to calculate the scattering parameters (in Hz).
• show_progress (bool): If True, show computation progress.
• model_kwargs (dict[str, object]): Keyword arguments passed to Model.start. Accepted arguments depend on the model type.

Returns

SMatrix: Computed S matrix.

Example

Compute only the responses from mode 0 of P0 with Tidy3D to reduce the number and cost of simulations:

>>> model = pf.Tidy3DModel()
>>> s_matrix = model.s_matrix(  # doctest: +SKIP
...     component,
...     frequencies,
...     model_kwargs={"inputs": ("P0@0",)},
... )

A port name such as ("P0",) selects all modes of that port. All outputs for the selected inputs are returned; responses from unselected inputs are not computed. Use Model.estimate_cost with the same inputs passed directly to estimate the reduced run.

setup_time_stepper

setup_time_stepper(
    self,
    component,
    time_step,
    carrier_frequency=0,
    show_progress=True,
    time_stepper_kwargs={},
)

Obtain a time stepper for a component using this model.

Args

• component (Component): Component for the time stepper.
• time_step (float): The interval between time steps (in seconds).
• carrier_frequency (float): The carrier frequency used to construct the time stepper. The carrier should be omitted from the input signals, as it is handled automatically by the time stepper.
• show_progress (bool): If True, show computation progress.
• time_stepper_kwargs (dict[str, object]): Keyword arguments passed to TimeStepper.setup. Each time stepper type can accept a different set of arguments. Check the documentation for the each time stepper’s setup_state method for more information.

Returns

TimeStepper: Initialized time stepper.

start

start(
    self,
    component: photonforge.Component,
    frequencies: collections.abc.Sequence[float],
    **kwargs: object,
) -> object

Start computing the S matrix response from a component.

Args

• component: Component from which to compute the S matrix.
• frequencies: Sequence of frequencies at which to perform the computation.
• **kwargs: Keyword arguments passed to sub-models.

Returns

Result object with attributes status and s_matrix.

transform

transform(
    self, translation=(0, 0), rotation=0, scaling=1, x_reflection=False
)

Apply a transformation to this model.

The base implementation is a no-op and returns self. Derived classes can override this method to transform model-specific geometry settings.

Args

• translation (Sequence[float] | complex): Translation vector.
• rotation (float): Rotation angle in degrees.
• scaling (float): Magnification factor.
• x_reflection (bool): Mirror across the horizontal axis.

Returns

Model: This object with transformations applied.

update

update(self, *args, **kwargs)

Update this model.

All contents of the model are updated with the contents from the updated version. object contents or modifications introduced after the model creation (outside of the original parametric function) are not propagated.

The model’s time stepper does not participate in the update, unless the __init__ method of the derived model class replaces it via set_time_stepper.

Args

• *args (object): Positional arguments to the parametric model.
• **kwargs (object): Keyword arguments to the parametric model.

Returns

Model: This model.

Note

The original keyword arguments used to generate the model are stored and updated with the passed kwargs. This updated version is used in the function call and will be stored for future updates. Positional arguments are not stored.

Attributes

Attribute	Description
parametric_function	str: Function used to update the model.
parametric_kwargs	dict[str, object]: Keyword arguments used to update the model.
properties	Properties: Object properties.
random_variables	list[RandomVariable]: Random variables associated to the model’s parameters.
time_stepper	TimeStepper | None: Time stepper associated with this model.

parametric_function

str: Function used to update the model.

parametric_kwargs

dict[str, object]: Keyword arguments used to update the model.

properties

Properties: Object properties.

random_variables

list[RandomVariable]: Random variables associated to the model’s parameters.

time_stepper

TimeStepper | None: Time stepper associated with this model.