fdtdx.SimulationVolume
======================

.. currentmodule:: fdtdx

.. autoclass:: SimulationVolume
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~SimulationVolume.color`



* :attr:`~SimulationVolume.grid_shape`



* :attr:`~SimulationVolume.grid_slice`



* :attr:`~SimulationVolume.grid_slice_tuple`



* :attr:`~SimulationVolume.material`



* :attr:`~SimulationVolume.max_random_grid_offsets`



* :attr:`~SimulationVolume.max_random_real_offsets`



* :attr:`~SimulationVolume.name`



* :attr:`~SimulationVolume.partial_grid_shape`



* :attr:`~SimulationVolume.partial_real_position`



* :attr:`~SimulationVolume.partial_real_shape`



* :attr:`~SimulationVolume.placement_order`



* :attr:`~SimulationVolume.real_shape`






.. rubric:: Methods





* :attr:`~SimulationVolume.apply`



* :attr:`~SimulationVolume.aset`



* :attr:`~SimulationVolume.check_overlap`



* :attr:`~SimulationVolume.extend_to`



* :attr:`~SimulationVolume.face_to_face_negative_direction`



* :attr:`~SimulationVolume.face_to_face_positive_direction`



* :attr:`~SimulationVolume.get_class_fields`



* :attr:`~SimulationVolume.get_public_fields`



* :attr:`~SimulationVolume.place_above`



* :attr:`~SimulationVolume.place_at_center`



* :attr:`~SimulationVolume.place_below`



* :attr:`~SimulationVolume.place_on_grid`



* :attr:`~SimulationVolume.place_relative_to`



* :attr:`~SimulationVolume.same_position`



* :attr:`~SimulationVolume.same_position_and_size`



* :attr:`~SimulationVolume.same_size`



* :attr:`~SimulationVolume.set_grid_coordinates`



* :attr:`~SimulationVolume.size_relative_to`







Attributes
==========





.. autoattribute:: SimulationVolume.color



.. autoattribute:: SimulationVolume.grid_shape



.. autoattribute:: SimulationVolume.grid_slice



.. autoattribute:: SimulationVolume.grid_slice_tuple



.. autoattribute:: SimulationVolume.material



.. autoattribute:: SimulationVolume.max_random_grid_offsets



.. autoattribute:: SimulationVolume.max_random_real_offsets



.. autoattribute:: SimulationVolume.name



.. autoattribute:: SimulationVolume.partial_grid_shape



.. autoattribute:: SimulationVolume.partial_real_position



.. autoattribute:: SimulationVolume.partial_real_shape



.. autoattribute:: SimulationVolume.placement_order



.. autoattribute:: SimulationVolume.real_shape








Methods
==========








.. automethod:: SimulationVolume.apply





.. automethod:: SimulationVolume.aset





.. automethod:: SimulationVolume.check_overlap





.. automethod:: SimulationVolume.extend_to





.. automethod:: SimulationVolume.face_to_face_negative_direction





.. automethod:: SimulationVolume.face_to_face_positive_direction





.. automethod:: SimulationVolume.get_class_fields





.. automethod:: SimulationVolume.get_public_fields





.. automethod:: SimulationVolume.place_above





.. automethod:: SimulationVolume.place_at_center





.. automethod:: SimulationVolume.place_below





.. automethod:: SimulationVolume.place_on_grid





.. automethod:: SimulationVolume.place_relative_to





.. automethod:: SimulationVolume.same_position





.. automethod:: SimulationVolume.same_position_and_size





.. automethod:: SimulationVolume.same_size





.. automethod:: SimulationVolume.set_grid_coordinates





.. automethod:: SimulationVolume.size_relative_to






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