mirror of
https://github.com/LCPQ/quantum_package
synced 2024-08-15 00:58:31 +02:00
.. | ||
tests | ||
ASSUMPTIONS.rst | ||
bitmasks_module.f90 | ||
bitmasks_routines.irp.f | ||
bitmasks.ezfio_config | ||
bitmasks.irp.f | ||
Makefile | ||
NEEDED_MODULES | ||
README.rst |
============== Bitmask Module ============== The central part of this module is the ``bitmasks_module.f90`` file. It contains the constants that will be used to define on which kind of integer the bitmasks will be defined. In the program, when an integer ``X`` is used to represent a bit string (like a determinant for example), it should be defined as, for example: .. code-block:: fortran use bitmasks integer(bit_kind) :: X The ``bitmasks_routines.irp.f`` contains helper routines to manipulate bitmassk, like transforming a bit string to a list of integers for example. Assumptions =========== .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. ``bit_kind_shift``, ``bit_kind_size`` and ``bit_kind`` are coherent: .. code_block:: fortran 2**bit_kind_shift = bit_kind_size bit_kind = bit_kind_size / 8 Needed Modules ============== .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. * `AOs <http://github.com/LCPQ/quantum_package/tree/master/src/AOs>`_ * `Electrons <http://github.com/LCPQ/quantum_package/tree/master/src/Electrons>`_ * `Ezfio_files <http://github.com/LCPQ/quantum_package/tree/master/src/Ezfio_files>`_ * `MOs <http://github.com/LCPQ/quantum_package/tree/master/src/MOs>`_ * `Nuclei <http://github.com/LCPQ/quantum_package/tree/master/src/Nuclei>`_ * `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. `cis_ijkl_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L32>`_ Bitmask to include all possible single excitations from Hartree-Fock `full_ijkl_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L12>`_ Bitmask to include all possible MOs `generators_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L100>`_ Bitmasks for generator determinants. (N_int, alpha/beta, hole/particle, generator). 3rd index is : * 1 : hole for single exc * 1 : particle for single exc * 3 : hole for 1st exc of double * 4 : particle for 1st exc of double * 5 : hole for 2dn exc of double * 6 : particle for 2dn exc of double `hf_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L44>`_ Hartree Fock bit mask `i_bitmask_gen <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L186>`_ Current bitmask for the generators `i_bitmask_ref <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L194>`_ Current bitmask for the reference `n_generators_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L70>`_ Number of bitmasks for generators `n_int <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L3>`_ Number of 64-bit integers needed to represent determinants as binary strings `n_reference_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L134>`_ Number of bitmasks for reference `ref_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L62>`_ Reference bit mask, used in Slater rules, chosen as Hartree-Fock bitmask `reference_bitmask <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks.irp.f#L164>`_ Bitmasks for reference determinants. (N_int, alpha/beta, hole/particle, reference) `bitstring_to_hexa <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks_routines.irp.f#L95>`_ Transform a bit string to a string in hexadecimal format for printing `bitstring_to_list <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks_routines.irp.f#L1>`_ Gives the inidices(+1) of the bits set to 1 in the bit string `bitstring_to_str <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks_routines.irp.f#L62>`_ Transform a bit string to a string for printing `debug_det <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks_routines.irp.f#L117>`_ Undocumented `list_to_bitstring <http://github.com/LCPQ/quantum_package/tree/master/src/Bitmask/bitmasks_routines.irp.f#L29>`_ return the physical string "string(N_int,2)" from the array of occupations "list(N_int*bit_kind_size,2) list <== ipos ==> | v string :|------------------------|-------------------------|------------------------| <==== bit_kind_size ====> <==== bit_kind_size ====> <==== bit_kind_size ====> { iint } { iint } { iint }