fdtdx.BlochBoundary
===================

.. currentmodule:: fdtdx

.. autoclass:: BlochBoundary
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~BlochBoundary.axis`



* :attr:`~BlochBoundary.bloch_vector`



* :attr:`~BlochBoundary.boundary_slice`



* :attr:`~BlochBoundary.color`



* :attr:`~BlochBoundary.descriptive_name`



* :attr:`~BlochBoundary.direction`



* :attr:`~BlochBoundary.grid_shape`



* :attr:`~BlochBoundary.grid_slice`



* :attr:`~BlochBoundary.grid_slice_tuple`



* :attr:`~BlochBoundary.max_random_grid_offsets`



* :attr:`~BlochBoundary.max_random_real_offsets`



* :attr:`~BlochBoundary.name`



* :attr:`~BlochBoundary.needs_complex_fields`



* :attr:`~BlochBoundary.opposite_slice`



* :attr:`~BlochBoundary.partial_grid_shape`



* :attr:`~BlochBoundary.partial_real_position`



* :attr:`~BlochBoundary.partial_real_shape`



* :attr:`~BlochBoundary.real_shape`



* :attr:`~BlochBoundary.thickness`



* :attr:`~BlochBoundary.uses_wrap_padding`






.. rubric:: Methods





* :attr:`~BlochBoundary.apply`



* :attr:`~BlochBoundary.apply_field_reset`



* :attr:`~BlochBoundary.apply_pad_correction`



* :attr:`~BlochBoundary.apply_post_E_update`



* :attr:`~BlochBoundary.apply_post_H_update`



* :attr:`~BlochBoundary.aset`



* :attr:`~BlochBoundary.check_overlap`



* :attr:`~BlochBoundary.extend_to`



* :attr:`~BlochBoundary.face_to_face_negative_direction`



* :attr:`~BlochBoundary.face_to_face_positive_direction`



* :attr:`~BlochBoundary.get_bloch_phase`



* :attr:`~BlochBoundary.get_class_fields`



* :attr:`~BlochBoundary.get_public_fields`



* :attr:`~BlochBoundary.interface_grid_shape`



* :attr:`~BlochBoundary.interface_slice`



* :attr:`~BlochBoundary.interface_slice_tuple`



* :attr:`~BlochBoundary.place_above`



* :attr:`~BlochBoundary.place_at_center`



* :attr:`~BlochBoundary.place_below`



* :attr:`~BlochBoundary.place_on_grid`



* :attr:`~BlochBoundary.place_relative_to`



* :attr:`~BlochBoundary.same_position`



* :attr:`~BlochBoundary.same_position_and_size`



* :attr:`~BlochBoundary.same_size`



* :attr:`~BlochBoundary.set_grid_coordinates`



* :attr:`~BlochBoundary.size_relative_to`



* :attr:`~BlochBoundary.validate_placement`







Attributes
==========





.. autoattribute:: BlochBoundary.axis



.. autoattribute:: BlochBoundary.bloch_vector



.. autoattribute:: BlochBoundary.boundary_slice



.. autoattribute:: BlochBoundary.color



.. autoattribute:: BlochBoundary.descriptive_name



.. autoattribute:: BlochBoundary.direction



.. autoattribute:: BlochBoundary.grid_shape



.. autoattribute:: BlochBoundary.grid_slice



.. autoattribute:: BlochBoundary.grid_slice_tuple



.. autoattribute:: BlochBoundary.max_random_grid_offsets



.. autoattribute:: BlochBoundary.max_random_real_offsets



.. autoattribute:: BlochBoundary.name



.. autoattribute:: BlochBoundary.needs_complex_fields



.. autoattribute:: BlochBoundary.opposite_slice



.. autoattribute:: BlochBoundary.partial_grid_shape



.. autoattribute:: BlochBoundary.partial_real_position



.. autoattribute:: BlochBoundary.partial_real_shape



.. autoattribute:: BlochBoundary.real_shape



.. autoattribute:: BlochBoundary.thickness



.. autoattribute:: BlochBoundary.uses_wrap_padding








Methods
==========








.. automethod:: BlochBoundary.apply





.. automethod:: BlochBoundary.apply_field_reset





.. automethod:: BlochBoundary.apply_pad_correction





.. automethod:: BlochBoundary.apply_post_E_update





.. automethod:: BlochBoundary.apply_post_H_update





.. automethod:: BlochBoundary.aset





.. automethod:: BlochBoundary.check_overlap





.. automethod:: BlochBoundary.extend_to





.. automethod:: BlochBoundary.face_to_face_negative_direction





.. automethod:: BlochBoundary.face_to_face_positive_direction





.. automethod:: BlochBoundary.get_bloch_phase





.. automethod:: BlochBoundary.get_class_fields





.. automethod:: BlochBoundary.get_public_fields





.. automethod:: BlochBoundary.interface_grid_shape





.. automethod:: BlochBoundary.interface_slice





.. automethod:: BlochBoundary.interface_slice_tuple





.. automethod:: BlochBoundary.place_above





.. automethod:: BlochBoundary.place_at_center





.. automethod:: BlochBoundary.place_below





.. automethod:: BlochBoundary.place_on_grid





.. automethod:: BlochBoundary.place_relative_to





.. automethod:: BlochBoundary.same_position





.. automethod:: BlochBoundary.same_position_and_size





.. automethod:: BlochBoundary.same_size





.. automethod:: BlochBoundary.set_grid_coordinates





.. automethod:: BlochBoundary.size_relative_to





.. automethod:: BlochBoundary.validate_placement






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