Skip to content

Commit

Permalink
Added kpoint to MO group (#138)
Browse files Browse the repository at this point in the history
* Added kpoint to MO group

* Added k-vector info

* Created json blocks

* Added k-point weights
  • Loading branch information
scemama authored May 13, 2024
1 parent 9e262ba commit 1117a5b
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions trex.org
Original file line number Diff line number Diff line change
Expand Up @@ -128,23 +128,25 @@

** Periodic boundary calculations (pbc group)

A single $k$-point per TREXIO file can be stored. The $k$-point is
defined in this group.

#+NAME: pbc
| Variable | Type | Row-major Dimensions | Column-major Dimensions | Description |
|------------+---------+----------------------+-------------------------+-------------------------|
| ~periodic~ | ~int~ | | | ~1~: true or ~0~: false |
| ~k_point~ | ~float~ | ~[3]~ | ~(3)~ | $k$-point sampling |
| Variable | Type | Row-major Dimensions | Column-major Dimensions | Description |
|------------------+---------+----------------------+-------------------------+-------------------------|
| ~periodic~ | ~int~ | | | ~1~: true or ~0~: false |
| ~k_point_num~ | ~dim~ | | | Number of $k$-points |
| ~k_point~ | ~float~ | ~[3]~ | ~(3)~ | $k$-point sampling |
| ~k_point_weight~ | ~float~ | ~[pbc.k_point_num]~ | ~(pbc.k_point_num)~ | $k$-point weight |

#+CALL: json(data=pbc, title="pbc")

#+RESULTS:
:results:
#+begin_src python :tangle trex.json
"pbc": {
"periodic" : [ "int" , [] ]
, "k_point" : [ "float", [ "3" ] ]
"periodic" : [ "int" , [] ]
, "k_point_num" : [ "dim" , [] ]
, "k_point" : [ "float", [ "pbc.k_point_num", "3" ] ]
, "k_point_weight" : [ "float", [ "pbc.k_point_num" ] ]
} ,
#+end_src
:end:
Expand Down Expand Up @@ -826,6 +828,13 @@ power = [
| ~occupation~ | ~float~ | ~[mo.num]~ | ~(mo.num)~ | Occupation number |
| ~energy~ | ~float~ | ~[mo.num]~ | ~(mo.num)~ | For canonical MOs, corresponding eigenvalue |
| ~spin~ | ~int~ | ~[mo.num]~ | ~(mo.num)~ | For UHF wave functions, 0 is $\alpha$ and 1 is $\beta$ |
| ~k_point~ | ~index~ | ~[mo.num]~ | ~(mo.num)~ | For periodic calculations, the $k$ point to which each MO belongs |

**Warning**: ~mo.num~ is the total number of MOs stored in the file.
For periodic calculations, this group contains all the MOs
belonging to all $k$ points so ~mo.num~ will be the sum of the
numbers of MOs in each $k$ point. For UHF wave functions, ~mo.num~
is the number of spin-orbitals, twice the number of spatial orbitals.

#+CALL: json(data=mo, title="mo")

Expand All @@ -842,10 +851,12 @@ power = [
, "occupation" : [ "float", [ "mo.num" ] ]
, "energy" : [ "float", [ "mo.num" ] ]
, "spin" : [ "int" , [ "mo.num" ] ]
, "k_point" : [ "index", [ "mo.num" ] ]
} ,
#+end_src
:end:


*** One-electron integrals (~mo_1e_int~ group)

The operators as the same as those defined in the
Expand Down

0 comments on commit 1117a5b

Please sign in to comment.