﻿fdtdx.PerfectElectricConductor
==============================

.. currentmodule:: fdtdx

.. autoclass:: PerfectElectricConductor
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~PerfectElectricConductor.axis`



* :attr:`~PerfectElectricConductor.color`



* :attr:`~PerfectElectricConductor.descriptive_name`



* :attr:`~PerfectElectricConductor.direction`



* :attr:`~PerfectElectricConductor.grid_shape`



* :attr:`~PerfectElectricConductor.grid_slice`



* :attr:`~PerfectElectricConductor.grid_slice_tuple`



* :attr:`~PerfectElectricConductor.max_random_grid_offsets`



* :attr:`~PerfectElectricConductor.max_random_real_offsets`



* :attr:`~PerfectElectricConductor.name`



* :attr:`~PerfectElectricConductor.partial_grid_shape`



* :attr:`~PerfectElectricConductor.partial_real_position`



* :attr:`~PerfectElectricConductor.partial_real_shape`



* :attr:`~PerfectElectricConductor.real_shape`



* :attr:`~PerfectElectricConductor.tangential_components`



* :attr:`~PerfectElectricConductor.thickness`



* :attr:`~PerfectElectricConductor.uses_wrap_padding`






.. rubric:: Methods





* :attr:`~PerfectElectricConductor.apply`



* :attr:`~PerfectElectricConductor.apply_field_reset`



* :attr:`~PerfectElectricConductor.apply_pad_correction`



* :attr:`~PerfectElectricConductor.apply_post_E_update`



* :attr:`~PerfectElectricConductor.apply_post_H_update`



* :attr:`~PerfectElectricConductor.aset`



* :attr:`~PerfectElectricConductor.check_overlap`



* :attr:`~PerfectElectricConductor.extend_to`



* :attr:`~PerfectElectricConductor.face_to_face_negative_direction`



* :attr:`~PerfectElectricConductor.face_to_face_positive_direction`



* :attr:`~PerfectElectricConductor.get_class_fields`



* :attr:`~PerfectElectricConductor.get_public_fields`



* :attr:`~PerfectElectricConductor.interface_grid_shape`



* :attr:`~PerfectElectricConductor.interface_slice`



* :attr:`~PerfectElectricConductor.interface_slice_tuple`



* :attr:`~PerfectElectricConductor.place_above`



* :attr:`~PerfectElectricConductor.place_at_center`



* :attr:`~PerfectElectricConductor.place_below`



* :attr:`~PerfectElectricConductor.place_on_grid`



* :attr:`~PerfectElectricConductor.place_relative_to`



* :attr:`~PerfectElectricConductor.same_position`



* :attr:`~PerfectElectricConductor.same_position_and_size`



* :attr:`~PerfectElectricConductor.same_size`



* :attr:`~PerfectElectricConductor.set_grid_coordinates`



* :attr:`~PerfectElectricConductor.size_relative_to`



* :attr:`~PerfectElectricConductor.validate_placement`







Attributes
==========





.. autoattribute:: PerfectElectricConductor.axis



.. autoattribute:: PerfectElectricConductor.color



.. autoattribute:: PerfectElectricConductor.descriptive_name



.. autoattribute:: PerfectElectricConductor.direction



.. autoattribute:: PerfectElectricConductor.grid_shape



.. autoattribute:: PerfectElectricConductor.grid_slice



.. autoattribute:: PerfectElectricConductor.grid_slice_tuple



.. autoattribute:: PerfectElectricConductor.max_random_grid_offsets



.. autoattribute:: PerfectElectricConductor.max_random_real_offsets



.. autoattribute:: PerfectElectricConductor.name



.. autoattribute:: PerfectElectricConductor.partial_grid_shape



.. autoattribute:: PerfectElectricConductor.partial_real_position



.. autoattribute:: PerfectElectricConductor.partial_real_shape



.. autoattribute:: PerfectElectricConductor.real_shape



.. autoattribute:: PerfectElectricConductor.tangential_components



.. autoattribute:: PerfectElectricConductor.thickness



.. autoattribute:: PerfectElectricConductor.uses_wrap_padding








Methods
==========








.. automethod:: PerfectElectricConductor.apply





.. automethod:: PerfectElectricConductor.apply_field_reset





.. automethod:: PerfectElectricConductor.apply_pad_correction





.. automethod:: PerfectElectricConductor.apply_post_E_update





.. automethod:: PerfectElectricConductor.apply_post_H_update





.. automethod:: PerfectElectricConductor.aset





.. automethod:: PerfectElectricConductor.check_overlap





.. automethod:: PerfectElectricConductor.extend_to





.. automethod:: PerfectElectricConductor.face_to_face_negative_direction





.. automethod:: PerfectElectricConductor.face_to_face_positive_direction





.. automethod:: PerfectElectricConductor.get_class_fields





.. automethod:: PerfectElectricConductor.get_public_fields





.. automethod:: PerfectElectricConductor.interface_grid_shape





.. automethod:: PerfectElectricConductor.interface_slice





.. automethod:: PerfectElectricConductor.interface_slice_tuple





.. automethod:: PerfectElectricConductor.place_above





.. automethod:: PerfectElectricConductor.place_at_center





.. automethod:: PerfectElectricConductor.place_below





.. automethod:: PerfectElectricConductor.place_on_grid





.. automethod:: PerfectElectricConductor.place_relative_to





.. automethod:: PerfectElectricConductor.same_position





.. automethod:: PerfectElectricConductor.same_position_and_size





.. automethod:: PerfectElectricConductor.same_size





.. automethod:: PerfectElectricConductor.set_grid_coordinates





.. automethod:: PerfectElectricConductor.size_relative_to





.. automethod:: PerfectElectricConductor.validate_placement






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