Coulomb input documentation
===========================

Initialize coulomb interactions.


Used to initialize class :class:`qimpy.grid.coulomb.Coulomb`.

YAML template:
--------------

.. parsed-literal::

   :yamlparam:`qimpy.grid.coulomb.Coulomb:embed`: :yamlkey:`no`     :yamlcomment:`# Whether to embed the Coulomb interaction.`
   :yamlparam:`qimpy.grid.coulomb.Coulomb:analytic`: :yamlkey:`no`  :yamlcomment:`# Whether to use an analytic or a numerical truncation scheme.`
   :yamlparam:`qimpy.grid.coulomb.Coulomb:radius`: 0.0   :yamlcomment:`# Length-scale for analytic truncation scheme.`

Parameters:
-----------

embed
+++++

*Type:* :yamltype:`bool`, *Default:*  :yamlkey:`no`

Whether to embed the Coulomb interaction.

analytic
++++++++

*Type:* :yamltype:`bool`, *Default:*  :yamlkey:`no`

Whether to use an analytic or a numerical truncation scheme.
This only matters when 0 or 1 directions are periodic:
selecting spherical or cylindrical truncation when :yamlkey:`yes`,
and the numerical Wigner-Seitz kernel otherwise (default).

radius
++++++

*Type:* :yamltype:`float`, *Default:*  0.0

Length-scale for analytic truncation scheme.
If zero (default), use the in-radius of the Wigner-Seitz cell
along the truncated directions.