fdtdx.PointDipoleSource
=======================

.. currentmodule:: fdtdx

.. autoclass:: PointDipoleSource
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~PointDipoleSource.amplitude`





* :attr:`~PointDipoleSource.azimuth_angle`



* :attr:`~PointDipoleSource.color`



* :attr:`~PointDipoleSource.elevation_angle`



* :attr:`~PointDipoleSource.grid_shape`



* :attr:`~PointDipoleSource.grid_slice`



* :attr:`~PointDipoleSource.grid_slice_tuple`



* :attr:`~PointDipoleSource.max_random_grid_offsets`



* :attr:`~PointDipoleSource.max_random_real_offsets`



* :attr:`~PointDipoleSource.name`



* :attr:`~PointDipoleSource.partial_grid_shape`



* :attr:`~PointDipoleSource.partial_real_position`



* :attr:`~PointDipoleSource.partial_real_shape`



* :attr:`~PointDipoleSource.polarization`



* :attr:`~PointDipoleSource.real_shape`



* :attr:`~PointDipoleSource.source_type`



* :attr:`~PointDipoleSource.static_amplitude_factor`



* :attr:`~PointDipoleSource.switch`



* :attr:`~PointDipoleSource.temporal_profile`



* :attr:`~PointDipoleSource.wave_character`






.. rubric:: Methods





* :attr:`~PointDipoleSource.adjust_time_step_by_on_off`



* :attr:`~PointDipoleSource.apply`



* :attr:`~PointDipoleSource.aset`



* :attr:`~PointDipoleSource.check_overlap`



* :attr:`~PointDipoleSource.extend_to`



* :attr:`~PointDipoleSource.face_to_face_negative_direction`



* :attr:`~PointDipoleSource.face_to_face_positive_direction`



* :attr:`~PointDipoleSource.frequency_spectrum`



* :attr:`~PointDipoleSource.get_class_fields`



* :attr:`~PointDipoleSource.get_public_fields`



* :attr:`~PointDipoleSource.is_on_at_time_step`



* :attr:`~PointDipoleSource.place_above`



* :attr:`~PointDipoleSource.place_at_center`



* :attr:`~PointDipoleSource.place_below`



* :attr:`~PointDipoleSource.place_on_grid`



* :attr:`~PointDipoleSource.place_relative_to`



* :attr:`~PointDipoleSource.plot_time_signal_and_spectrum`



* :attr:`~PointDipoleSource.same_position`



* :attr:`~PointDipoleSource.same_position_and_size`



* :attr:`~PointDipoleSource.same_size`



* :attr:`~PointDipoleSource.sample_time_signal`



* :attr:`~PointDipoleSource.set_grid_coordinates`



* :attr:`~PointDipoleSource.size_relative_to`



* :attr:`~PointDipoleSource.update_E`



* :attr:`~PointDipoleSource.update_H`



* :attr:`~PointDipoleSource.validate_placement`







Attributes
==========



.. autoattribute:: PointDipoleSource.amplitude





.. autoattribute:: PointDipoleSource.azimuth_angle



.. autoattribute:: PointDipoleSource.color



.. autoattribute:: PointDipoleSource.elevation_angle



.. autoattribute:: PointDipoleSource.grid_shape



.. autoattribute:: PointDipoleSource.grid_slice



.. autoattribute:: PointDipoleSource.grid_slice_tuple



.. autoattribute:: PointDipoleSource.max_random_grid_offsets



.. autoattribute:: PointDipoleSource.max_random_real_offsets



.. autoattribute:: PointDipoleSource.name



.. autoattribute:: PointDipoleSource.partial_grid_shape



.. autoattribute:: PointDipoleSource.partial_real_position



.. autoattribute:: PointDipoleSource.partial_real_shape



.. autoattribute:: PointDipoleSource.polarization



.. autoattribute:: PointDipoleSource.real_shape



.. autoattribute:: PointDipoleSource.source_type



.. autoattribute:: PointDipoleSource.static_amplitude_factor



.. autoattribute:: PointDipoleSource.switch



.. autoattribute:: PointDipoleSource.temporal_profile



.. autoattribute:: PointDipoleSource.wave_character








Methods
==========








.. automethod:: PointDipoleSource.adjust_time_step_by_on_off





.. automethod:: PointDipoleSource.apply





.. automethod:: PointDipoleSource.aset





.. automethod:: PointDipoleSource.check_overlap





.. automethod:: PointDipoleSource.extend_to





.. automethod:: PointDipoleSource.face_to_face_negative_direction





.. automethod:: PointDipoleSource.face_to_face_positive_direction





.. automethod:: PointDipoleSource.frequency_spectrum





.. automethod:: PointDipoleSource.get_class_fields





.. automethod:: PointDipoleSource.get_public_fields





.. automethod:: PointDipoleSource.is_on_at_time_step





.. automethod:: PointDipoleSource.place_above





.. automethod:: PointDipoleSource.place_at_center





.. automethod:: PointDipoleSource.place_below





.. automethod:: PointDipoleSource.place_on_grid





.. automethod:: PointDipoleSource.place_relative_to





.. automethod:: PointDipoleSource.plot_time_signal_and_spectrum





.. automethod:: PointDipoleSource.same_position





.. automethod:: PointDipoleSource.same_position_and_size





.. automethod:: PointDipoleSource.same_size





.. automethod:: PointDipoleSource.sample_time_signal





.. automethod:: PointDipoleSource.set_grid_coordinates





.. automethod:: PointDipoleSource.size_relative_to





.. automethod:: PointDipoleSource.update_E





.. automethod:: PointDipoleSource.update_H





.. automethod:: PointDipoleSource.validate_placement






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