fdtdx.BoundaryConfig
====================

.. currentmodule:: fdtdx

.. autoclass:: BoundaryConfig
   :show-inheritance:

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



.. rubric:: Attributes



* :attr:`~BoundaryConfig.alpha_end_maxx`



* :attr:`~BoundaryConfig.alpha_end_maxy`



* :attr:`~BoundaryConfig.alpha_end_maxz`



* :attr:`~BoundaryConfig.alpha_end_minx`



* :attr:`~BoundaryConfig.alpha_end_miny`



* :attr:`~BoundaryConfig.alpha_end_minz`



* :attr:`~BoundaryConfig.alpha_order_maxx`



* :attr:`~BoundaryConfig.alpha_order_maxy`



* :attr:`~BoundaryConfig.alpha_order_maxz`



* :attr:`~BoundaryConfig.alpha_order_minx`



* :attr:`~BoundaryConfig.alpha_order_miny`



* :attr:`~BoundaryConfig.alpha_order_minz`



* :attr:`~BoundaryConfig.alpha_start_maxx`



* :attr:`~BoundaryConfig.alpha_start_maxy`



* :attr:`~BoundaryConfig.alpha_start_maxz`



* :attr:`~BoundaryConfig.alpha_start_minx`



* :attr:`~BoundaryConfig.alpha_start_miny`



* :attr:`~BoundaryConfig.alpha_start_minz`





* :attr:`~BoundaryConfig.bloch_vector`



* :attr:`~BoundaryConfig.boundary_type_maxx`



* :attr:`~BoundaryConfig.boundary_type_maxy`



* :attr:`~BoundaryConfig.boundary_type_maxz`



* :attr:`~BoundaryConfig.boundary_type_minx`



* :attr:`~BoundaryConfig.boundary_type_miny`



* :attr:`~BoundaryConfig.boundary_type_minz`



* :attr:`~BoundaryConfig.kappa_end_maxx`



* :attr:`~BoundaryConfig.kappa_end_maxy`



* :attr:`~BoundaryConfig.kappa_end_maxz`



* :attr:`~BoundaryConfig.kappa_end_minx`



* :attr:`~BoundaryConfig.kappa_end_miny`



* :attr:`~BoundaryConfig.kappa_end_minz`



* :attr:`~BoundaryConfig.kappa_order_maxx`



* :attr:`~BoundaryConfig.kappa_order_maxy`



* :attr:`~BoundaryConfig.kappa_order_maxz`



* :attr:`~BoundaryConfig.kappa_order_minx`



* :attr:`~BoundaryConfig.kappa_order_miny`



* :attr:`~BoundaryConfig.kappa_order_minz`



* :attr:`~BoundaryConfig.kappa_start_maxx`



* :attr:`~BoundaryConfig.kappa_start_maxy`



* :attr:`~BoundaryConfig.kappa_start_maxz`



* :attr:`~BoundaryConfig.kappa_start_minx`



* :attr:`~BoundaryConfig.kappa_start_miny`



* :attr:`~BoundaryConfig.kappa_start_minz`



* :attr:`~BoundaryConfig.sigma_end_maxx`



* :attr:`~BoundaryConfig.sigma_end_maxy`



* :attr:`~BoundaryConfig.sigma_end_maxz`



* :attr:`~BoundaryConfig.sigma_end_minx`



* :attr:`~BoundaryConfig.sigma_end_miny`



* :attr:`~BoundaryConfig.sigma_end_minz`



* :attr:`~BoundaryConfig.sigma_order_maxx`



* :attr:`~BoundaryConfig.sigma_order_maxy`



* :attr:`~BoundaryConfig.sigma_order_maxz`



* :attr:`~BoundaryConfig.sigma_order_minx`



* :attr:`~BoundaryConfig.sigma_order_miny`



* :attr:`~BoundaryConfig.sigma_order_minz`



* :attr:`~BoundaryConfig.sigma_start_maxx`



* :attr:`~BoundaryConfig.sigma_start_maxy`



* :attr:`~BoundaryConfig.sigma_start_maxz`



* :attr:`~BoundaryConfig.sigma_start_minx`



* :attr:`~BoundaryConfig.sigma_start_miny`



* :attr:`~BoundaryConfig.sigma_start_minz`



* :attr:`~BoundaryConfig.thickness_grid_maxx`



* :attr:`~BoundaryConfig.thickness_grid_maxy`



* :attr:`~BoundaryConfig.thickness_grid_maxz`



* :attr:`~BoundaryConfig.thickness_grid_minx`



* :attr:`~BoundaryConfig.thickness_grid_miny`



* :attr:`~BoundaryConfig.thickness_grid_minz`






.. rubric:: Methods





* :attr:`~BoundaryConfig.aset`



* :attr:`~BoundaryConfig.from_uniform_bound`



* :attr:`~BoundaryConfig.get_alpha_dict`



* :attr:`~BoundaryConfig.get_class_fields`



* :attr:`~BoundaryConfig.get_dict`



* :attr:`~BoundaryConfig.get_inside_boundary_slice`



* :attr:`~BoundaryConfig.get_kappa_dict`



* :attr:`~BoundaryConfig.get_order_dict`



* :attr:`~BoundaryConfig.get_public_fields`



* :attr:`~BoundaryConfig.get_sigma_dict`



* :attr:`~BoundaryConfig.get_type_dict`







Attributes
==========



.. autoattribute:: BoundaryConfig.alpha_end_maxx



.. autoattribute:: BoundaryConfig.alpha_end_maxy



.. autoattribute:: BoundaryConfig.alpha_end_maxz



.. autoattribute:: BoundaryConfig.alpha_end_minx



.. autoattribute:: BoundaryConfig.alpha_end_miny



.. autoattribute:: BoundaryConfig.alpha_end_minz



.. autoattribute:: BoundaryConfig.alpha_order_maxx



.. autoattribute:: BoundaryConfig.alpha_order_maxy



.. autoattribute:: BoundaryConfig.alpha_order_maxz



.. autoattribute:: BoundaryConfig.alpha_order_minx



.. autoattribute:: BoundaryConfig.alpha_order_miny



.. autoattribute:: BoundaryConfig.alpha_order_minz



.. autoattribute:: BoundaryConfig.alpha_start_maxx



.. autoattribute:: BoundaryConfig.alpha_start_maxy



.. autoattribute:: BoundaryConfig.alpha_start_maxz



.. autoattribute:: BoundaryConfig.alpha_start_minx



.. autoattribute:: BoundaryConfig.alpha_start_miny



.. autoattribute:: BoundaryConfig.alpha_start_minz





.. autoattribute:: BoundaryConfig.bloch_vector



.. autoattribute:: BoundaryConfig.boundary_type_maxx



.. autoattribute:: BoundaryConfig.boundary_type_maxy



.. autoattribute:: BoundaryConfig.boundary_type_maxz



.. autoattribute:: BoundaryConfig.boundary_type_minx



.. autoattribute:: BoundaryConfig.boundary_type_miny



.. autoattribute:: BoundaryConfig.boundary_type_minz



.. autoattribute:: BoundaryConfig.kappa_end_maxx



.. autoattribute:: BoundaryConfig.kappa_end_maxy



.. autoattribute:: BoundaryConfig.kappa_end_maxz



.. autoattribute:: BoundaryConfig.kappa_end_minx



.. autoattribute:: BoundaryConfig.kappa_end_miny



.. autoattribute:: BoundaryConfig.kappa_end_minz



.. autoattribute:: BoundaryConfig.kappa_order_maxx



.. autoattribute:: BoundaryConfig.kappa_order_maxy



.. autoattribute:: BoundaryConfig.kappa_order_maxz



.. autoattribute:: BoundaryConfig.kappa_order_minx



.. autoattribute:: BoundaryConfig.kappa_order_miny



.. autoattribute:: BoundaryConfig.kappa_order_minz



.. autoattribute:: BoundaryConfig.kappa_start_maxx



.. autoattribute:: BoundaryConfig.kappa_start_maxy



.. autoattribute:: BoundaryConfig.kappa_start_maxz



.. autoattribute:: BoundaryConfig.kappa_start_minx



.. autoattribute:: BoundaryConfig.kappa_start_miny



.. autoattribute:: BoundaryConfig.kappa_start_minz



.. autoattribute:: BoundaryConfig.sigma_end_maxx



.. autoattribute:: BoundaryConfig.sigma_end_maxy



.. autoattribute:: BoundaryConfig.sigma_end_maxz



.. autoattribute:: BoundaryConfig.sigma_end_minx



.. autoattribute:: BoundaryConfig.sigma_end_miny



.. autoattribute:: BoundaryConfig.sigma_end_minz



.. autoattribute:: BoundaryConfig.sigma_order_maxx



.. autoattribute:: BoundaryConfig.sigma_order_maxy



.. autoattribute:: BoundaryConfig.sigma_order_maxz



.. autoattribute:: BoundaryConfig.sigma_order_minx



.. autoattribute:: BoundaryConfig.sigma_order_miny



.. autoattribute:: BoundaryConfig.sigma_order_minz



.. autoattribute:: BoundaryConfig.sigma_start_maxx



.. autoattribute:: BoundaryConfig.sigma_start_maxy



.. autoattribute:: BoundaryConfig.sigma_start_maxz



.. autoattribute:: BoundaryConfig.sigma_start_minx



.. autoattribute:: BoundaryConfig.sigma_start_miny



.. autoattribute:: BoundaryConfig.sigma_start_minz



.. autoattribute:: BoundaryConfig.thickness_grid_maxx



.. autoattribute:: BoundaryConfig.thickness_grid_maxy



.. autoattribute:: BoundaryConfig.thickness_grid_maxz



.. autoattribute:: BoundaryConfig.thickness_grid_minx



.. autoattribute:: BoundaryConfig.thickness_grid_miny



.. autoattribute:: BoundaryConfig.thickness_grid_minz








Methods
==========








.. automethod:: BoundaryConfig.aset





.. automethod:: BoundaryConfig.from_uniform_bound





.. automethod:: BoundaryConfig.get_alpha_dict





.. automethod:: BoundaryConfig.get_class_fields





.. automethod:: BoundaryConfig.get_dict





.. automethod:: BoundaryConfig.get_inside_boundary_slice





.. automethod:: BoundaryConfig.get_kappa_dict





.. automethod:: BoundaryConfig.get_order_dict





.. automethod:: BoundaryConfig.get_public_fields





.. automethod:: BoundaryConfig.get_sigma_dict





.. automethod:: BoundaryConfig.get_type_dict






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