fdtdx.Cylinder
==============

.. currentmodule:: fdtdx

.. autoclass:: Cylinder
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~Cylinder.axis`



* :attr:`~Cylinder.color`



* :attr:`~Cylinder.grid_shape`



* :attr:`~Cylinder.grid_slice`



* :attr:`~Cylinder.grid_slice_tuple`



* :attr:`~Cylinder.horizontal_axis`



* :attr:`~Cylinder.material_name`



* :attr:`~Cylinder.materials`



* :attr:`~Cylinder.max_random_grid_offsets`



* :attr:`~Cylinder.max_random_real_offsets`



* :attr:`~Cylinder.name`



* :attr:`~Cylinder.partial_grid_shape`



* :attr:`~Cylinder.partial_real_position`



* :attr:`~Cylinder.partial_real_shape`



* :attr:`~Cylinder.placement_order`



* :attr:`~Cylinder.radius`



* :attr:`~Cylinder.real_shape`



* :attr:`~Cylinder.vertical_axis`






.. rubric:: Methods





* :attr:`~Cylinder.apply`



* :attr:`~Cylinder.aset`



* :attr:`~Cylinder.check_overlap`



* :attr:`~Cylinder.extend_to`



* :attr:`~Cylinder.face_to_face_negative_direction`



* :attr:`~Cylinder.face_to_face_positive_direction`



* :attr:`~Cylinder.get_class_fields`



* :attr:`~Cylinder.get_material_mapping`



* :attr:`~Cylinder.get_public_fields`



* :attr:`~Cylinder.get_voxel_mask_for_shape`



* :attr:`~Cylinder.place_above`



* :attr:`~Cylinder.place_at_center`



* :attr:`~Cylinder.place_below`



* :attr:`~Cylinder.place_on_grid`



* :attr:`~Cylinder.place_relative_to`



* :attr:`~Cylinder.same_position`



* :attr:`~Cylinder.same_position_and_size`



* :attr:`~Cylinder.same_size`



* :attr:`~Cylinder.set_grid_coordinates`



* :attr:`~Cylinder.size_relative_to`







Attributes
==========





.. autoattribute:: Cylinder.axis



.. autoattribute:: Cylinder.color



.. autoattribute:: Cylinder.grid_shape



.. autoattribute:: Cylinder.grid_slice



.. autoattribute:: Cylinder.grid_slice_tuple



.. autoattribute:: Cylinder.horizontal_axis



.. autoattribute:: Cylinder.material_name



.. autoattribute:: Cylinder.materials



.. autoattribute:: Cylinder.max_random_grid_offsets



.. autoattribute:: Cylinder.max_random_real_offsets



.. autoattribute:: Cylinder.name



.. autoattribute:: Cylinder.partial_grid_shape



.. autoattribute:: Cylinder.partial_real_position



.. autoattribute:: Cylinder.partial_real_shape



.. autoattribute:: Cylinder.placement_order



.. autoattribute:: Cylinder.radius



.. autoattribute:: Cylinder.real_shape



.. autoattribute:: Cylinder.vertical_axis








Methods
==========








.. automethod:: Cylinder.apply





.. automethod:: Cylinder.aset





.. automethod:: Cylinder.check_overlap





.. automethod:: Cylinder.extend_to





.. automethod:: Cylinder.face_to_face_negative_direction





.. automethod:: Cylinder.face_to_face_positive_direction





.. automethod:: Cylinder.get_class_fields





.. automethod:: Cylinder.get_material_mapping





.. automethod:: Cylinder.get_public_fields





.. automethod:: Cylinder.get_voxel_mask_for_shape





.. automethod:: Cylinder.place_above





.. automethod:: Cylinder.place_at_center





.. automethod:: Cylinder.place_below





.. automethod:: Cylinder.place_on_grid





.. automethod:: Cylinder.place_relative_to





.. automethod:: Cylinder.same_position





.. automethod:: Cylinder.same_position_and_size





.. automethod:: Cylinder.same_size





.. automethod:: Cylinder.set_grid_coordinates





.. automethod:: Cylinder.size_relative_to






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