fdtdx.RectilinearGrid
=====================

.. currentmodule:: fdtdx

.. autoclass:: RectilinearGrid
   :show-inheritance:

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



.. rubric:: Attributes





* :attr:`~RectilinearGrid.dx`



* :attr:`~RectilinearGrid.dy`



* :attr:`~RectilinearGrid.dz`



* :attr:`~RectilinearGrid.is_uniform`



* :attr:`~RectilinearGrid.min_spacing`



* :attr:`~RectilinearGrid.min_spacings`



* :attr:`~RectilinearGrid.shape`



* :attr:`~RectilinearGrid.uniform_spacing`



* :attr:`~RectilinearGrid.x_edges`



* :attr:`~RectilinearGrid.y_edges`



* :attr:`~RectilinearGrid.z_edges`






.. rubric:: Methods





* :attr:`~RectilinearGrid.anchor_coordinate`



* :attr:`~RectilinearGrid.aset`



* :attr:`~RectilinearGrid.axis_extent`



* :attr:`~RectilinearGrid.bounds_for_anchor`



* :attr:`~RectilinearGrid.bounds_for_center`



* :attr:`~RectilinearGrid.cell_volume`



* :attr:`~RectilinearGrid.cell_widths`



* :attr:`~RectilinearGrid.centers`



* :attr:`~RectilinearGrid.cfl_time_step`



* :attr:`~RectilinearGrid.coord_to_index`



* :attr:`~RectilinearGrid.custom`



* :attr:`~RectilinearGrid.edges`



* :attr:`~RectilinearGrid.face_area`



* :attr:`~RectilinearGrid.get_class_fields`



* :attr:`~RectilinearGrid.get_public_fields`



* :attr:`~RectilinearGrid.length_to_cell_count`



* :attr:`~RectilinearGrid.reduce_symmetric`



* :attr:`~RectilinearGrid.slice_extent`



* :attr:`~RectilinearGrid.subgrid`



* :attr:`~RectilinearGrid.uniform`







Attributes
==========





.. autoattribute:: RectilinearGrid.dx



.. autoattribute:: RectilinearGrid.dy



.. autoattribute:: RectilinearGrid.dz



.. autoattribute:: RectilinearGrid.is_uniform



.. autoattribute:: RectilinearGrid.min_spacing



.. autoattribute:: RectilinearGrid.min_spacings



.. autoattribute:: RectilinearGrid.shape



.. autoattribute:: RectilinearGrid.uniform_spacing



.. autoattribute:: RectilinearGrid.x_edges



.. autoattribute:: RectilinearGrid.y_edges



.. autoattribute:: RectilinearGrid.z_edges








Methods
==========








.. automethod:: RectilinearGrid.anchor_coordinate





.. automethod:: RectilinearGrid.aset





.. automethod:: RectilinearGrid.axis_extent





.. automethod:: RectilinearGrid.bounds_for_anchor





.. automethod:: RectilinearGrid.bounds_for_center





.. automethod:: RectilinearGrid.cell_volume





.. automethod:: RectilinearGrid.cell_widths





.. automethod:: RectilinearGrid.centers





.. automethod:: RectilinearGrid.cfl_time_step





.. automethod:: RectilinearGrid.coord_to_index





.. automethod:: RectilinearGrid.custom





.. automethod:: RectilinearGrid.edges





.. automethod:: RectilinearGrid.face_area





.. automethod:: RectilinearGrid.get_class_fields





.. automethod:: RectilinearGrid.get_public_fields





.. automethod:: RectilinearGrid.length_to_cell_count





.. automethod:: RectilinearGrid.reduce_symmetric





.. automethod:: RectilinearGrid.slice_extent





.. automethod:: RectilinearGrid.subgrid





.. automethod:: RectilinearGrid.uniform






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