fdtdx.PoyntingFluxDetector
==========================

.. currentmodule:: fdtdx

.. autoclass:: PoyntingFluxDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~PoyntingFluxDetector.color`



* :attr:`~PoyntingFluxDetector.direction`



* :attr:`~PoyntingFluxDetector.dtype`



* :attr:`~PoyntingFluxDetector.exact_interpolation`



* :attr:`~PoyntingFluxDetector.fixed_propagation_axis`



* :attr:`~PoyntingFluxDetector.grid_shape`



* :attr:`~PoyntingFluxDetector.grid_slice`



* :attr:`~PoyntingFluxDetector.grid_slice_tuple`



* :attr:`~PoyntingFluxDetector.if_inverse_plot_backwards`



* :attr:`~PoyntingFluxDetector.inverse`



* :attr:`~PoyntingFluxDetector.keep_all_components`



* :attr:`~PoyntingFluxDetector.max_random_grid_offsets`



* :attr:`~PoyntingFluxDetector.max_random_real_offsets`



* :attr:`~PoyntingFluxDetector.name`



* :attr:`~PoyntingFluxDetector.num_time_steps_recorded`



* :attr:`~PoyntingFluxDetector.num_video_workers`



* :attr:`~PoyntingFluxDetector.partial_grid_shape`



* :attr:`~PoyntingFluxDetector.partial_real_position`



* :attr:`~PoyntingFluxDetector.partial_real_shape`



* :attr:`~PoyntingFluxDetector.plot`



* :attr:`~PoyntingFluxDetector.plot_dpi`



* :attr:`~PoyntingFluxDetector.plot_interpolation`



* :attr:`~PoyntingFluxDetector.propagation_axis`



* :attr:`~PoyntingFluxDetector.real_shape`



* :attr:`~PoyntingFluxDetector.reduce_volume`



* :attr:`~PoyntingFluxDetector.switch`






.. rubric:: Methods





* :attr:`~PoyntingFluxDetector.apply`



* :attr:`~PoyntingFluxDetector.aset`



* :attr:`~PoyntingFluxDetector.check_overlap`



* :attr:`~PoyntingFluxDetector.draw_plot`



* :attr:`~PoyntingFluxDetector.extend_to`



* :attr:`~PoyntingFluxDetector.face_to_face_negative_direction`



* :attr:`~PoyntingFluxDetector.face_to_face_positive_direction`



* :attr:`~PoyntingFluxDetector.get_class_fields`



* :attr:`~PoyntingFluxDetector.get_public_fields`



* :attr:`~PoyntingFluxDetector.init_state`



* :attr:`~PoyntingFluxDetector.place_above`



* :attr:`~PoyntingFluxDetector.place_at_center`



* :attr:`~PoyntingFluxDetector.place_below`



* :attr:`~PoyntingFluxDetector.place_on_grid`



* :attr:`~PoyntingFluxDetector.place_relative_to`



* :attr:`~PoyntingFluxDetector.same_position`



* :attr:`~PoyntingFluxDetector.same_position_and_size`



* :attr:`~PoyntingFluxDetector.same_size`



* :attr:`~PoyntingFluxDetector.set_grid_coordinates`



* :attr:`~PoyntingFluxDetector.size_relative_to`



* :attr:`~PoyntingFluxDetector.update`







Attributes
==========





.. autoattribute:: PoyntingFluxDetector.color



.. autoattribute:: PoyntingFluxDetector.direction



.. autoattribute:: PoyntingFluxDetector.dtype



.. autoattribute:: PoyntingFluxDetector.exact_interpolation



.. autoattribute:: PoyntingFluxDetector.fixed_propagation_axis



.. autoattribute:: PoyntingFluxDetector.grid_shape



.. autoattribute:: PoyntingFluxDetector.grid_slice



.. autoattribute:: PoyntingFluxDetector.grid_slice_tuple



.. autoattribute:: PoyntingFluxDetector.if_inverse_plot_backwards



.. autoattribute:: PoyntingFluxDetector.inverse



.. autoattribute:: PoyntingFluxDetector.keep_all_components



.. autoattribute:: PoyntingFluxDetector.max_random_grid_offsets



.. autoattribute:: PoyntingFluxDetector.max_random_real_offsets



.. autoattribute:: PoyntingFluxDetector.name



.. autoattribute:: PoyntingFluxDetector.num_time_steps_recorded



.. autoattribute:: PoyntingFluxDetector.num_video_workers



.. autoattribute:: PoyntingFluxDetector.partial_grid_shape



.. autoattribute:: PoyntingFluxDetector.partial_real_position



.. autoattribute:: PoyntingFluxDetector.partial_real_shape



.. autoattribute:: PoyntingFluxDetector.plot



.. autoattribute:: PoyntingFluxDetector.plot_dpi



.. autoattribute:: PoyntingFluxDetector.plot_interpolation



.. autoattribute:: PoyntingFluxDetector.propagation_axis



.. autoattribute:: PoyntingFluxDetector.real_shape



.. autoattribute:: PoyntingFluxDetector.reduce_volume



.. autoattribute:: PoyntingFluxDetector.switch








Methods
==========








.. automethod:: PoyntingFluxDetector.apply





.. automethod:: PoyntingFluxDetector.aset





.. automethod:: PoyntingFluxDetector.check_overlap





.. automethod:: PoyntingFluxDetector.draw_plot





.. automethod:: PoyntingFluxDetector.extend_to





.. automethod:: PoyntingFluxDetector.face_to_face_negative_direction





.. automethod:: PoyntingFluxDetector.face_to_face_positive_direction





.. automethod:: PoyntingFluxDetector.get_class_fields





.. automethod:: PoyntingFluxDetector.get_public_fields





.. automethod:: PoyntingFluxDetector.init_state





.. automethod:: PoyntingFluxDetector.place_above





.. automethod:: PoyntingFluxDetector.place_at_center





.. automethod:: PoyntingFluxDetector.place_below





.. automethod:: PoyntingFluxDetector.place_on_grid





.. automethod:: PoyntingFluxDetector.place_relative_to





.. automethod:: PoyntingFluxDetector.same_position





.. automethod:: PoyntingFluxDetector.same_position_and_size





.. automethod:: PoyntingFluxDetector.same_size





.. automethod:: PoyntingFluxDetector.set_grid_coordinates





.. automethod:: PoyntingFluxDetector.size_relative_to





.. automethod:: PoyntingFluxDetector.update






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