API reference¶

Import as import bifrost as bf. For Component, cells, routing and PDKs see the gdsfactory API reference.

Name	What it is
`bf.StackDevice`	a component and its layer stack as one fdtdx object; places sources and monitors on ports
`bf.StackOptions`	the geometry options that trade accuracy for time
`bf.TopRoughness`	a random rough top surface for one level
`bf.apply_stack`	writes the stacks into the permittivity arrays, in place of `fdtdx.apply_params`
`bf.init_stack_params`	the stacks' differentiable parameters (vertices, heights, thicknesses)
`bf.StackDiagnosticWarning`	the warning for features the grid does not resolve
`bf.graded_edges`	cell edges of a graded axis, for `StackDevice.rectilinear_grid`
`bf.jit`	`jax.jit` with the XLA option gradients through fdtdx's time loop need
`bf.compiler_options`	those options merged with your own, for another jit wrapper
`bf.record_timings`	times the geometry steps
`bf.view`	the 3D viewer widget for a `StackDevice`