DelayedTimeStepper

DelayedTimeStepper(
    time_stepper: photonforge.TimeStepper,
    input_delay: Annotated[float, minimum=0, units='s'] = 0,
    output_delay: Annotated[float, minimum=0, units='s'] = 0,
) -> None

Time stepper that adds time delays to other time steppers.

Delays are quantized down to whole time steps. Delays shorter than one time step therefore have no effect. A delay within rounding (relative 1e-9) of a whole number of time steps counts as that number.

Args

• time_stepper: The time stepper to wrap with delays.
• input_delay: Default delay applied to the inputs.
• output_delay: Default delay applied to the outputs.

Methods

Method	Description
bind_native	Bind a compiled step function.
reset	Reset any internal state of the time stepper.
setup	Initialize the time stepper.
setup_state	Initialize internal buffers and set port-specific delays.
step	Compute the outputs of this time stepper, given inputs.
step_single	Take a single time step on the given inputs.
update	Update this time stepper.
write_verilog_a	Write this configured time stepper as one Verilog-A module.

bind_native

bind_native(self, step, keys, state=None, cstate=None, context=None)

Bind a compiled step function.

Instead of implementing step_single, a time stepper can hand the simulator the address of a C function with the signature:

int64 step(inputs, outputs, time_index, update_state, shutdown,
           context, state, cstate)

inputs and outputs are complex128 arrays with one entry per key, state and cstate are the float64 and complex128 arrays, and a nonzero return signals failure. The function must overwrite every element of outputs and only modify the state arrays when update_state is true. The arrays must not be reallocated after binding; reset restores them to the values given here, so a subclass overriding reset must call super().reset().

Calls with update_state false must give the same outputs: circuits may call the function several times in a time step, and setup checks this for steppers that declare path_delays. Random numbers must therefore come from a generator whose state lives in the arrays (e.g., a seed and a counter): output a draw kept there and draw the next one only when update_state is true, which also makes reset replay the stream. Do not use numpy.random in the function: numba draws it from a global stream that differs on every call and survives a reset.

The function can be compiled with numba (when available).

Args

• step (int | object): Address of the step function, or an object with an address attribute such as a numba cfunc.
• keys (Sequence[str]): Input/output keys.
• state (ndarray | None): Contiguous float64 array the function may use.
• cstate (ndarray | None): Contiguous complex128 array the function may use.
• context (int | None): Opaque pointer passed to the function.

Example

A two-port element that leaks the field entering its first port out of its second one:

>>> from numba import cfunc
>>> from photonforge.time_steppers import STEP_SIGNATURE
>>>
>>> @cfunc(STEP_SIGNATURE, cache=True)  # doctest: +SKIP
... def leaky_step(inputs, outputs, time_index, update_state,
...                shutdown, context, state, cstate):
...     # state[0]: decay per step
...     # cstate[0]: field leaving the second port
...     outputs[0] = 0j
...     outputs[1] = cstate[0] * state[0] + inputs[0]
...     if update_state:
...         cstate[0] = outputs[1]
...     return 0
...
>>> class LeakyTimeStepper(pf.TimeStepper):
...     def __init__(self, *, k=0.5):
...         super().__init__(k=k)
...
...     def setup_state(self, *, component, time_step, **kwargs):
...         keys = tuple(f"{p}@0" for p in sorted(component.ports))
...         state = numpy.array([
...             self.parametric_kwargs["k"] ** time_step
...         ])
...         self.bind_native(
...             leaky_step, keys, state, numpy.zeros(1, complex)
...         )
...
>>> pf.register_time_stepper_class(LeakyTimeStepper)

reset

reset(self) -> None

Reset any internal state of the time stepper.

The default implementation restores the arrays given to bind_native, if any, and performs no other action. Derived classes override it to reset the state they hold themselves.

setup

setup(
    self,
    component,
    time_step,
    *,
    carrier_frequency=0,
    show_progress=True,
    **kwargs,
)

Initialize the time stepper.

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 setup progress.
• **kwargs (object): Keyword args forwarded to setup_state.

Returns

TimeStepper: This time stepper.

setup_state

setup_state(
    self,
    *,
    time_step: float,
    input_delays: dict[
        str, typing.Annotated[float, minimum=0, units='s']
    ] = {},
    output_delays: dict[
        str, typing.Annotated[float, minimum=0, units='s']
    ] = {},
    **kwargs: object,
) -> object

Initialize internal buffers and set port-specific delays.

Args

• time_step: The interval between time steps (in seconds).
• input_delays: Mapping of port names to delays (in seconds) to override the default input delay.
• output_delays: Mapping of port names to delays (in seconds) to override the default output delay.
• kwargs: Unused.

step

step(self, inputs=None, steps=0, time_step=0, show_progress=True)

Compute the outputs of this time stepper, given inputs.

Args

• inputs (TimeSeries): Inputs to the time stepper.
• steps (int): The number of time steps to execute. If inputs is defined, this value is not used.
• time_step (float): The interval between time steps (in seconds). If inputs is a defined, this value is not used.
• show_progress (bool): If True, show computation progress.

Returns

TimeSeries: Computed outputs.

step_single

step_single(
    self,
    inputs: numpy.ndarray,
    outputs: numpy.ndarray,
    time_index: int,
    update_state: bool,
    shutdown: bool,
) -> None

Take a single time step on the given inputs.

Args

• inputs: Input values at the current time step. Must be a 1D array of complex values ordered according to keys.
• outputs: Pre-allocated output array where results will be stored. Same size and type as inputs.
• time_index: Time series index for the current input.
• update_state: Whether to update the internal stepper state.
• shutdown: Whether this is the last call to the single stepping function for the original TimeSeries.

update

update(self, *args, **kwargs)

Update this time stepper.

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

Args

• *args (object): Positional arguments to the parametric time stepper function.
• **kwargs (object): Keyword arguments to the parametric time stepper function.

Returns

TimeStepper: This time stepper.

Note

The original keyword arguments used to generate the time stepper 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.

write_verilog_a

write_verilog_a(
    self,
    path,
    *,
    backend='openvaf',
    port_convention='travelling_wave',
    module_name=None,
    z0=50.0,
    field_impedance=None,
)

Write this configured time stepper as one Verilog-A module.

The time stepper must first be configured with setup or Component.setup_time_stepper. The writer creates source only; it does not compile the model or create a simulator deck. Requires a PhotonForge Photonic Canvas license.

Args

• path (str | os.PathLike): Destination .va file.
• backend (Literal[“openvaf”, “spectre”]): Compiler capability target recorded in the source.
• port_convention (Literal[“travelling_wave”, “gf_45spclo_npe”]): External optical port convention. GF packed ports require the Spectre backend.
• module_name (str | None): Module identifier derived from path when omitted.
• z0 (float): Travelling-wave optical reference impedance.
• field_impedance (float | None): GF electric-field scaling.

Returns

pathlib.Path: Absolute destination path.

Properties

Property	Description
input_delay_steps	Input lines in time steps: this wrapper’s delays plus the wrapped stepper’s own.
keys	Tuple of input/output keys.
output_delay_steps	Output lines in time steps: this wrapper’s delays plus the wrapped stepper’s own.
path_delays	Minimum delay in time steps of each path through the wrapped stepper and its lines.

input_delay_steps

Input lines in time steps: this wrapper’s delays plus the wrapped stepper’s own.

keys

Tuple of input/output keys.

output_delay_steps

Output lines in time steps: this wrapper’s delays plus the wrapped stepper’s own.

path_delays

Minimum delay in time steps of each path through the wrapped stepper and its lines.

Attributes

Attribute	Description
parametric_function	str: Function used to update the time stepper.
parametric_kwargs	dict[str, object]: Keyword arguments used to update the time stepper.
properties	Properties: Object properties.
random_variables	list[RandomVariable]: Random variables associated to the time stepper’s parameters.

parametric_function

str: Function used to update the time stepper.

parametric_kwargs

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

properties

Properties: Object properties.

random_variables

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