fdtdx.PhasorPoyntingFluxDetector
================================

.. currentmodule:: fdtdx

.. autoclass:: PhasorPoyntingFluxDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~PhasorPoyntingFluxDetector.color`



* :attr:`~PhasorPoyntingFluxDetector.components`



* :attr:`~PhasorPoyntingFluxDetector.dft_subsample`



* :attr:`~PhasorPoyntingFluxDetector.direction`



* :attr:`~PhasorPoyntingFluxDetector.dtype`



* :attr:`~PhasorPoyntingFluxDetector.exact_interpolation`



* :attr:`~PhasorPoyntingFluxDetector.fixed_propagation_axis`



* :attr:`~PhasorPoyntingFluxDetector.grid_shape`



* :attr:`~PhasorPoyntingFluxDetector.grid_slice`



* :attr:`~PhasorPoyntingFluxDetector.grid_slice_tuple`



* :attr:`~PhasorPoyntingFluxDetector.if_inverse_plot_backwards`



* :attr:`~PhasorPoyntingFluxDetector.inverse`



* :attr:`~PhasorPoyntingFluxDetector.keep_all_components`



* :attr:`~PhasorPoyntingFluxDetector.max_random_grid_offsets`



* :attr:`~PhasorPoyntingFluxDetector.max_random_real_offsets`



* :attr:`~PhasorPoyntingFluxDetector.name`



* :attr:`~PhasorPoyntingFluxDetector.num_time_steps_recorded`



* :attr:`~PhasorPoyntingFluxDetector.num_video_workers`



* :attr:`~PhasorPoyntingFluxDetector.partial_grid_shape`



* :attr:`~PhasorPoyntingFluxDetector.partial_real_position`



* :attr:`~PhasorPoyntingFluxDetector.partial_real_shape`



* :attr:`~PhasorPoyntingFluxDetector.plot`



* :attr:`~PhasorPoyntingFluxDetector.plot_dpi`



* :attr:`~PhasorPoyntingFluxDetector.plot_interpolation`



* :attr:`~PhasorPoyntingFluxDetector.propagation_axis`



* :attr:`~PhasorPoyntingFluxDetector.real_shape`



* :attr:`~PhasorPoyntingFluxDetector.reduce_volume`



* :attr:`~PhasorPoyntingFluxDetector.scaling_mode`



* :attr:`~PhasorPoyntingFluxDetector.switch`



* :attr:`~PhasorPoyntingFluxDetector.wave_characters`






.. rubric:: Methods





* :attr:`~PhasorPoyntingFluxDetector.apply`



* :attr:`~PhasorPoyntingFluxDetector.aset`



* :attr:`~PhasorPoyntingFluxDetector.check_overlap`



* :attr:`~PhasorPoyntingFluxDetector.compute_poynting_flux`



* :attr:`~PhasorPoyntingFluxDetector.draw_plot`



* :attr:`~PhasorPoyntingFluxDetector.extend_to`



* :attr:`~PhasorPoyntingFluxDetector.face_to_face_negative_direction`



* :attr:`~PhasorPoyntingFluxDetector.face_to_face_positive_direction`



* :attr:`~PhasorPoyntingFluxDetector.get_class_fields`



* :attr:`~PhasorPoyntingFluxDetector.get_public_fields`



* :attr:`~PhasorPoyntingFluxDetector.init_state`



* :attr:`~PhasorPoyntingFluxDetector.place_above`



* :attr:`~PhasorPoyntingFluxDetector.place_at_center`



* :attr:`~PhasorPoyntingFluxDetector.place_below`



* :attr:`~PhasorPoyntingFluxDetector.place_on_grid`



* :attr:`~PhasorPoyntingFluxDetector.place_relative_to`



* :attr:`~PhasorPoyntingFluxDetector.same_position`



* :attr:`~PhasorPoyntingFluxDetector.same_position_and_size`



* :attr:`~PhasorPoyntingFluxDetector.same_size`



* :attr:`~PhasorPoyntingFluxDetector.set_grid_coordinates`



* :attr:`~PhasorPoyntingFluxDetector.size_relative_to`



* :attr:`~PhasorPoyntingFluxDetector.update`



* :attr:`~PhasorPoyntingFluxDetector.validate_placement`







Attributes
==========





.. autoattribute:: PhasorPoyntingFluxDetector.color



.. autoattribute:: PhasorPoyntingFluxDetector.components



.. autoattribute:: PhasorPoyntingFluxDetector.dft_subsample



.. autoattribute:: PhasorPoyntingFluxDetector.direction



.. autoattribute:: PhasorPoyntingFluxDetector.dtype



.. autoattribute:: PhasorPoyntingFluxDetector.exact_interpolation



.. autoattribute:: PhasorPoyntingFluxDetector.fixed_propagation_axis



.. autoattribute:: PhasorPoyntingFluxDetector.grid_shape



.. autoattribute:: PhasorPoyntingFluxDetector.grid_slice



.. autoattribute:: PhasorPoyntingFluxDetector.grid_slice_tuple



.. autoattribute:: PhasorPoyntingFluxDetector.if_inverse_plot_backwards



.. autoattribute:: PhasorPoyntingFluxDetector.inverse



.. autoattribute:: PhasorPoyntingFluxDetector.keep_all_components



.. autoattribute:: PhasorPoyntingFluxDetector.max_random_grid_offsets



.. autoattribute:: PhasorPoyntingFluxDetector.max_random_real_offsets



.. autoattribute:: PhasorPoyntingFluxDetector.name



.. autoattribute:: PhasorPoyntingFluxDetector.num_time_steps_recorded



.. autoattribute:: PhasorPoyntingFluxDetector.num_video_workers



.. autoattribute:: PhasorPoyntingFluxDetector.partial_grid_shape



.. autoattribute:: PhasorPoyntingFluxDetector.partial_real_position



.. autoattribute:: PhasorPoyntingFluxDetector.partial_real_shape



.. autoattribute:: PhasorPoyntingFluxDetector.plot



.. autoattribute:: PhasorPoyntingFluxDetector.plot_dpi



.. autoattribute:: PhasorPoyntingFluxDetector.plot_interpolation



.. autoattribute:: PhasorPoyntingFluxDetector.propagation_axis



.. autoattribute:: PhasorPoyntingFluxDetector.real_shape



.. autoattribute:: PhasorPoyntingFluxDetector.reduce_volume



.. autoattribute:: PhasorPoyntingFluxDetector.scaling_mode



.. autoattribute:: PhasorPoyntingFluxDetector.switch



.. autoattribute:: PhasorPoyntingFluxDetector.wave_characters








Methods
==========








.. automethod:: PhasorPoyntingFluxDetector.apply





.. automethod:: PhasorPoyntingFluxDetector.aset





.. automethod:: PhasorPoyntingFluxDetector.check_overlap





.. automethod:: PhasorPoyntingFluxDetector.compute_poynting_flux





.. automethod:: PhasorPoyntingFluxDetector.draw_plot





.. automethod:: PhasorPoyntingFluxDetector.extend_to





.. automethod:: PhasorPoyntingFluxDetector.face_to_face_negative_direction





.. automethod:: PhasorPoyntingFluxDetector.face_to_face_positive_direction





.. automethod:: PhasorPoyntingFluxDetector.get_class_fields





.. automethod:: PhasorPoyntingFluxDetector.get_public_fields





.. automethod:: PhasorPoyntingFluxDetector.init_state





.. automethod:: PhasorPoyntingFluxDetector.place_above





.. automethod:: PhasorPoyntingFluxDetector.place_at_center





.. automethod:: PhasorPoyntingFluxDetector.place_below





.. automethod:: PhasorPoyntingFluxDetector.place_on_grid





.. automethod:: PhasorPoyntingFluxDetector.place_relative_to





.. automethod:: PhasorPoyntingFluxDetector.same_position





.. automethod:: PhasorPoyntingFluxDetector.same_position_and_size





.. automethod:: PhasorPoyntingFluxDetector.same_size





.. automethod:: PhasorPoyntingFluxDetector.set_grid_coordinates





.. automethod:: PhasorPoyntingFluxDetector.size_relative_to





.. automethod:: PhasorPoyntingFluxDetector.update





.. automethod:: PhasorPoyntingFluxDetector.validate_placement






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