fdtdx.UniformPlaneSource
========================

.. currentmodule:: fdtdx

.. autoclass:: UniformPlaneSource
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~UniformPlaneSource.amplitude`





* :attr:`~UniformPlaneSource.azimuth_angle`



* :attr:`~UniformPlaneSource.azimuth_radians`



* :attr:`~UniformPlaneSource.color`



* :attr:`~UniformPlaneSource.direction`



* :attr:`~UniformPlaneSource.elevation_angle`



* :attr:`~UniformPlaneSource.elevation_radians`



* :attr:`~UniformPlaneSource.fixed_E_polarization_vector`



* :attr:`~UniformPlaneSource.fixed_H_polarization_vector`



* :attr:`~UniformPlaneSource.grid_shape`



* :attr:`~UniformPlaneSource.grid_slice`



* :attr:`~UniformPlaneSource.grid_slice_tuple`



* :attr:`~UniformPlaneSource.horizontal_axis`



* :attr:`~UniformPlaneSource.max_angle_random_offset`



* :attr:`~UniformPlaneSource.max_angle_random_offset_radians`



* :attr:`~UniformPlaneSource.max_horizontal_offset`



* :attr:`~UniformPlaneSource.max_horizontal_offset_grid`



* :attr:`~UniformPlaneSource.max_random_grid_offsets`



* :attr:`~UniformPlaneSource.max_random_real_offsets`



* :attr:`~UniformPlaneSource.max_vertical_offset`



* :attr:`~UniformPlaneSource.max_vertical_offset_grid`



* :attr:`~UniformPlaneSource.name`



* :attr:`~UniformPlaneSource.normalize_by_energy`



* :attr:`~UniformPlaneSource.partial_grid_shape`



* :attr:`~UniformPlaneSource.partial_real_position`



* :attr:`~UniformPlaneSource.partial_real_shape`



* :attr:`~UniformPlaneSource.propagation_axis`



* :attr:`~UniformPlaneSource.real_shape`



* :attr:`~UniformPlaneSource.static_amplitude_factor`



* :attr:`~UniformPlaneSource.switch`



* :attr:`~UniformPlaneSource.temporal_profile`



* :attr:`~UniformPlaneSource.vertical_axis`



* :attr:`~UniformPlaneSource.wave_character`






.. rubric:: Methods





* :attr:`~UniformPlaneSource.adjust_time_step_by_on_off`



* :attr:`~UniformPlaneSource.apply`



* :attr:`~UniformPlaneSource.aset`



* :attr:`~UniformPlaneSource.check_overlap`



* :attr:`~UniformPlaneSource.extend_to`



* :attr:`~UniformPlaneSource.face_to_face_negative_direction`



* :attr:`~UniformPlaneSource.face_to_face_positive_direction`



* :attr:`~UniformPlaneSource.frequency_spectrum`



* :attr:`~UniformPlaneSource.get_class_fields`



* :attr:`~UniformPlaneSource.get_public_fields`



* :attr:`~UniformPlaneSource.is_on_at_time_step`



* :attr:`~UniformPlaneSource.place_above`



* :attr:`~UniformPlaneSource.place_at_center`



* :attr:`~UniformPlaneSource.place_below`



* :attr:`~UniformPlaneSource.place_on_grid`



* :attr:`~UniformPlaneSource.place_relative_to`



* :attr:`~UniformPlaneSource.plot_time_signal_and_spectrum`



* :attr:`~UniformPlaneSource.same_position`



* :attr:`~UniformPlaneSource.same_position_and_size`



* :attr:`~UniformPlaneSource.same_size`



* :attr:`~UniformPlaneSource.sample_time_signal`



* :attr:`~UniformPlaneSource.set_grid_coordinates`



* :attr:`~UniformPlaneSource.size_relative_to`



* :attr:`~UniformPlaneSource.update_E`



* :attr:`~UniformPlaneSource.update_H`







Attributes
==========



.. autoattribute:: UniformPlaneSource.amplitude





.. autoattribute:: UniformPlaneSource.azimuth_angle



.. autoattribute:: UniformPlaneSource.azimuth_radians



.. autoattribute:: UniformPlaneSource.color



.. autoattribute:: UniformPlaneSource.direction



.. autoattribute:: UniformPlaneSource.elevation_angle



.. autoattribute:: UniformPlaneSource.elevation_radians



.. autoattribute:: UniformPlaneSource.fixed_E_polarization_vector



.. autoattribute:: UniformPlaneSource.fixed_H_polarization_vector



.. autoattribute:: UniformPlaneSource.grid_shape



.. autoattribute:: UniformPlaneSource.grid_slice



.. autoattribute:: UniformPlaneSource.grid_slice_tuple



.. autoattribute:: UniformPlaneSource.horizontal_axis



.. autoattribute:: UniformPlaneSource.max_angle_random_offset



.. autoattribute:: UniformPlaneSource.max_angle_random_offset_radians



.. autoattribute:: UniformPlaneSource.max_horizontal_offset



.. autoattribute:: UniformPlaneSource.max_horizontal_offset_grid



.. autoattribute:: UniformPlaneSource.max_random_grid_offsets



.. autoattribute:: UniformPlaneSource.max_random_real_offsets



.. autoattribute:: UniformPlaneSource.max_vertical_offset



.. autoattribute:: UniformPlaneSource.max_vertical_offset_grid



.. autoattribute:: UniformPlaneSource.name



.. autoattribute:: UniformPlaneSource.normalize_by_energy



.. autoattribute:: UniformPlaneSource.partial_grid_shape



.. autoattribute:: UniformPlaneSource.partial_real_position



.. autoattribute:: UniformPlaneSource.partial_real_shape



.. autoattribute:: UniformPlaneSource.propagation_axis



.. autoattribute:: UniformPlaneSource.real_shape



.. autoattribute:: UniformPlaneSource.static_amplitude_factor



.. autoattribute:: UniformPlaneSource.switch



.. autoattribute:: UniformPlaneSource.temporal_profile



.. autoattribute:: UniformPlaneSource.vertical_axis



.. autoattribute:: UniformPlaneSource.wave_character








Methods
==========








.. automethod:: UniformPlaneSource.adjust_time_step_by_on_off





.. automethod:: UniformPlaneSource.apply





.. automethod:: UniformPlaneSource.aset





.. automethod:: UniformPlaneSource.check_overlap





.. automethod:: UniformPlaneSource.extend_to





.. automethod:: UniformPlaneSource.face_to_face_negative_direction





.. automethod:: UniformPlaneSource.face_to_face_positive_direction





.. automethod:: UniformPlaneSource.frequency_spectrum





.. automethod:: UniformPlaneSource.get_class_fields





.. automethod:: UniformPlaneSource.get_public_fields





.. automethod:: UniformPlaneSource.is_on_at_time_step





.. automethod:: UniformPlaneSource.place_above





.. automethod:: UniformPlaneSource.place_at_center





.. automethod:: UniformPlaneSource.place_below





.. automethod:: UniformPlaneSource.place_on_grid





.. automethod:: UniformPlaneSource.place_relative_to





.. automethod:: UniformPlaneSource.plot_time_signal_and_spectrum





.. automethod:: UniformPlaneSource.same_position





.. automethod:: UniformPlaneSource.same_position_and_size





.. automethod:: UniformPlaneSource.same_size





.. automethod:: UniformPlaneSource.sample_time_signal





.. automethod:: UniformPlaneSource.set_grid_coordinates





.. automethod:: UniformPlaneSource.size_relative_to





.. automethod:: UniformPlaneSource.update_E





.. automethod:: UniformPlaneSource.update_H






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