fdtdx.PeriodicBoundary
======================

.. currentmodule:: fdtdx

.. autoclass:: PeriodicBoundary
   :show-inheritance:

Quick Reference
---------------



.. rubric:: Attributes





* :attr:`~PeriodicBoundary.axis`



* :attr:`~PeriodicBoundary.bloch_vector`



* :attr:`~PeriodicBoundary.boundary_slice`



* :attr:`~PeriodicBoundary.color`



* :attr:`~PeriodicBoundary.descriptive_name`



* :attr:`~PeriodicBoundary.direction`



* :attr:`~PeriodicBoundary.grid_shape`



* :attr:`~PeriodicBoundary.grid_slice`



* :attr:`~PeriodicBoundary.grid_slice_tuple`



* :attr:`~PeriodicBoundary.max_random_grid_offsets`



* :attr:`~PeriodicBoundary.max_random_real_offsets`



* :attr:`~PeriodicBoundary.name`



* :attr:`~PeriodicBoundary.needs_complex_fields`



* :attr:`~PeriodicBoundary.opposite_slice`



* :attr:`~PeriodicBoundary.partial_grid_shape`



* :attr:`~PeriodicBoundary.partial_real_position`



* :attr:`~PeriodicBoundary.partial_real_shape`



* :attr:`~PeriodicBoundary.real_shape`



* :attr:`~PeriodicBoundary.thickness`



* :attr:`~PeriodicBoundary.uses_wrap_padding`






.. rubric:: Methods





* :attr:`~PeriodicBoundary.apply`



* :attr:`~PeriodicBoundary.apply_field_reset`



* :attr:`~PeriodicBoundary.apply_pad_correction`



* :attr:`~PeriodicBoundary.apply_post_E_update`



* :attr:`~PeriodicBoundary.apply_post_H_update`



* :attr:`~PeriodicBoundary.aset`



* :attr:`~PeriodicBoundary.check_overlap`



* :attr:`~PeriodicBoundary.extend_to`



* :attr:`~PeriodicBoundary.face_to_face_negative_direction`



* :attr:`~PeriodicBoundary.face_to_face_positive_direction`



* :attr:`~PeriodicBoundary.get_bloch_phase`



* :attr:`~PeriodicBoundary.get_class_fields`



* :attr:`~PeriodicBoundary.get_public_fields`



* :attr:`~PeriodicBoundary.interface_grid_shape`



* :attr:`~PeriodicBoundary.interface_slice`



* :attr:`~PeriodicBoundary.interface_slice_tuple`



* :attr:`~PeriodicBoundary.place_above`



* :attr:`~PeriodicBoundary.place_at_center`



* :attr:`~PeriodicBoundary.place_below`



* :attr:`~PeriodicBoundary.place_on_grid`



* :attr:`~PeriodicBoundary.place_relative_to`



* :attr:`~PeriodicBoundary.same_position`



* :attr:`~PeriodicBoundary.same_position_and_size`



* :attr:`~PeriodicBoundary.same_size`



* :attr:`~PeriodicBoundary.set_grid_coordinates`



* :attr:`~PeriodicBoundary.size_relative_to`







Attributes
==========





.. autoattribute:: PeriodicBoundary.axis



.. autoattribute:: PeriodicBoundary.bloch_vector



.. autoattribute:: PeriodicBoundary.boundary_slice



.. autoattribute:: PeriodicBoundary.color



.. autoattribute:: PeriodicBoundary.descriptive_name



.. autoattribute:: PeriodicBoundary.direction



.. autoattribute:: PeriodicBoundary.grid_shape



.. autoattribute:: PeriodicBoundary.grid_slice



.. autoattribute:: PeriodicBoundary.grid_slice_tuple



.. autoattribute:: PeriodicBoundary.max_random_grid_offsets



.. autoattribute:: PeriodicBoundary.max_random_real_offsets



.. autoattribute:: PeriodicBoundary.name



.. autoattribute:: PeriodicBoundary.needs_complex_fields



.. autoattribute:: PeriodicBoundary.opposite_slice



.. autoattribute:: PeriodicBoundary.partial_grid_shape



.. autoattribute:: PeriodicBoundary.partial_real_position



.. autoattribute:: PeriodicBoundary.partial_real_shape



.. autoattribute:: PeriodicBoundary.real_shape



.. autoattribute:: PeriodicBoundary.thickness



.. autoattribute:: PeriodicBoundary.uses_wrap_padding








Methods
==========








.. automethod:: PeriodicBoundary.apply





.. automethod:: PeriodicBoundary.apply_field_reset





.. automethod:: PeriodicBoundary.apply_pad_correction





.. automethod:: PeriodicBoundary.apply_post_E_update





.. automethod:: PeriodicBoundary.apply_post_H_update





.. automethod:: PeriodicBoundary.aset





.. automethod:: PeriodicBoundary.check_overlap





.. automethod:: PeriodicBoundary.extend_to





.. automethod:: PeriodicBoundary.face_to_face_negative_direction





.. automethod:: PeriodicBoundary.face_to_face_positive_direction





.. automethod:: PeriodicBoundary.get_bloch_phase





.. automethod:: PeriodicBoundary.get_class_fields





.. automethod:: PeriodicBoundary.get_public_fields





.. automethod:: PeriodicBoundary.interface_grid_shape





.. automethod:: PeriodicBoundary.interface_slice





.. automethod:: PeriodicBoundary.interface_slice_tuple





.. automethod:: PeriodicBoundary.place_above





.. automethod:: PeriodicBoundary.place_at_center





.. automethod:: PeriodicBoundary.place_below





.. automethod:: PeriodicBoundary.place_on_grid





.. automethod:: PeriodicBoundary.place_relative_to





.. automethod:: PeriodicBoundary.same_position





.. automethod:: PeriodicBoundary.same_position_and_size





.. automethod:: PeriodicBoundary.same_size





.. automethod:: PeriodicBoundary.set_grid_coordinates





.. automethod:: PeriodicBoundary.size_relative_to






If you find any errors in the documentation, please report them in the `Github Issues <https://github.com/ymahlau/fdtdx/issues>`_!