fdtdx.SimulationObject
======================

.. currentmodule:: fdtdx

.. autoclass:: SimulationObject
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~SimulationObject.color`



* :attr:`~SimulationObject.grid_shape`



* :attr:`~SimulationObject.grid_slice`



* :attr:`~SimulationObject.grid_slice_tuple`



* :attr:`~SimulationObject.max_random_grid_offsets`



* :attr:`~SimulationObject.max_random_real_offsets`



* :attr:`~SimulationObject.name`



* :attr:`~SimulationObject.partial_grid_shape`



* :attr:`~SimulationObject.partial_real_position`



* :attr:`~SimulationObject.partial_real_shape`



* :attr:`~SimulationObject.real_shape`






.. rubric:: Methods





* :attr:`~SimulationObject.apply`



* :attr:`~SimulationObject.aset`



* :attr:`~SimulationObject.check_overlap`



* :attr:`~SimulationObject.extend_to`



* :attr:`~SimulationObject.face_to_face_negative_direction`



* :attr:`~SimulationObject.face_to_face_positive_direction`



* :attr:`~SimulationObject.get_class_fields`



* :attr:`~SimulationObject.get_public_fields`



* :attr:`~SimulationObject.place_above`



* :attr:`~SimulationObject.place_at_center`



* :attr:`~SimulationObject.place_below`



* :attr:`~SimulationObject.place_on_grid`



* :attr:`~SimulationObject.place_relative_to`



* :attr:`~SimulationObject.same_position`



* :attr:`~SimulationObject.same_position_and_size`



* :attr:`~SimulationObject.same_size`



* :attr:`~SimulationObject.set_grid_coordinates`



* :attr:`~SimulationObject.size_relative_to`







Attributes
==========





.. autoattribute:: SimulationObject.color



.. autoattribute:: SimulationObject.grid_shape



.. autoattribute:: SimulationObject.grid_slice



.. autoattribute:: SimulationObject.grid_slice_tuple



.. autoattribute:: SimulationObject.max_random_grid_offsets



.. autoattribute:: SimulationObject.max_random_real_offsets



.. autoattribute:: SimulationObject.name



.. autoattribute:: SimulationObject.partial_grid_shape



.. autoattribute:: SimulationObject.partial_real_position



.. autoattribute:: SimulationObject.partial_real_shape



.. autoattribute:: SimulationObject.real_shape








Methods
==========








.. automethod:: SimulationObject.apply





.. automethod:: SimulationObject.aset





.. automethod:: SimulationObject.check_overlap





.. automethod:: SimulationObject.extend_to





.. automethod:: SimulationObject.face_to_face_negative_direction





.. automethod:: SimulationObject.face_to_face_positive_direction





.. automethod:: SimulationObject.get_class_fields





.. automethod:: SimulationObject.get_public_fields





.. automethod:: SimulationObject.place_above





.. automethod:: SimulationObject.place_at_center





.. automethod:: SimulationObject.place_below





.. automethod:: SimulationObject.place_on_grid





.. automethod:: SimulationObject.place_relative_to





.. automethod:: SimulationObject.same_position





.. automethod:: SimulationObject.same_position_and_size





.. automethod:: SimulationObject.same_size





.. automethod:: SimulationObject.set_grid_coordinates





.. automethod:: SimulationObject.size_relative_to






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