fdtdx.PerfectlyMatchedLayer
===========================

.. currentmodule:: fdtdx

.. autoclass:: PerfectlyMatchedLayer
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~PerfectlyMatchedLayer.alpha_end`



* :attr:`~PerfectlyMatchedLayer.alpha_order`



* :attr:`~PerfectlyMatchedLayer.alpha_start`





* :attr:`~PerfectlyMatchedLayer.axis`



* :attr:`~PerfectlyMatchedLayer.color`



* :attr:`~PerfectlyMatchedLayer.descriptive_name`



* :attr:`~PerfectlyMatchedLayer.direction`



* :attr:`~PerfectlyMatchedLayer.grid_shape`



* :attr:`~PerfectlyMatchedLayer.grid_slice`



* :attr:`~PerfectlyMatchedLayer.grid_slice_tuple`



* :attr:`~PerfectlyMatchedLayer.kappa_end`



* :attr:`~PerfectlyMatchedLayer.kappa_order`



* :attr:`~PerfectlyMatchedLayer.kappa_start`



* :attr:`~PerfectlyMatchedLayer.max_random_grid_offsets`



* :attr:`~PerfectlyMatchedLayer.max_random_real_offsets`



* :attr:`~PerfectlyMatchedLayer.name`



* :attr:`~PerfectlyMatchedLayer.partial_grid_shape`



* :attr:`~PerfectlyMatchedLayer.partial_real_position`



* :attr:`~PerfectlyMatchedLayer.partial_real_shape`



* :attr:`~PerfectlyMatchedLayer.real_shape`



* :attr:`~PerfectlyMatchedLayer.sigma_end`



* :attr:`~PerfectlyMatchedLayer.sigma_order`



* :attr:`~PerfectlyMatchedLayer.sigma_start`



* :attr:`~PerfectlyMatchedLayer.thickness`



* :attr:`~PerfectlyMatchedLayer.uses_wrap_padding`






.. rubric:: Methods





* :attr:`~PerfectlyMatchedLayer.apply`



* :attr:`~PerfectlyMatchedLayer.apply_field_reset`



* :attr:`~PerfectlyMatchedLayer.apply_pad_correction`



* :attr:`~PerfectlyMatchedLayer.apply_post_E_update`



* :attr:`~PerfectlyMatchedLayer.apply_post_H_update`



* :attr:`~PerfectlyMatchedLayer.aset`



* :attr:`~PerfectlyMatchedLayer.check_overlap`



* :attr:`~PerfectlyMatchedLayer.extend_to`



* :attr:`~PerfectlyMatchedLayer.face_to_face_negative_direction`



* :attr:`~PerfectlyMatchedLayer.face_to_face_positive_direction`



* :attr:`~PerfectlyMatchedLayer.get_class_fields`



* :attr:`~PerfectlyMatchedLayer.get_public_fields`



* :attr:`~PerfectlyMatchedLayer.interface_grid_shape`



* :attr:`~PerfectlyMatchedLayer.interface_slice`



* :attr:`~PerfectlyMatchedLayer.interface_slice_tuple`



* :attr:`~PerfectlyMatchedLayer.modify_arrays`



* :attr:`~PerfectlyMatchedLayer.place_above`



* :attr:`~PerfectlyMatchedLayer.place_at_center`



* :attr:`~PerfectlyMatchedLayer.place_below`



* :attr:`~PerfectlyMatchedLayer.place_on_grid`



* :attr:`~PerfectlyMatchedLayer.place_relative_to`



* :attr:`~PerfectlyMatchedLayer.same_position`



* :attr:`~PerfectlyMatchedLayer.same_position_and_size`



* :attr:`~PerfectlyMatchedLayer.same_size`



* :attr:`~PerfectlyMatchedLayer.set_grid_coordinates`



* :attr:`~PerfectlyMatchedLayer.size_relative_to`







Attributes
==========



.. autoattribute:: PerfectlyMatchedLayer.alpha_end



.. autoattribute:: PerfectlyMatchedLayer.alpha_order



.. autoattribute:: PerfectlyMatchedLayer.alpha_start





.. autoattribute:: PerfectlyMatchedLayer.axis



.. autoattribute:: PerfectlyMatchedLayer.color



.. autoattribute:: PerfectlyMatchedLayer.descriptive_name



.. autoattribute:: PerfectlyMatchedLayer.direction



.. autoattribute:: PerfectlyMatchedLayer.grid_shape



.. autoattribute:: PerfectlyMatchedLayer.grid_slice



.. autoattribute:: PerfectlyMatchedLayer.grid_slice_tuple



.. autoattribute:: PerfectlyMatchedLayer.kappa_end



.. autoattribute:: PerfectlyMatchedLayer.kappa_order



.. autoattribute:: PerfectlyMatchedLayer.kappa_start



.. autoattribute:: PerfectlyMatchedLayer.max_random_grid_offsets



.. autoattribute:: PerfectlyMatchedLayer.max_random_real_offsets



.. autoattribute:: PerfectlyMatchedLayer.name



.. autoattribute:: PerfectlyMatchedLayer.partial_grid_shape



.. autoattribute:: PerfectlyMatchedLayer.partial_real_position



.. autoattribute:: PerfectlyMatchedLayer.partial_real_shape



.. autoattribute:: PerfectlyMatchedLayer.real_shape



.. autoattribute:: PerfectlyMatchedLayer.sigma_end



.. autoattribute:: PerfectlyMatchedLayer.sigma_order



.. autoattribute:: PerfectlyMatchedLayer.sigma_start



.. autoattribute:: PerfectlyMatchedLayer.thickness



.. autoattribute:: PerfectlyMatchedLayer.uses_wrap_padding








Methods
==========








.. automethod:: PerfectlyMatchedLayer.apply





.. automethod:: PerfectlyMatchedLayer.apply_field_reset





.. automethod:: PerfectlyMatchedLayer.apply_pad_correction





.. automethod:: PerfectlyMatchedLayer.apply_post_E_update





.. automethod:: PerfectlyMatchedLayer.apply_post_H_update





.. automethod:: PerfectlyMatchedLayer.aset





.. automethod:: PerfectlyMatchedLayer.check_overlap





.. automethod:: PerfectlyMatchedLayer.extend_to





.. automethod:: PerfectlyMatchedLayer.face_to_face_negative_direction





.. automethod:: PerfectlyMatchedLayer.face_to_face_positive_direction





.. automethod:: PerfectlyMatchedLayer.get_class_fields





.. automethod:: PerfectlyMatchedLayer.get_public_fields





.. automethod:: PerfectlyMatchedLayer.interface_grid_shape





.. automethod:: PerfectlyMatchedLayer.interface_slice





.. automethod:: PerfectlyMatchedLayer.interface_slice_tuple





.. automethod:: PerfectlyMatchedLayer.modify_arrays





.. automethod:: PerfectlyMatchedLayer.place_above





.. automethod:: PerfectlyMatchedLayer.place_at_center





.. automethod:: PerfectlyMatchedLayer.place_below





.. automethod:: PerfectlyMatchedLayer.place_on_grid





.. automethod:: PerfectlyMatchedLayer.place_relative_to





.. automethod:: PerfectlyMatchedLayer.same_position





.. automethod:: PerfectlyMatchedLayer.same_position_and_size





.. automethod:: PerfectlyMatchedLayer.same_size





.. automethod:: PerfectlyMatchedLayer.set_grid_coordinates





.. automethod:: PerfectlyMatchedLayer.size_relative_to






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