fdtdx.ClosedSurfacePhasorPoyntingFluxDetector
=============================================

.. currentmodule:: fdtdx

.. autoclass:: ClosedSurfacePhasorPoyntingFluxDetector
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.axes`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.color`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.components`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.dft_subsample`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.dtype`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.exact_interpolation`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.grid_shape`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.grid_slice`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.grid_slice_tuple`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.if_inverse_plot_backwards`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.inverse`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.max_random_grid_offsets`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.max_random_real_offsets`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.name`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.num_time_steps_recorded`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.num_video_workers`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.orientation`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.partial_grid_shape`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.partial_real_position`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.partial_real_shape`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.plot`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.plot_dpi`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.plot_interpolation`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.real_shape`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.reduce_volume`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.scaling_mode`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.switch`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.wave_characters`






.. rubric:: Methods





* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.apply`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.aset`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.check_overlap`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.compute_net_flux`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.draw_plot`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.extend_to`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.face_to_face_negative_direction`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.face_to_face_positive_direction`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.get_class_fields`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.get_public_fields`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.init_state`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.place_above`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.place_at_center`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.place_below`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.place_on_grid`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.place_relative_to`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.same_position`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.same_position_and_size`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.same_size`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.set_grid_coordinates`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.size_relative_to`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.update`



* :attr:`~ClosedSurfacePhasorPoyntingFluxDetector.validate_placement`







Attributes
==========





.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.axes



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.color



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.components



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.dft_subsample



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.dtype



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.exact_interpolation



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.grid_shape



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.grid_slice



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.grid_slice_tuple



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.if_inverse_plot_backwards



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.inverse



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.max_random_grid_offsets



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.max_random_real_offsets



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.name



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.num_time_steps_recorded



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.num_video_workers



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.orientation



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.partial_grid_shape



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.partial_real_position



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.partial_real_shape



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.plot



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.plot_dpi



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.plot_interpolation



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.real_shape



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.reduce_volume



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.scaling_mode



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.switch



.. autoattribute:: ClosedSurfacePhasorPoyntingFluxDetector.wave_characters








Methods
==========








.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.apply





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.aset





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.check_overlap





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.compute_net_flux





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.draw_plot





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.extend_to





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.face_to_face_negative_direction





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.face_to_face_positive_direction





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.get_class_fields





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.get_public_fields





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.init_state





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.place_above





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.place_at_center





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.place_below





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.place_on_grid





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.place_relative_to





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.same_position





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.same_position_and_size





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.same_size





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.set_grid_coordinates





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.size_relative_to





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.update





.. automethod:: ClosedSurfacePhasorPoyntingFluxDetector.validate_placement






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