fdtdx.BrushConstraint2D

fdtdx.BrushConstraint2D#

class fdtdx.BrushConstraint2D(*, brush=null, axis=null, background_material=None)[source]#

Bases: ParameterTransformation

Applies 2D brush-based constraints to ensure minimum feature sizes.

Implements the brush-based constraint method described in: https://pubs.acs.org/doi/10.1021/acsphotonics.2c00313

This ensures minimum feature sizes and connectivity in 2D designs by using morphological operations with a brush kernel.

Quick Reference#

Attributes

Methods

Attributes#

BrushConstraint2D.axis: int#

Axis along which to apply the 2D constraint (perpendicular plane).

BrushConstraint2D.background_material: str | None#

Name of the background material in the material dictionary of the device. If None, the material with the lowest permittivity is used. Defaults to None.

BrushConstraint2D.brush: Array#

Array defining the brush kernel for morphological operations.

Methods#

BrushConstraint2D.aset(attr_name, val, create_new_ok=False)#

Sets an attribute of this class. In contrast to the classical .at[].set(), this method updates the class attribute directly and does not only operate on jax pytree leaf nodes. Instead, replaces the full attribute with the new value.

The attribute can either be the attribute name of this class, or for nested classes it can also be the attribute name of a class, which itself is an attribute of this class. The syntax for this operation could look like this: “a->b->[0]->[‘name’]”. Here, the current class has an attribute a, which has an attribute b, which is a list, which we index at index 0, which is an element of type dictionary, which we index using the dictionary key ‘name’.

Note that dictionary keys cannot contain square brackets or single quotes (even if they are escaped).

Parameters:

  • attr_name (str) – Name of attribute to set

  • val (Any) – Value to set the attribute to

  • create_new_ok (bool, optional) – If false (default), throw an error if the attribute does not exist. If true, creates a new attribute if the attribute name does not exist yet.

Returns:

Updated instance with new attribute value

Return type:

Self

BrushConstraint2D.get_class_fields()#
Return type:

list[TreeClassField]

BrushConstraint2D.get_input_shape(output_shape)#
Return type:

dict[str, tuple[int, ...]]

BrushConstraint2D.get_output_type(input_type)#
Return type:

dict[str, ParameterType]

BrushConstraint2D.get_public_fields()#
Return type:

list[TreeClassField]

BrushConstraint2D.init_module(config, materials, matrix_voxel_grid_shape, single_voxel_size, output_shape)#
Return type:

Self

BrushConstraint2D.init_type(input_type)#
Return type:

Self

If you find any errors in the documentation, please report them in the Github Issues!