:py:mod:`aiida_vasp.utils.kmesh`
================================

.. py:module:: aiida_vasp.utils.kmesh

.. autodoc2-docstring:: aiida_vasp.utils.kmesh
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`grid_address_to_recip_coord <aiida_vasp.utils.kmesh.grid_address_to_recip_coord>`
     - .. autodoc2-docstring:: aiida_vasp.utils.kmesh.grid_address_to_recip_coord
          :summary:
   * - :py:obj:`get_ir_kpoints_and_weights <aiida_vasp.utils.kmesh.get_ir_kpoints_and_weights>`
     - .. autodoc2-docstring:: aiida_vasp.utils.kmesh.get_ir_kpoints_and_weights
          :summary:
   * - :py:obj:`get_ir_kpoints_data <aiida_vasp.utils.kmesh.get_ir_kpoints_data>`
     - .. autodoc2-docstring:: aiida_vasp.utils.kmesh.get_ir_kpoints_data
          :summary:

API
~~~

.. py:function:: grid_address_to_recip_coord(points: numpy.ndarray, mesh: list[int] | tuple[int, ...], is_shift: list[bool] | None = None) -> numpy.ndarray
   :canonical: aiida_vasp.utils.kmesh.grid_address_to_recip_coord

   .. autodoc2-docstring:: aiida_vasp.utils.kmesh.grid_address_to_recip_coord

.. py:function:: get_ir_kpoints_and_weights(cell: numpy.ndarray, scaled_positions: numpy.ndarray, numbers: list[int], mesh: int | list[int] | tuple[int, ...], is_time_reversal: bool = True, symprec: float = 1e-05, is_shift: list[bool] | None = None, symmetry_reduce: bool = True) -> tuple[numpy.ndarray, numpy.ndarray]
   :canonical: aiida_vasp.utils.kmesh.get_ir_kpoints_and_weights

   .. autodoc2-docstring:: aiida_vasp.utils.kmesh.get_ir_kpoints_and_weights

.. py:function:: get_ir_kpoints_data(structure: aiida.orm.StructureData, mesh_or_spacing: aiida.orm.List | aiida.orm.Float, is_time_reversal: aiida.orm.Bool | bool = True, symprec: aiida.orm.Float | float = 1e-05, is_shift: aiida.orm.List | None = None, symmetry_reduce: aiida.orm.Bool | bool = True) -> aiida.orm.KpointsData
   :canonical: aiida_vasp.utils.kmesh.get_ir_kpoints_data

   .. autodoc2-docstring:: aiida_vasp.utils.kmesh.get_ir_kpoints_data