10
0
mirror of https://github.com/LCPQ/quantum_package synced 2024-07-05 02:45:58 +02:00
quantum_package/src/Electrons/README.rst
2014-05-13 13:57:58 +02:00

55 lines
1.7 KiB
ReStructuredText

================
Electrons Module
================
Describes the electrons. For the moment, only the number of alpha and beta electrons
are provided by this module.
Assumptions
===========
.. Do not edit this section. It was auto-generated from the
.. NEEDED_MODULES file.
* ``elec_num`` >= 0
* ``elec_alpha_num`` >= 0
* ``elec_beta_num`` >= 0
* ``elec_alpha_num`` >= ``elec_beta_num``
Needed Modules
==============
.. Do not edit this section. It was auto-generated from the
.. NEEDED_MODULES file.
* `Ezfio_files <http://github.com/LCPQ/quantum_package/tree/master/src/Ezfio_files>`_
* `Output <http://github.com/LCPQ/quantum_package/tree/master/src/Output>`_
* `Utils <http://github.com/LCPQ/quantum_package/tree/master/src/Utils>`_
Documentation
=============
.. Do not edit this section. It was auto-generated from the
.. NEEDED_MODULES file.
`elec_alpha_num <http://github.com/LCPQ/quantum_package/tree/master/src/Electrons/electrons.irp.f#L/BEGIN_PROVIDER [ integer, elec_alpha_num ]/;"
>`_
Numbers of alpha ("up") , beta ("down") and total electrons
`elec_beta_num <http://github.com/LCPQ/quantum_package/tree/master/src/Electrons/electrons.irp.f#L/&BEGIN_PROVIDER [ integer, elec_beta_num ]/;"
>`_
Numbers of alpha ("up") , beta ("down") and total electrons
`elec_num <http://github.com/LCPQ/quantum_package/tree/master/src/Electrons/electrons.irp.f#L/&BEGIN_PROVIDER [ integer, elec_num ]/;"
>`_
Numbers of alpha ("up") , beta ("down") and total electrons
`elec_num_tab <http://github.com/LCPQ/quantum_package/tree/master/src/Electrons/electrons.irp.f#L/&BEGIN_PROVIDER [ integer, elec_num_tab, (2) ]/;"
>`_
Numbers of alpha ("up") , beta ("down") and total electrons