fdtdx.PerfectMagneticConductor
==============================

.. currentmodule:: fdtdx

.. autoclass:: PerfectMagneticConductor
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~PerfectMagneticConductor.axis`



* :attr:`~PerfectMagneticConductor.color`



* :attr:`~PerfectMagneticConductor.descriptive_name`



* :attr:`~PerfectMagneticConductor.direction`



* :attr:`~PerfectMagneticConductor.grid_shape`



* :attr:`~PerfectMagneticConductor.grid_slice`



* :attr:`~PerfectMagneticConductor.grid_slice_tuple`



* :attr:`~PerfectMagneticConductor.max_random_grid_offsets`



* :attr:`~PerfectMagneticConductor.max_random_real_offsets`



* :attr:`~PerfectMagneticConductor.name`



* :attr:`~PerfectMagneticConductor.partial_grid_shape`



* :attr:`~PerfectMagneticConductor.partial_real_position`



* :attr:`~PerfectMagneticConductor.partial_real_shape`



* :attr:`~PerfectMagneticConductor.real_shape`



* :attr:`~PerfectMagneticConductor.tangential_components`



* :attr:`~PerfectMagneticConductor.thickness`



* :attr:`~PerfectMagneticConductor.uses_wrap_padding`






.. rubric:: Methods





* :attr:`~PerfectMagneticConductor.apply`



* :attr:`~PerfectMagneticConductor.apply_field_reset`



* :attr:`~PerfectMagneticConductor.apply_pad_correction`



* :attr:`~PerfectMagneticConductor.apply_post_E_update`



* :attr:`~PerfectMagneticConductor.apply_post_H_update`



* :attr:`~PerfectMagneticConductor.aset`



* :attr:`~PerfectMagneticConductor.check_overlap`



* :attr:`~PerfectMagneticConductor.extend_to`



* :attr:`~PerfectMagneticConductor.face_to_face_negative_direction`



* :attr:`~PerfectMagneticConductor.face_to_face_positive_direction`



* :attr:`~PerfectMagneticConductor.get_class_fields`



* :attr:`~PerfectMagneticConductor.get_public_fields`



* :attr:`~PerfectMagneticConductor.interface_grid_shape`



* :attr:`~PerfectMagneticConductor.interface_slice`



* :attr:`~PerfectMagneticConductor.interface_slice_tuple`



* :attr:`~PerfectMagneticConductor.place_above`



* :attr:`~PerfectMagneticConductor.place_at_center`



* :attr:`~PerfectMagneticConductor.place_below`



* :attr:`~PerfectMagneticConductor.place_on_grid`



* :attr:`~PerfectMagneticConductor.place_relative_to`



* :attr:`~PerfectMagneticConductor.same_position`



* :attr:`~PerfectMagneticConductor.same_position_and_size`



* :attr:`~PerfectMagneticConductor.same_size`



* :attr:`~PerfectMagneticConductor.set_grid_coordinates`



* :attr:`~PerfectMagneticConductor.size_relative_to`



* :attr:`~PerfectMagneticConductor.validate_placement`







Attributes
==========





.. autoattribute:: PerfectMagneticConductor.axis



.. autoattribute:: PerfectMagneticConductor.color



.. autoattribute:: PerfectMagneticConductor.descriptive_name



.. autoattribute:: PerfectMagneticConductor.direction



.. autoattribute:: PerfectMagneticConductor.grid_shape



.. autoattribute:: PerfectMagneticConductor.grid_slice



.. autoattribute:: PerfectMagneticConductor.grid_slice_tuple



.. autoattribute:: PerfectMagneticConductor.max_random_grid_offsets



.. autoattribute:: PerfectMagneticConductor.max_random_real_offsets



.. autoattribute:: PerfectMagneticConductor.name



.. autoattribute:: PerfectMagneticConductor.partial_grid_shape



.. autoattribute:: PerfectMagneticConductor.partial_real_position



.. autoattribute:: PerfectMagneticConductor.partial_real_shape



.. autoattribute:: PerfectMagneticConductor.real_shape



.. autoattribute:: PerfectMagneticConductor.tangential_components



.. autoattribute:: PerfectMagneticConductor.thickness



.. autoattribute:: PerfectMagneticConductor.uses_wrap_padding








Methods
==========








.. automethod:: PerfectMagneticConductor.apply





.. automethod:: PerfectMagneticConductor.apply_field_reset





.. automethod:: PerfectMagneticConductor.apply_pad_correction





.. automethod:: PerfectMagneticConductor.apply_post_E_update





.. automethod:: PerfectMagneticConductor.apply_post_H_update





.. automethod:: PerfectMagneticConductor.aset





.. automethod:: PerfectMagneticConductor.check_overlap





.. automethod:: PerfectMagneticConductor.extend_to





.. automethod:: PerfectMagneticConductor.face_to_face_negative_direction





.. automethod:: PerfectMagneticConductor.face_to_face_positive_direction





.. automethod:: PerfectMagneticConductor.get_class_fields





.. automethod:: PerfectMagneticConductor.get_public_fields





.. automethod:: PerfectMagneticConductor.interface_grid_shape





.. automethod:: PerfectMagneticConductor.interface_slice





.. automethod:: PerfectMagneticConductor.interface_slice_tuple





.. automethod:: PerfectMagneticConductor.place_above





.. automethod:: PerfectMagneticConductor.place_at_center





.. automethod:: PerfectMagneticConductor.place_below





.. automethod:: PerfectMagneticConductor.place_on_grid





.. automethod:: PerfectMagneticConductor.place_relative_to





.. automethod:: PerfectMagneticConductor.same_position





.. automethod:: PerfectMagneticConductor.same_position_and_size





.. automethod:: PerfectMagneticConductor.same_size





.. automethod:: PerfectMagneticConductor.set_grid_coordinates





.. automethod:: PerfectMagneticConductor.size_relative_to





.. automethod:: PerfectMagneticConductor.validate_placement






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