fdtdx.Device
============

.. currentmodule:: fdtdx

.. autoclass:: Device
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~Device.color`



* :attr:`~Device.grid_shape`



* :attr:`~Device.grid_slice`



* :attr:`~Device.grid_slice_tuple`



* :attr:`~Device.materials`



* :attr:`~Device.matrix_voxel_grid_shape`



* :attr:`~Device.max_random_grid_offsets`



* :attr:`~Device.max_random_real_offsets`



* :attr:`~Device.name`



* :attr:`~Device.output_type`



* :attr:`~Device.param_transforms`



* :attr:`~Device.partial_grid_shape`



* :attr:`~Device.partial_real_position`



* :attr:`~Device.partial_real_shape`



* :attr:`~Device.partial_voxel_grid_shape`



* :attr:`~Device.partial_voxel_real_shape`



* :attr:`~Device.placement_order`



* :attr:`~Device.real_shape`



* :attr:`~Device.single_voxel_grid_shape`



* :attr:`~Device.single_voxel_real_shape`






.. rubric:: Methods





* :attr:`~Device.apply`



* :attr:`~Device.aset`



* :attr:`~Device.check_overlap`



* :attr:`~Device.extend_to`



* :attr:`~Device.face_to_face_negative_direction`



* :attr:`~Device.face_to_face_positive_direction`



* :attr:`~Device.get_class_fields`



* :attr:`~Device.get_public_fields`



* :attr:`~Device.init_params`



* :attr:`~Device.place_above`



* :attr:`~Device.place_at_center`



* :attr:`~Device.place_below`



* :attr:`~Device.place_on_grid`



* :attr:`~Device.place_relative_to`



* :attr:`~Device.same_position`



* :attr:`~Device.same_position_and_size`



* :attr:`~Device.same_size`



* :attr:`~Device.set_grid_coordinates`



* :attr:`~Device.size_relative_to`







Attributes
==========





.. autoattribute:: Device.color



.. autoattribute:: Device.grid_shape



.. autoattribute:: Device.grid_slice



.. autoattribute:: Device.grid_slice_tuple



.. autoattribute:: Device.materials



.. autoattribute:: Device.matrix_voxel_grid_shape



.. autoattribute:: Device.max_random_grid_offsets



.. autoattribute:: Device.max_random_real_offsets



.. autoattribute:: Device.name



.. autoattribute:: Device.output_type



.. autoattribute:: Device.param_transforms



.. autoattribute:: Device.partial_grid_shape



.. autoattribute:: Device.partial_real_position



.. autoattribute:: Device.partial_real_shape



.. autoattribute:: Device.partial_voxel_grid_shape



.. autoattribute:: Device.partial_voxel_real_shape



.. autoattribute:: Device.placement_order



.. autoattribute:: Device.real_shape



.. autoattribute:: Device.single_voxel_grid_shape



.. autoattribute:: Device.single_voxel_real_shape








Methods
==========








.. automethod:: Device.apply





.. automethod:: Device.aset





.. automethod:: Device.check_overlap





.. automethod:: Device.extend_to





.. automethod:: Device.face_to_face_negative_direction





.. automethod:: Device.face_to_face_positive_direction





.. automethod:: Device.get_class_fields





.. automethod:: Device.get_public_fields





.. automethod:: Device.init_params





.. automethod:: Device.place_above





.. automethod:: Device.place_at_center





.. automethod:: Device.place_below





.. automethod:: Device.place_on_grid





.. automethod:: Device.place_relative_to





.. automethod:: Device.same_position





.. automethod:: Device.same_position_and_size





.. automethod:: Device.same_size





.. automethod:: Device.set_grid_coordinates





.. automethod:: Device.size_relative_to






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