fdtdx.TFSFPlaneSourceRegion
===========================

.. currentmodule:: fdtdx

.. autoclass:: TFSFPlaneSourceRegion
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~TFSFPlaneSourceRegion.amplitude`





* :attr:`~TFSFPlaneSourceRegion.azimuth_angle`



* :attr:`~TFSFPlaneSourceRegion.azimuth_radians`



* :attr:`~TFSFPlaneSourceRegion.color`



* :attr:`~TFSFPlaneSourceRegion.direction`



* :attr:`~TFSFPlaneSourceRegion.elevation_angle`



* :attr:`~TFSFPlaneSourceRegion.elevation_radians`



* :attr:`~TFSFPlaneSourceRegion.fixed_E_polarization_vector`



* :attr:`~TFSFPlaneSourceRegion.fixed_H_polarization_vector`



* :attr:`~TFSFPlaneSourceRegion.grid_shape`



* :attr:`~TFSFPlaneSourceRegion.grid_slice`



* :attr:`~TFSFPlaneSourceRegion.grid_slice_tuple`



* :attr:`~TFSFPlaneSourceRegion.horizontal_axis`



* :attr:`~TFSFPlaneSourceRegion.max_angle_random_offset`



* :attr:`~TFSFPlaneSourceRegion.max_angle_random_offset_radians`



* :attr:`~TFSFPlaneSourceRegion.max_horizontal_offset`



* :attr:`~TFSFPlaneSourceRegion.max_horizontal_offset_grid`



* :attr:`~TFSFPlaneSourceRegion.max_random_grid_offsets`



* :attr:`~TFSFPlaneSourceRegion.max_random_real_offsets`



* :attr:`~TFSFPlaneSourceRegion.max_vertical_offset`



* :attr:`~TFSFPlaneSourceRegion.max_vertical_offset_grid`



* :attr:`~TFSFPlaneSourceRegion.name`



* :attr:`~TFSFPlaneSourceRegion.partial_grid_shape`



* :attr:`~TFSFPlaneSourceRegion.partial_real_position`



* :attr:`~TFSFPlaneSourceRegion.partial_real_shape`



* :attr:`~TFSFPlaneSourceRegion.periodic_axes`



* :attr:`~TFSFPlaneSourceRegion.propagation_axis`



* :attr:`~TFSFPlaneSourceRegion.real_shape`



* :attr:`~TFSFPlaneSourceRegion.static_amplitude_factor`



* :attr:`~TFSFPlaneSourceRegion.switch`



* :attr:`~TFSFPlaneSourceRegion.temporal_profile`



* :attr:`~TFSFPlaneSourceRegion.vertical_axis`



* :attr:`~TFSFPlaneSourceRegion.wave_character`






.. rubric:: Methods





* :attr:`~TFSFPlaneSourceRegion.adjust_time_step_by_on_off`



* :attr:`~TFSFPlaneSourceRegion.apply`



* :attr:`~TFSFPlaneSourceRegion.aset`



* :attr:`~TFSFPlaneSourceRegion.check_overlap`



* :attr:`~TFSFPlaneSourceRegion.extend_to`



* :attr:`~TFSFPlaneSourceRegion.face_to_face_negative_direction`



* :attr:`~TFSFPlaneSourceRegion.face_to_face_positive_direction`



* :attr:`~TFSFPlaneSourceRegion.frequency_spectrum`



* :attr:`~TFSFPlaneSourceRegion.get_class_fields`



* :attr:`~TFSFPlaneSourceRegion.get_public_fields`



* :attr:`~TFSFPlaneSourceRegion.is_on_at_time_step`



* :attr:`~TFSFPlaneSourceRegion.place_above`



* :attr:`~TFSFPlaneSourceRegion.place_at_center`



* :attr:`~TFSFPlaneSourceRegion.place_below`



* :attr:`~TFSFPlaneSourceRegion.place_on_grid`



* :attr:`~TFSFPlaneSourceRegion.place_relative_to`



* :attr:`~TFSFPlaneSourceRegion.plot_time_signal_and_spectrum`



* :attr:`~TFSFPlaneSourceRegion.same_position`



* :attr:`~TFSFPlaneSourceRegion.same_position_and_size`



* :attr:`~TFSFPlaneSourceRegion.same_size`



* :attr:`~TFSFPlaneSourceRegion.sample_time_signal`



* :attr:`~TFSFPlaneSourceRegion.set_grid_coordinates`



* :attr:`~TFSFPlaneSourceRegion.size_relative_to`



* :attr:`~TFSFPlaneSourceRegion.update_E`



* :attr:`~TFSFPlaneSourceRegion.update_H`



* :attr:`~TFSFPlaneSourceRegion.validate_placement`







Attributes
==========



.. autoattribute:: TFSFPlaneSourceRegion.amplitude





.. autoattribute:: TFSFPlaneSourceRegion.azimuth_angle



.. autoattribute:: TFSFPlaneSourceRegion.azimuth_radians



.. autoattribute:: TFSFPlaneSourceRegion.color



.. autoattribute:: TFSFPlaneSourceRegion.direction



.. autoattribute:: TFSFPlaneSourceRegion.elevation_angle



.. autoattribute:: TFSFPlaneSourceRegion.elevation_radians



.. autoattribute:: TFSFPlaneSourceRegion.fixed_E_polarization_vector



.. autoattribute:: TFSFPlaneSourceRegion.fixed_H_polarization_vector



.. autoattribute:: TFSFPlaneSourceRegion.grid_shape



.. autoattribute:: TFSFPlaneSourceRegion.grid_slice



.. autoattribute:: TFSFPlaneSourceRegion.grid_slice_tuple



.. autoattribute:: TFSFPlaneSourceRegion.horizontal_axis



.. autoattribute:: TFSFPlaneSourceRegion.max_angle_random_offset



.. autoattribute:: TFSFPlaneSourceRegion.max_angle_random_offset_radians



.. autoattribute:: TFSFPlaneSourceRegion.max_horizontal_offset



.. autoattribute:: TFSFPlaneSourceRegion.max_horizontal_offset_grid



.. autoattribute:: TFSFPlaneSourceRegion.max_random_grid_offsets



.. autoattribute:: TFSFPlaneSourceRegion.max_random_real_offsets



.. autoattribute:: TFSFPlaneSourceRegion.max_vertical_offset



.. autoattribute:: TFSFPlaneSourceRegion.max_vertical_offset_grid



.. autoattribute:: TFSFPlaneSourceRegion.name



.. autoattribute:: TFSFPlaneSourceRegion.partial_grid_shape



.. autoattribute:: TFSFPlaneSourceRegion.partial_real_position



.. autoattribute:: TFSFPlaneSourceRegion.partial_real_shape



.. autoattribute:: TFSFPlaneSourceRegion.periodic_axes



.. autoattribute:: TFSFPlaneSourceRegion.propagation_axis



.. autoattribute:: TFSFPlaneSourceRegion.real_shape



.. autoattribute:: TFSFPlaneSourceRegion.static_amplitude_factor



.. autoattribute:: TFSFPlaneSourceRegion.switch



.. autoattribute:: TFSFPlaneSourceRegion.temporal_profile



.. autoattribute:: TFSFPlaneSourceRegion.vertical_axis



.. autoattribute:: TFSFPlaneSourceRegion.wave_character








Methods
==========








.. automethod:: TFSFPlaneSourceRegion.adjust_time_step_by_on_off





.. automethod:: TFSFPlaneSourceRegion.apply





.. automethod:: TFSFPlaneSourceRegion.aset





.. automethod:: TFSFPlaneSourceRegion.check_overlap





.. automethod:: TFSFPlaneSourceRegion.extend_to





.. automethod:: TFSFPlaneSourceRegion.face_to_face_negative_direction





.. automethod:: TFSFPlaneSourceRegion.face_to_face_positive_direction





.. automethod:: TFSFPlaneSourceRegion.frequency_spectrum





.. automethod:: TFSFPlaneSourceRegion.get_class_fields





.. automethod:: TFSFPlaneSourceRegion.get_public_fields





.. automethod:: TFSFPlaneSourceRegion.is_on_at_time_step





.. automethod:: TFSFPlaneSourceRegion.place_above





.. automethod:: TFSFPlaneSourceRegion.place_at_center





.. automethod:: TFSFPlaneSourceRegion.place_below





.. automethod:: TFSFPlaneSourceRegion.place_on_grid





.. automethod:: TFSFPlaneSourceRegion.place_relative_to





.. automethod:: TFSFPlaneSourceRegion.plot_time_signal_and_spectrum





.. automethod:: TFSFPlaneSourceRegion.same_position





.. automethod:: TFSFPlaneSourceRegion.same_position_and_size





.. automethod:: TFSFPlaneSourceRegion.same_size





.. automethod:: TFSFPlaneSourceRegion.sample_time_signal





.. automethod:: TFSFPlaneSourceRegion.set_grid_coordinates





.. automethod:: TFSFPlaneSourceRegion.size_relative_to





.. automethod:: TFSFPlaneSourceRegion.update_E





.. automethod:: TFSFPlaneSourceRegion.update_H





.. automethod:: TFSFPlaneSourceRegion.validate_placement






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