TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-11-03 20:54:09 +01:00
Code Issues Projects Releases Wiki Activity

Deploying to gh-pages from @ TREX-CoE/qmckl@7e1dad0e4e 🚀

Browse Source
This commit is contained in:
scemama 2024-01-09 07:20:48 +00:00
parent 7294acf6e0
commit ec57ef49a8
21 changed files with 1500 additions and 1500 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>QMCkl source code documentation</title> <title>QMCkl source code documentation</title>
@ -375,7 +375,7 @@ and bug reports should be submitted at
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

118
qmckl.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Introduction</title> <title>Introduction</title>
@ -346,36 +346,36 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org59354f7">1. Installing QMCkl</a> <li><a href="#org98049a5">1. Installing QMCkl</a>
<ul> <ul>
<li><a href="#org3809739">1.1. Installing from the released tarball (for end users)</a></li> <li><a href="#org4d096e2">1.1. Installing from the released tarball (for end users)</a></li>
<li><a href="#orgdb45e8f">1.2. Installing from the source repository (for developers)</a></li> <li><a href="#org26365f7">1.2. Installing from the source repository (for developers)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orge559a2e">2. Using QMCkl</a></li> <li><a href="#orgc659799">2. Using QMCkl</a></li>
<li><a href="#org592df36">3. Developing in QMCkl</a> <li><a href="#org45a56f5">3. Developing in QMCkl</a>
<ul> <ul>
<li><a href="#org52014b1">3.1. Literate programming</a></li> <li><a href="#org37142ce">3.1. Literate programming</a></li>
<li><a href="#org5cfc8a8">3.2. Source code editing</a></li> <li><a href="#orgdf9daa0">3.2. Source code editing</a></li>
<li><a href="#orgf315444">3.3. Choice of the programming language</a></li> <li><a href="#orgaebd78a">3.3. Choice of the programming language</a></li>
<li><a href="#org24eb7de">3.4. Coding rules</a></li> <li><a href="#org86c6b85">3.4. Coding rules</a></li>
<li><a href="#orgb841074">3.5. Design of the library</a></li> <li><a href="#orgf176230">3.5. Design of the library</a></li>
<li><a href="#org7c16213">3.6. Naming conventions</a></li> <li><a href="#org86e103a">3.6. Naming conventions</a></li>
<li><a href="#org44bff69">3.7. Application programming interface</a></li> <li><a href="#org8f8a40a">3.7. Application programming interface</a></li>
<li><a href="#orgdd5436f">3.8. Global state</a></li> <li><a href="#org144cc4b">3.8. Global state</a></li>
<li><a href="#orgfeab5b7">3.9. Headers</a></li> <li><a href="#org85de81e">3.9. Headers</a></li>
<li><a href="#org18b0b4f">3.10. Low-level functions</a></li> <li><a href="#org185bfec">3.10. Low-level functions</a></li>
<li><a href="#org1701be2">3.11. High-level functions</a></li> <li><a href="#orgefc28e5">3.11. High-level functions</a></li>
<li><a href="#orgb0e3298">3.12. Numerical precision</a></li> <li><a href="#org7f78b39">3.12. Numerical precision</a></li>
<li><a href="#orgd89e7ca">3.13. Algorithms</a></li> <li><a href="#org7cc15d8">3.13. Algorithms</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org59354f7" class="outline-2"> <div id="outline-container-org98049a5" class="outline-2">
<h2 id="org59354f7"><span class="section-number-2">1</span> Installing QMCkl</h2> <h2 id="org98049a5"><span class="section-number-2">1</span> Installing QMCkl</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The latest version fo QMCkl can be downloaded The latest version fo QMCkl can be downloaded
@ -384,8 +384,8 @@ The latest version fo QMCkl can be downloaded
</p> </p>
</div> </div>
<div id="outline-container-org3809739" class="outline-3"> <div id="outline-container-org4d096e2" class="outline-3">
<h3 id="org3809739"><span class="section-number-3">1.1</span> Installing from the released tarball (for end users)</h3> <h3 id="org4d096e2"><span class="section-number-3">1.1</span> Installing from the released tarball (for end users)</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
QMCkl is built with GNU Autotools, so the usual QMCkl is built with GNU Autotools, so the usual
@ -400,8 +400,8 @@ options are defined using <code>CFLAGS</code> and <code>FCFLAGS</code>.
</div> </div>
</div> </div>
<div id="outline-container-orgdb45e8f" class="outline-3"> <div id="outline-container-org26365f7" class="outline-3">
<h3 id="orgdb45e8f"><span class="section-number-3">1.2</span> Installing from the source repository (for developers)</h3> <h3 id="org26365f7"><span class="section-number-3">1.2</span> Installing from the source repository (for developers)</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
To compile from the source repository, additional dependencies are To compile from the source repository, additional dependencies are
@ -422,8 +422,8 @@ to be executed first.
</div> </div>
</div> </div>
<div id="outline-container-orge559a2e" class="outline-2"> <div id="outline-container-orgc659799" class="outline-2">
<h2 id="orge559a2e"><span class="section-number-2">2</span> Using QMCkl</h2> <h2 id="orgc659799"><span class="section-number-2">2</span> Using QMCkl</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The <code>qmckl.h</code> header file installed in the <code>${prefix}/include</code> directory The <code>qmckl.h</code> header file installed in the <code>${prefix}/include</code> directory
@ -452,12 +452,12 @@ Both files are located in the <code>include/</code> directory.
</div> </div>
</div> </div>
<div id="outline-container-org592df36" class="outline-2"> <div id="outline-container-org45a56f5" class="outline-2">
<h2 id="org592df36"><span class="section-number-2">3</span> Developing in QMCkl</h2> <h2 id="org45a56f5"><span class="section-number-2">3</span> Developing in QMCkl</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
</div> </div>
<div id="outline-container-org52014b1" class="outline-3"> <div id="outline-container-org37142ce" class="outline-3">
<h3 id="org52014b1"><span class="section-number-3">3.1</span> Literate programming</h3> <h3 id="org37142ce"><span class="section-number-3">3.1</span> Literate programming</h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
In a traditional source code, most of the lines of source files of a program In a traditional source code, most of the lines of source files of a program
@ -507,8 +507,8 @@ tarball contains the generated source code.
</div> </div>
</div> </div>
<div id="outline-container-org5cfc8a8" class="outline-3"> <div id="outline-container-orgdf9daa0" class="outline-3">
<h3 id="org5cfc8a8"><span class="section-number-3">3.2</span> Source code editing</h3> <h3 id="orgdf9daa0"><span class="section-number-3">3.2</span> Source code editing</h3>
<div class="outline-text-3" id="text-3-2"> <div class="outline-text-3" id="text-3-2">
<p> <p>
For a tutorial on literate programming with org-mode, follow <a href="http://www.howardism.org/Technical/Emacs/literate-programming-tutorial.html">this link</a>. For a tutorial on literate programming with org-mode, follow <a href="http://www.howardism.org/Technical/Emacs/literate-programming-tutorial.html">this link</a>.
@ -539,8 +539,8 @@ org-mode.
</div> </div>
</div> </div>
<div id="outline-container-orgf315444" class="outline-3"> <div id="outline-container-orgaebd78a" class="outline-3">
<h3 id="orgf315444"><span class="section-number-3">3.3</span> Choice of the programming language</h3> <h3 id="orgaebd78a"><span class="section-number-3">3.3</span> Choice of the programming language</h3>
<div class="outline-text-3" id="text-3-3"> <div class="outline-text-3" id="text-3-3">
<p> <p>
Most of the codes of the <a href="https://trex-coe.eu">TREX CoE</a> are written in Fortran with some Most of the codes of the <a href="https://trex-coe.eu">TREX CoE</a> are written in Fortran with some
@ -604,8 +604,8 @@ For more guidelines on using Fortran to generate a C interface, see
</div> </div>
</div> </div>
<div id="outline-container-org24eb7de" class="outline-3"> <div id="outline-container-org86c6b85" class="outline-3">
<h3 id="org24eb7de"><span class="section-number-3">3.4</span> Coding rules</h3> <h3 id="org86c6b85"><span class="section-number-3">3.4</span> Coding rules</h3>
<div class="outline-text-3" id="text-3-4"> <div class="outline-text-3" id="text-3-4">
<p> <p>
The authors should follow the recommendations of the C99 The authors should follow the recommendations of the C99
@ -625,8 +625,8 @@ make cppcheck ; cat cppcheck.out
</div> </div>
</div> </div>
<div id="outline-container-orgb841074" class="outline-3"> <div id="outline-container-orgf176230" class="outline-3">
<h3 id="orgb841074"><span class="section-number-3">3.5</span> Design of the library</h3> <h3 id="orgf176230"><span class="section-number-3">3.5</span> Design of the library</h3>
<div class="outline-text-3" id="text-3-5"> <div class="outline-text-3" id="text-3-5">
<p> <p>
The proposed API should allow the library to: deal with memory transfers The proposed API should allow the library to: deal with memory transfers
@ -637,8 +637,8 @@ functions (see below).
</div> </div>
</div> </div>
<div id="outline-container-org7c16213" class="outline-3"> <div id="outline-container-org86e103a" class="outline-3">
<h3 id="org7c16213"><span class="section-number-3">3.6</span> Naming conventions</h3> <h3 id="org86e103a"><span class="section-number-3">3.6</span> Naming conventions</h3>
<div class="outline-text-3" id="text-3-6"> <div class="outline-text-3" id="text-3-6">
<p> <p>
To avoid namespace collisions, we use <code>qmckl_</code> as a prefix for all exported To avoid namespace collisions, we use <code>qmckl_</code> as a prefix for all exported
@ -659,8 +659,8 @@ form is allowed.
</div> </div>
</div> </div>
<div id="outline-container-org44bff69" class="outline-3"> <div id="outline-container-org8f8a40a" class="outline-3">
<h3 id="org44bff69"><span class="section-number-3">3.7</span> Application programming interface</h3> <h3 id="org8f8a40a"><span class="section-number-3">3.7</span> Application programming interface</h3>
<div class="outline-text-3" id="text-3-7"> <div class="outline-text-3" id="text-3-7">
<p> <p>
In the C language, the number of bits used by the integer types can change In the C language, the number of bits used by the integer types can change
@ -692,15 +692,15 @@ bindings in other languages in other repositories.
</div> </div>
</div> </div>
<div id="outline-container-orgdd5436f" class="outline-3"> <div id="outline-container-org144cc4b" class="outline-3">
<h3 id="orgdd5436f"><span class="section-number-3">3.8</span> Global state</h3> <h3 id="org144cc4b"><span class="section-number-3">3.8</span> Global state</h3>
<div class="outline-text-3" id="text-3-8"> <div class="outline-text-3" id="text-3-8">
<p> <p>
Global variables should be avoided in the library, because it is Global variables should be avoided in the library, because it is
possible that one single program needs to use multiple instances possible that one single program needs to use multiple instances
of the library. To solve this problem we propose to use a pointer of the library. To solve this problem we propose to use a pointer
to a <a href="./qmckl_context.html"><code>context</code></a> variable, built by the library with the to a <a href="./qmckl_context.html"><code>context</code></a> variable, built by the library with the
<code>qmckl_context_create</code> function. The <a id="org91b91d2">=context=</a> contains the global <code>qmckl_context_create</code> function. The <a id="org18ada23">=context=</a> contains the global
state of the library, and is used as the first argument of many state of the library, and is used as the first argument of many
QMCkl functions. QMCkl functions.
</p> </p>
@ -714,8 +714,8 @@ the state is done by setters and getters, prefixed by
</div> </div>
</div> </div>
<div id="outline-container-orgfeab5b7" class="outline-3"> <div id="outline-container-org85de81e" class="outline-3">
<h3 id="orgfeab5b7"><span class="section-number-3">3.9</span> Headers</h3> <h3 id="org85de81e"><span class="section-number-3">3.9</span> Headers</h3>
<div class="outline-text-3" id="text-3-9"> <div class="outline-text-3" id="text-3-9">
<p> <p>
A single <code>qmckl.h</code> header to be distributed by the library A single <code>qmckl.h</code> header to be distributed by the library
@ -803,8 +803,8 @@ and the types definitions should be written in the <code>*fh_type.f90</code> fil
</div> </div>
</div> </div>
<div id="outline-container-org18b0b4f" class="outline-3"> <div id="outline-container-org185bfec" class="outline-3">
<h3 id="org18b0b4f"><span class="section-number-3">3.10</span> Low-level functions</h3> <h3 id="org185bfec"><span class="section-number-3">3.10</span> Low-level functions</h3>
<div class="outline-text-3" id="text-3-10"> <div class="outline-text-3" id="text-3-10">
<p> <p>
Low-level functions are very simple functions which are leaves of Low-level functions are very simple functions which are leaves of
@ -813,14 +813,14 @@ the function call tree (they don't call any other QMCkl function).
<p> <p>
These functions are <i>pure</i>, and unaware of the QMCkl These functions are <i>pure</i>, and unaware of the QMCkl
<a href="#org91b91d2"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and <a href="#org18ada23"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
if they need temporary memory it should be provided in input. if they need temporary memory it should be provided in input.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org1701be2" class="outline-3"> <div id="outline-container-orgefc28e5" class="outline-3">
<h3 id="org1701be2"><span class="section-number-3">3.11</span> High-level functions</h3> <h3 id="orgefc28e5"><span class="section-number-3">3.11</span> High-level functions</h3>
<div class="outline-text-3" id="text-3-11"> <div class="outline-text-3" id="text-3-11">
<p> <p>
High-level functions are at the top of the function call tree. High-level functions are at the top of the function call tree.
@ -832,8 +832,8 @@ temporary storage, to simplify the use of accelerators.
</div> </div>
</div> </div>
<div id="outline-container-orgb0e3298" class="outline-3"> <div id="outline-container-org7f78b39" class="outline-3">
<h3 id="orgb0e3298"><span class="section-number-3">3.12</span> Numerical precision</h3> <h3 id="org7f78b39"><span class="section-number-3">3.12</span> Numerical precision</h3>
<div class="outline-text-3" id="text-3-12"> <div class="outline-text-3" id="text-3-12">
<p> <p>
The minimal number of bits of precision required for a function The minimal number of bits of precision required for a function
@ -841,7 +841,7 @@ should be given as an input of low-level computational
functions. This input will be used to define the values of the functions. This input will be used to define the values of the
different thresholds that might be used to avoid computing different thresholds that might be used to avoid computing
unnecessary noise. High-level functions will use the precision unnecessary noise. High-level functions will use the precision
specified in the <a href="#org91b91d2"><code>context</code></a> variable. specified in the <a href="#org18ada23"><code>context</code></a> variable.
</p> </p>
<p> <p>
@ -909,8 +909,8 @@ following points :
</div> </div>
</div> </div>
<div id="outline-container-orgd89e7ca" class="outline-3"> <div id="outline-container-org7cc15d8" class="outline-3">
<h3 id="orgd89e7ca"><span class="section-number-3">3.13</span> Algorithms</h3> <h3 id="org7cc15d8"><span class="section-number-3">3.13</span> Algorithms</h3>
<div class="outline-text-3" id="text-3-13"> <div class="outline-text-3" id="text-3-13">
<p> <p>
Reducing the scaling of an algorithm usually implies also reducing Reducing the scaling of an algorithm usually implies also reducing
@ -926,7 +926,7 @@ implemented adapted to different problem sizes.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

218
qmckl_ao.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Atomic Orbitals</title> <title>Atomic Orbitals</title>
@ -346,62 +346,62 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org5081315">1. Introduction</a></li> <li><a href="#org21fc7fb">1. Introduction</a></li>
<li><a href="#orga337025">2. Context</a> <li><a href="#orgc7da124">2. Context</a>
<ul> <ul>
<li><a href="#orge74753e">2.1. Constant data</a> <li><a href="#orgaf69372">2.1. Constant data</a>
<ul> <ul>
<li><a href="#org768ac23">2.1.1. Initialization functions</a> <li><a href="#orgf431365">2.1.1. Initialization functions</a>
<ul> <ul>
<li><a href="#orgb0635b9">2.1.1.1. C interface</a></li> <li><a href="#orgae8bd58">2.1.1.1. C interface</a></li>
<li><a href="#orgc238c56">2.1.1.2. Fortran interface</a></li> <li><a href="#org8a93398">2.1.1.2. Fortran interface</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org5c05ff4">2.1.2. Access functions</a> <li><a href="#org1ccfdf8">2.1.2. Access functions</a>
<ul> <ul>
<li><a href="#org5bc2c46">2.1.2.1. C interface</a></li> <li><a href="#orgad66d58">2.1.2.1. C interface</a></li>
<li><a href="#org6cec143">2.1.2.2. Fortran interface</a></li> <li><a href="#org5ed9e54">2.1.2.2. Fortran interface</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org7b8eec0">2.2. Computed data</a> <li><a href="#org54a1186">2.2. Computed data</a>
<ul> <ul>
<li><a href="#orgc87d99e">2.2.1. After initialization</a></li> <li><a href="#orgaa07aae">2.2.1. After initialization</a></li>
<li><a href="#orgbda6e2f">2.2.2. <span class="todo TODO">TODO</span> HPC-specific data structures</a></li> <li><a href="#orgc897e08">2.2.2. <span class="todo TODO">TODO</span> HPC-specific data structures</a></li>
<li><a href="#org6ef0407">2.2.3. Access functions</a></li> <li><a href="#orgf6bd905">2.2.3. Access functions</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org25a518f">3. Radial part</a> <li><a href="#orgb1bc7a2">3. Radial part</a>
<ul> <ul>
<li><a href="#org0b26fc2">3.1. General functions for Gaussian basis functions</a></li> <li><a href="#orgf3e8b1d">3.1. General functions for Gaussian basis functions</a></li>
<li><a href="#org7e1161f">3.2. Computation of primitives</a></li> <li><a href="#orgc03755f">3.2. Computation of primitives</a></li>
<li><a href="#orgb0db339">3.3. Computation of shells</a></li> <li><a href="#org5f19567">3.3. Computation of shells</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org4274f23">4. Polynomial part</a> <li><a href="#org8a09a7a">4. Polynomial part</a>
<ul> <ul>
<li><a href="#orgba6b33c">4.1. General functions for Powers of \(x-X_i\)</a></li> <li><a href="#org8fa8cb8">4.1. General functions for Powers of \(x-X_i\)</a></li>
<li><a href="#org92d7897">4.2. General functions for Value, Gradient and Laplacian of a polynomial</a></li> <li><a href="#org9a5c907">4.2. General functions for Value, Gradient and Laplacian of a polynomial</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org7ace495">5. Combining radial and polynomial parts</a> <li><a href="#org193daff">5. Combining radial and polynomial parts</a>
<ul> <ul>
<li><a href="#orgee35001">5.1. Determination of nucleus ranges</a></li> <li><a href="#orgfbdb827">5.1. Determination of nucleus ranges</a></li>
<li><a href="#org9349910">5.2. Values only</a> <li><a href="#orgb1a2e00">5.2. Values only</a>
<ul> <ul>
<li><a href="#org64a47f5">5.2.1. Unoptimized version</a></li> <li><a href="#orgc6012b4">5.2.1. Unoptimized version</a></li>
<li><a href="#org442e065">5.2.2. HPC version</a></li> <li><a href="#orgaca3c9b">5.2.2. HPC version</a></li>
<li><a href="#org1326a7d">5.2.3. Interfaces</a></li> <li><a href="#org9c7c31f">5.2.3. Interfaces</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org0049ac6">5.3. Value, gradients, Laplacian</a> <li><a href="#org2255960">5.3. Value, gradients, Laplacian</a>
<ul> <ul>
<li><a href="#orgd383c11">5.3.1. Reference version</a></li> <li><a href="#orgc8e34bc">5.3.1. Reference version</a></li>
<li><a href="#orgf4c075d">5.3.2. HPC version</a></li> <li><a href="#orgdea186a">5.3.2. HPC version</a></li>
<li><a href="#orga4b8da4">5.3.3. Interfaces</a></li> <li><a href="#orgc183942">5.3.3. Interfaces</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -410,8 +410,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org5081315" class="outline-2"> <div id="outline-container-org21fc7fb" class="outline-2">
<h2 id="org5081315"><span class="section-number-2">1</span> Introduction</h2> <h2 id="org21fc7fb"><span class="section-number-2">1</span> Introduction</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The atomic basis set is defined as a list of shells. Each shell \(s\) is The atomic basis set is defined as a list of shells. Each shell \(s\) is
@ -464,19 +464,19 @@ gradients and Laplacian of the atomic basis functions.
</div> </div>
</div> </div>
<div id="outline-container-orga337025" class="outline-2"> <div id="outline-container-orgc7da124" class="outline-2">
<h2 id="orga337025"><span class="section-number-2">2</span> Context</h2> <h2 id="orgc7da124"><span class="section-number-2">2</span> Context</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-orge74753e" class="outline-3"> <div id="outline-container-orgaf69372" class="outline-3">
<h3 id="orge74753e"><span class="section-number-3">2.1</span> Constant data</h3> <h3 id="orgaf69372"><span class="section-number-3">2.1</span> Constant data</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
The following arrays are stored in the context, and need to be set The following arrays are stored in the context, and need to be set
when initializing the library: when initializing the library:
</p> </p>
<table id="org9e345ba" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgb66fc3d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -710,7 +710,7 @@ calling the functions:
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-C" id="org047e59c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_set_ao_basis_$V$</span> ( <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <pre class="src src-C" id="org31e4052"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_set_ao_basis_$V$</span> ( <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #a020f0;">const</span> $type_of_V$ $V$); <span style="color: #a020f0;">const</span> $type_of_V$ $V$);
<span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_ao_basis_$V$</span> ( <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_ao_basis_$V$</span> ( <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
@ -747,7 +747,7 @@ For array variables, use the rule:
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-C" id="org4894c02"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_set_ao_basis_$V$</span> ( <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <pre class="src src-C" id="org237ac51"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_set_ao_basis_$V$</span> ( <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #a020f0;">const</span> $type_of_V$ $V$, <span style="color: #a020f0;">const</span> $type_of_V$ $V$,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>); <span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>);
@ -785,17 +785,17 @@ For array variables, use the rule:
</div> </div>
</div> </div>
<div id="outline-container-org768ac23" class="outline-4"> <div id="outline-container-orgf431365" class="outline-4">
<h4 id="org768ac23"><span class="section-number-4">2.1.1</span> Initialization functions</h4> <h4 id="orgf431365"><span class="section-number-4">2.1.1</span> Initialization functions</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<p> <p>
<code>size_max</code> is the dimension of the input array, which should be <code>size_max</code> is the dimension of the input array, which should be
equal of larger than the value given in the table of section <a href="#orga337025">2</a>. equal of larger than the value given in the table of section <a href="#orgc7da124">2</a>.
</p> </p>
</div> </div>
<div id="outline-container-orgb0635b9" class="outline-5"> <div id="outline-container-orgae8bd58" class="outline-5">
<h5 id="orgb0635b9"><span class="section-number-5">2.1.1.1</span> C interface</h5> <h5 id="orgae8bd58"><span class="section-number-5">2.1.1.1</span> C interface</h5>
<div class="outline-text-5" id="text-2-1-1-1"> <div class="outline-text-5" id="text-2-1-1-1">
<p> <p>
To set the basis set, all the following functions need to be To set the basis set, all the following functions need to be
@ -919,8 +919,8 @@ called.
</div> </div>
</div> </div>
<div id="outline-container-orgc238c56" class="outline-5"> <div id="outline-container-org8a93398" class="outline-5">
<h5 id="orgc238c56"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5> <h5 id="org8a93398"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5>
<div class="outline-text-5" id="text-2-1-1-2"> <div class="outline-text-5" id="text-2-1-1-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">interface</span> <pre class="src src-f90"><span style="color: #a020f0;">interface</span>
@ -1103,17 +1103,17 @@ called.
</div> </div>
</div> </div>
<div id="outline-container-org5c05ff4" class="outline-4"> <div id="outline-container-org1ccfdf8" class="outline-4">
<h4 id="org5c05ff4"><span class="section-number-4">2.1.2</span> Access functions</h4> <h4 id="org1ccfdf8"><span class="section-number-4">2.1.2</span> Access functions</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<p> <p>
<code>size_max</code> is the dimension of the input array, which should be <code>size_max</code> is the dimension of the input array, which should be
equal of larger than the value given in the table of section <a href="#orga337025">2</a>. equal of larger than the value given in the table of section <a href="#orgc7da124">2</a>.
</p> </p>
</div> </div>
<div id="outline-container-org5bc2c46" class="outline-5"> <div id="outline-container-orgad66d58" class="outline-5">
<h5 id="org5bc2c46"><span class="section-number-5">2.1.2.1</span> C interface</h5> <h5 id="orgad66d58"><span class="section-number-5">2.1.2.1</span> C interface</h5>
<div class="outline-text-5" id="text-2-1-2-1"> <div class="outline-text-5" id="text-2-1-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -1235,8 +1235,8 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-org6cec143" class="outline-5"> <div id="outline-container-org5ed9e54" class="outline-5">
<h5 id="org6cec143"><span class="section-number-5">2.1.2.2</span> Fortran interface</h5> <h5 id="org5ed9e54"><span class="section-number-5">2.1.2.2</span> Fortran interface</h5>
<div class="outline-text-5" id="text-2-1-2-2"> <div class="outline-text-5" id="text-2-1-2-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">interface</span> <pre class="src src-f90"><span style="color: #a020f0;">interface</span>
@ -1420,8 +1420,8 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-org7b8eec0" class="outline-3"> <div id="outline-container-org54a1186" class="outline-3">
<h3 id="org7b8eec0"><span class="section-number-3">2.2</span> Computed data</h3> <h3 id="org54a1186"><span class="section-number-3">2.2</span> Computed data</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
The following data is computed as described in the next sections: The following data is computed as described in the next sections:
@ -1496,8 +1496,8 @@ The following data is computed as described in the next sections:
</table> </table>
</div> </div>
<div id="outline-container-orgc87d99e" class="outline-4"> <div id="outline-container-orgaa07aae" class="outline-4">
<h4 id="orgc87d99e"><span class="section-number-4">2.2.1</span> After initialization</h4> <h4 id="orgaa07aae"><span class="section-number-4">2.2.1</span> After initialization</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<p> <p>
When the basis set is completely entered, extra data structures may be When the basis set is completely entered, extra data structures may be
@ -1511,8 +1511,8 @@ the context.
</div> </div>
</div> </div>
<div id="outline-container-orgbda6e2f" class="outline-4"> <div id="outline-container-orgc897e08" class="outline-4">
<h4 id="orgbda6e2f"><span class="section-number-4">2.2.2</span> <span class="todo TODO">TODO</span> HPC-specific data structures</h4> <h4 id="orgc897e08"><span class="section-number-4">2.2.2</span> <span class="todo TODO">TODO</span> HPC-specific data structures</h4>
<div class="outline-text-4" id="text-2-2-2"> <div class="outline-text-4" id="text-2-2-2">
<p> <p>
For faster access, we provide extra arrays for the shell information as: For faster access, we provide extra arrays for the shell information as:
@ -1542,8 +1542,8 @@ which is a matrix-vector product.
</div> </div>
</div> </div>
<div id="outline-container-org6ef0407" class="outline-4"> <div id="outline-container-orgf6bd905" class="outline-4">
<h4 id="org6ef0407"><span class="section-number-4">2.2.3</span> Access functions</h4> <h4 id="orgf6bd905"><span class="section-number-4">2.2.3</span> Access functions</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -1556,7 +1556,7 @@ which is a matrix-vector product.
<p> <p>
Returns the array of values, gradients an Laplacian of primitive Returns the array of values, gradients an Laplacian of primitive
basis functions evaluated at the current coordinates. basis functions evaluated at the current coordinates.
See section <a href="#org7e1161f">3.2</a>. See section <a href="#orgc03755f">3.2</a>.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
@ -1569,7 +1569,7 @@ See section <a href="#org7e1161f">3.2</a>.
<p> <p>
Returns the array of values, gradients an Laplacian of contracted shells Returns the array of values, gradients an Laplacian of contracted shells
evaluated at the current coordinates. See section <a href="#orgb0db339">3.3</a>. evaluated at the current coordinates. See section <a href="#org5f19567">3.3</a>.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
@ -1583,7 +1583,7 @@ evaluated at the current coordinates. See section <a href="#orgb0db339">3.3</a>.
<p> <p>
Returns the array of values, gradients an Laplacian of the atomic orbitals Returns the array of values, gradients an Laplacian of the atomic orbitals
evaluated at the current coordinates. evaluated at the current coordinates.
See section <a href="#org7ace495">5</a>. See section <a href="#org193daff">5</a>.
</p> </p>
<p> <p>
@ -1608,7 +1608,7 @@ Uses the given array to compute the VGL.
<p> <p>
Returns the array of values of the atomic orbitals evaluated at Returns the array of values of the atomic orbitals evaluated at
the current coordinates. See section <a href="#org7ace495">5</a>. the current coordinates. See section <a href="#org193daff">5</a>.
</p> </p>
<p> <p>
@ -1627,12 +1627,12 @@ Uses the given array to compute the value.
</div> </div>
</div> </div>
<div id="outline-container-org25a518f" class="outline-2"> <div id="outline-container-orgb1bc7a2" class="outline-2">
<h2 id="org25a518f"><span class="section-number-2">3</span> Radial part</h2> <h2 id="orgb1bc7a2"><span class="section-number-2">3</span> Radial part</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
</div> </div>
<div id="outline-container-org0b26fc2" class="outline-3"> <div id="outline-container-orgf3e8b1d" class="outline-3">
<h3 id="org0b26fc2"><span class="section-number-3">3.1</span> General functions for Gaussian basis functions</h3> <h3 id="orgf3e8b1d"><span class="section-number-3">3.1</span> General functions for Gaussian basis functions</h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
<code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and <code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and
@ -1806,10 +1806,10 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org7e1161f" class="outline-3"> <div id="outline-container-orgc03755f" class="outline-3">
<h3 id="org7e1161f"><span class="section-number-3">3.2</span> Computation of primitives</h3> <h3 id="orgc03755f"><span class="section-number-3">3.2</span> Computation of primitives</h3>
<div class="outline-text-3" id="text-3-2"> <div class="outline-text-3" id="text-3-2">
<table id="org7defe24" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org6fff49d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1971,10 +1971,10 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-orgb0db339" class="outline-3"> <div id="outline-container-org5f19567" class="outline-3">
<h3 id="orgb0db339"><span class="section-number-3">3.3</span> Computation of shells</h3> <h3 id="org5f19567"><span class="section-number-3">3.3</span> Computation of shells</h3>
<div class="outline-text-3" id="text-3-3"> <div class="outline-text-3" id="text-3-3">
<table id="orgb8080fe" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org595ec2e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -2230,8 +2230,8 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org4274f23" class="outline-2"> <div id="outline-container-org8a09a7a" class="outline-2">
<h2 id="org4274f23"><span class="section-number-2">4</span> Polynomial part</h2> <h2 id="org8a09a7a"><span class="section-number-2">4</span> Polynomial part</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
Going from the atomic basis set to AOs implies a systematic Going from the atomic basis set to AOs implies a systematic
@ -2251,8 +2251,8 @@ f & : & f_{xxx}, f_{xxy}, f_{xxz}, f_{xyy}, f_{xyz}, f_{xzz}, f_{yyy}, f_{yyz},
\end{eqnarray} \end{eqnarray}
</div> </div>
<div id="outline-container-orgba6b33c" class="outline-3"> <div id="outline-container-org8fa8cb8" class="outline-3">
<h3 id="orgba6b33c"><span class="section-number-3">4.1</span> General functions for Powers of \(x-X_i\)</h3> <h3 id="org8fa8cb8"><span class="section-number-3">4.1</span> General functions for Powers of \(x-X_i\)</h3>
<div class="outline-text-3" id="text-4-1"> <div class="outline-text-3" id="text-4-1">
<p> <p>
The <code>qmckl_ao_power</code> function computes all the powers of the <code>n</code> The <code>qmckl_ao_power</code> function computes all the powers of the <code>n</code>
@ -2264,7 +2264,7 @@ the \(n\) points:
\[ P_{ik} = X_i^k \] \[ P_{ik} = X_i^k \]
</p> </p>
<table id="org5dd0e38" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org10f7be0" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -2407,8 +2407,8 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org92d7897" class="outline-3"> <div id="outline-container-org9a5c907" class="outline-3">
<h3 id="org92d7897"><span class="section-number-3">4.2</span> General functions for Value, Gradient and Laplacian of a polynomial</h3> <h3 id="org9a5c907"><span class="section-number-3">4.2</span> General functions for Value, Gradient and Laplacian of a polynomial</h3>
<div class="outline-text-3" id="text-4-2"> <div class="outline-text-3" id="text-4-2">
<p> <p>
A polynomial is centered on a nucleus \(\mathbf{R}_i\) A polynomial is centered on a nucleus \(\mathbf{R}_i\)
@ -2453,7 +2453,7 @@ Laplacians at a given point in space, of all polynomials with an
angular momentum up to <code>lmax</code>. angular momentum up to <code>lmax</code>.
</p> </p>
<table id="org973a503" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga9a4f95" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -3248,12 +3248,12 @@ For example, with a=0, b=2 and c=1 the string is "yyz"</li>
</div> </div>
</div> </div>
<div id="outline-container-org7ace495" class="outline-2"> <div id="outline-container-org193daff" class="outline-2">
<h2 id="org7ace495"><span class="section-number-2">5</span> Combining radial and polynomial parts</h2> <h2 id="org193daff"><span class="section-number-2">5</span> Combining radial and polynomial parts</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
</div> </div>
<div id="outline-container-orgee35001" class="outline-3"> <div id="outline-container-orgfbdb827" class="outline-3">
<h3 id="orgee35001"><span class="section-number-3">5.1</span> Determination of nucleus ranges</h3> <h3 id="orgfbdb827"><span class="section-number-3">5.1</span> Determination of nucleus ranges</h3>
<div class="outline-text-3" id="text-5-1"> <div class="outline-text-3" id="text-5-1">
<p> <p>
The range of a nucleus is defined as the distance beyond which all The range of a nucleus is defined as the distance beyond which all
@ -3420,14 +3420,14 @@ of bits of precision (1-53), a range is given.
</div> </div>
</div> </div>
<div id="outline-container-org9349910" class="outline-3"> <div id="outline-container-orgb1a2e00" class="outline-3">
<h3 id="org9349910"><span class="section-number-3">5.2</span> Values only</h3> <h3 id="orgb1a2e00"><span class="section-number-3">5.2</span> Values only</h3>
<div class="outline-text-3" id="text-5-2"> <div class="outline-text-3" id="text-5-2">
</div> </div>
<div id="outline-container-org64a47f5" class="outline-4"> <div id="outline-container-orgc6012b4" class="outline-4">
<h4 id="org64a47f5"><span class="section-number-4">5.2.1</span> Unoptimized version</h4> <h4 id="orgc6012b4"><span class="section-number-4">5.2.1</span> Unoptimized version</h4>
<div class="outline-text-4" id="text-5-2-1"> <div class="outline-text-4" id="text-5-2-1">
<table id="org5f3d806" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgd196a6f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -3667,10 +3667,10 @@ of bits of precision (1-53), a range is given.
</div> </div>
</div> </div>
<div id="outline-container-org442e065" class="outline-4"> <div id="outline-container-orgaca3c9b" class="outline-4">
<h4 id="org442e065"><span class="section-number-4">5.2.2</span> HPC version</h4> <h4 id="orgaca3c9b"><span class="section-number-4">5.2.2</span> HPC version</h4>
<div class="outline-text-4" id="text-5-2-2"> <div class="outline-text-4" id="text-5-2-2">
<table id="org1195f28" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org0ba30ed" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -3828,8 +3828,8 @@ of bits of precision (1-53), a range is given.
</div> </div>
</div> </div>
<div id="outline-container-org1326a7d" class="outline-4"> <div id="outline-container-org9c7c31f" class="outline-4">
<h4 id="org1326a7d"><span class="section-number-4">5.2.3</span> Interfaces</h4> <h4 id="org9c7c31f"><span class="section-number-4">5.2.3</span> Interfaces</h4>
<div class="outline-text-4" id="text-5-2-3"> <div class="outline-text-4" id="text-5-2-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_compute_ao_value_doc</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_compute_ao_value_doc</span> (
@ -3878,14 +3878,14 @@ of bits of precision (1-53), a range is given.
</div> </div>
</div> </div>
<div id="outline-container-org0049ac6" class="outline-3"> <div id="outline-container-org2255960" class="outline-3">
<h3 id="org0049ac6"><span class="section-number-3">5.3</span> Value, gradients, Laplacian</h3> <h3 id="org2255960"><span class="section-number-3">5.3</span> Value, gradients, Laplacian</h3>
<div class="outline-text-3" id="text-5-3"> <div class="outline-text-3" id="text-5-3">
</div> </div>
<div id="outline-container-orgd383c11" class="outline-4"> <div id="outline-container-orgc8e34bc" class="outline-4">
<h4 id="orgd383c11"><span class="section-number-4">5.3.1</span> Reference version</h4> <h4 id="orgc8e34bc"><span class="section-number-4">5.3.1</span> Reference version</h4>
<div class="outline-text-4" id="text-5-3-1"> <div class="outline-text-4" id="text-5-3-1">
<table id="orgde5ad49" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org45bd183" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -4153,10 +4153,10 @@ of bits of precision (1-53), a range is given.
</div> </div>
</div> </div>
<div id="outline-container-orgf4c075d" class="outline-4"> <div id="outline-container-orgdea186a" class="outline-4">
<h4 id="orgf4c075d"><span class="section-number-4">5.3.2</span> HPC version</h4> <h4 id="orgdea186a"><span class="section-number-4">5.3.2</span> HPC version</h4>
<div class="outline-text-4" id="text-5-3-2"> <div class="outline-text-4" id="text-5-3-2">
<table id="orgaa9c192" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org375e4f3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -4315,8 +4315,8 @@ of bits of precision (1-53), a range is given.
</div> </div>
<div id="outline-container-orga4b8da4" class="outline-4"> <div id="outline-container-orgc183942" class="outline-4">
<h4 id="orga4b8da4"><span class="section-number-4">5.3.3</span> Interfaces</h4> <h4 id="orgc183942"><span class="section-number-4">5.3.3</span> Interfaces</h4>
<div class="outline-text-4" id="text-5-3-3"> <div class="outline-text-4" id="text-5-3-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_compute_ao_vgl_doc</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_compute_ao_vgl_doc</span> (
@ -4368,7 +4368,7 @@ of bits of precision (1-53), a range is given.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

184
qmckl_blas.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>BLAS functions</title> <title>BLAS functions</title>
@ -346,56 +346,56 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org71fdbc5">-</a></li> <li><a href="#org391430d">-</a></li>
<li><a href="#org7fc010a">1. Data types</a> <li><a href="#org9674863">1. Data types</a>
<ul> <ul>
<li><a href="#org1e1d150">1.1. Vector</a></li> <li><a href="#org4954244">1.1. Vector</a></li>
<li><a href="#org923e613">1.2. Matrix</a></li> <li><a href="#org1ec7467">1.2. Matrix</a></li>
<li><a href="#orge2581a0">1.3. Tensor</a></li> <li><a href="#org66209d6">1.3. Tensor</a></li>
<li><a href="#org097b898">1.4. Reshaping</a> <li><a href="#org77d034f">1.4. Reshaping</a>
<ul> <ul>
<li><a href="#org957dd86">1.4.1. Vector -&gt; Matrix</a></li> <li><a href="#orgf8187e5">1.4.1. Vector -&gt; Matrix</a></li>
<li><a href="#orga9d6c51">1.4.2. Vector -&gt; Tensor</a></li> <li><a href="#org3caec0a">1.4.2. Vector -&gt; Tensor</a></li>
<li><a href="#org1364b51">1.4.3. Matrix -&gt; Vector</a></li> <li><a href="#orgc425ec0">1.4.3. Matrix -&gt; Vector</a></li>
<li><a href="#orgaf14aa9">1.4.4. Matrix -&gt; Tensor</a></li> <li><a href="#org5c85f3b">1.4.4. Matrix -&gt; Tensor</a></li>
<li><a href="#orgf45cce9">1.4.5. Tensor -&gt; Vector</a></li> <li><a href="#orgb65ced3">1.4.5. Tensor -&gt; Vector</a></li>
<li><a href="#orgf0e85c3">1.4.6. Tensor -&gt; Matrix</a></li> <li><a href="#orgd0889d2">1.4.6. Tensor -&gt; Matrix</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org156f22c">1.5. Access macros</a></li> <li><a href="#org35a37b3">1.5. Access macros</a></li>
<li><a href="#org453dffb">1.6. Set all elements</a> <li><a href="#org294ab8e">1.6. Set all elements</a>
<ul> <ul>
<li><a href="#orgfbcd531">1.6.1. Vector</a></li> <li><a href="#org3362fd5">1.6.1. Vector</a></li>
<li><a href="#orgd2c3721">1.6.2. Matrix</a></li> <li><a href="#org81af898">1.6.2. Matrix</a></li>
<li><a href="#org9e054ad">1.6.3. Tensor</a></li> <li><a href="#orgddd96fd">1.6.3. Tensor</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org4947267">1.7. Copy to/from to <code>double*</code></a></li> <li><a href="#org0761f3e">1.7. Copy to/from to <code>double*</code></a></li>
<li><a href="#org66c28be">1.8. Allocate and copy to <code>double*</code></a></li> <li><a href="#orga532af7">1.8. Allocate and copy to <code>double*</code></a></li>
</ul> </ul>
</li> </li>
<li><a href="#org48f431b">2. Matrix operations</a> <li><a href="#orgcfac69c">2. Matrix operations</a>
<ul> <ul>
<li><a href="#org592f0e1">2.1. <code>qmckl_dgemm</code></a></li> <li><a href="#org5daa417">2.1. <code>qmckl_dgemm</code></a></li>
<li><a href="#org5d733c0">2.2. <code>qmckl_dgemm_safe</code></a></li> <li><a href="#orgaf6c7c6">2.2. <code>qmckl_dgemm_safe</code></a></li>
<li><a href="#org9987bef">2.3. <code>qmckl_matmul</code></a></li> <li><a href="#org95ec930">2.3. <code>qmckl_matmul</code></a></li>
<li><a href="#orgbd6ac75">2.4. <code>qmckl_adjugate</code></a></li> <li><a href="#orgc7af985">2.4. <code>qmckl_adjugate</code></a></li>
<li><a href="#orga12e50b">2.5. <code>qmckl_adjugate_safe</code></a> <li><a href="#orga42244c">2.5. <code>qmckl_adjugate_safe</code></a>
<ul> <ul>
<li><a href="#orgd5a609b">2.5.1. C interface</a></li> <li><a href="#org146fd13">2.5.1. C interface</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org3b5df23">2.6. <code>qmckl_transpose</code></a></li> <li><a href="#org8638cb7">2.6. <code>qmckl_transpose</code></a></li>
</ul> </ul>
</li> </li>
<li><a href="#org6130c41">3. Utilities</a></li> <li><a href="#orgfa5d12c">3. Utilities</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org71fdbc5" class="outline-2"> <div id="outline-container-org391430d" class="outline-2">
<h2 id="org71fdbc5">-</h2> <h2 id="org391430d">-</h2>
<div class="outline-text-2" id="text-org71fdbc5"> <div class="outline-text-2" id="text-org391430d">
<p> <p>
Basic linear algebra data types and operations are described in this file. Basic linear algebra data types and operations are described in this file.
The data types are private, so that HPC implementations can use The data types are private, so that HPC implementations can use
@ -409,12 +409,12 @@ are not intended to be passed to external codes.
</div> </div>
</div> </div>
<div id="outline-container-org7fc010a" class="outline-2"> <div id="outline-container-org9674863" class="outline-2">
<h2 id="org7fc010a"><span class="section-number-2">1</span> Data types</h2> <h2 id="org9674863"><span class="section-number-2">1</span> Data types</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-org1e1d150" class="outline-3"> <div id="outline-container-org4954244" class="outline-3">
<h3 id="org1e1d150"><span class="section-number-3">1.1</span> Vector</h3> <h3 id="org4954244"><span class="section-number-3">1.1</span> Vector</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
@ -468,8 +468,8 @@ Allocates a new vector. If the allocation failed the size is zero.
</div> </div>
</div> </div>
<div id="outline-container-org923e613" class="outline-3"> <div id="outline-container-org1ec7467" class="outline-3">
<h3 id="org923e613"><span class="section-number-3">1.2</span> Matrix</h3> <h3 id="org1ec7467"><span class="section-number-3">1.2</span> Matrix</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
@ -529,8 +529,8 @@ Allocates a new matrix. If the allocation failed the sizes are zero.
</div> </div>
</div> </div>
<div id="outline-container-orge2581a0" class="outline-3"> <div id="outline-container-org66209d6" class="outline-3">
<h3 id="orge2581a0"><span class="section-number-3">1.3</span> Tensor</h3> <h3 id="org66209d6"><span class="section-number-3">1.3</span> Tensor</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
@ -597,16 +597,16 @@ is zero.
</div> </div>
</div> </div>
<div id="outline-container-org097b898" class="outline-3"> <div id="outline-container-org77d034f" class="outline-3">
<h3 id="org097b898"><span class="section-number-3">1.4</span> Reshaping</h3> <h3 id="org77d034f"><span class="section-number-3">1.4</span> Reshaping</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<p> <p>
Reshaping occurs in-place and the pointer to the data is copied. Reshaping occurs in-place and the pointer to the data is copied.
</p> </p>
</div> </div>
<div id="outline-container-org957dd86" class="outline-4"> <div id="outline-container-orgf8187e5" class="outline-4">
<h4 id="org957dd86"><span class="section-number-4">1.4.1</span> Vector -&gt; Matrix</h4> <h4 id="orgf8187e5"><span class="section-number-4">1.4.1</span> Vector -&gt; Matrix</h4>
<div class="outline-text-4" id="text-1-4-1"> <div class="outline-text-4" id="text-1-4-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span>
@ -622,8 +622,8 @@ Reshapes a vector into a matrix.
</div> </div>
</div> </div>
<div id="outline-container-orga9d6c51" class="outline-4"> <div id="outline-container-org3caec0a" class="outline-4">
<h4 id="orga9d6c51"><span class="section-number-4">1.4.2</span> Vector -&gt; Tensor</h4> <h4 id="org3caec0a"><span class="section-number-4">1.4.2</span> Vector -&gt; Tensor</h4>
<div class="outline-text-4" id="text-1-4-2"> <div class="outline-text-4" id="text-1-4-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span>
@ -639,8 +639,8 @@ Reshapes a vector into a tensor.
</div> </div>
</div> </div>
<div id="outline-container-org1364b51" class="outline-4"> <div id="outline-container-orgc425ec0" class="outline-4">
<h4 id="org1364b51"><span class="section-number-4">1.4.3</span> Matrix -&gt; Vector</h4> <h4 id="orgc425ec0"><span class="section-number-4">1.4.3</span> Matrix -&gt; Vector</h4>
<div class="outline-text-4" id="text-1-4-3"> <div class="outline-text-4" id="text-1-4-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span>
@ -654,8 +654,8 @@ Reshapes a matrix into a vector.
</div> </div>
</div> </div>
<div id="outline-container-orgaf14aa9" class="outline-4"> <div id="outline-container-org5c85f3b" class="outline-4">
<h4 id="orgaf14aa9"><span class="section-number-4">1.4.4</span> Matrix -&gt; Tensor</h4> <h4 id="org5c85f3b"><span class="section-number-4">1.4.4</span> Matrix -&gt; Tensor</h4>
<div class="outline-text-4" id="text-1-4-4"> <div class="outline-text-4" id="text-1-4-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span>
@ -671,8 +671,8 @@ Reshapes a matrix into a tensor.
</div> </div>
</div> </div>
<div id="outline-container-orgf45cce9" class="outline-4"> <div id="outline-container-orgb65ced3" class="outline-4">
<h4 id="orgf45cce9"><span class="section-number-4">1.4.5</span> Tensor -&gt; Vector</h4> <h4 id="orgb65ced3"><span class="section-number-4">1.4.5</span> Tensor -&gt; Vector</h4>
<div class="outline-text-4" id="text-1-4-5"> <div class="outline-text-4" id="text-1-4-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span>
@ -686,8 +686,8 @@ Reshapes a tensor into a vector.
</div> </div>
</div> </div>
<div id="outline-container-orgf0e85c3" class="outline-4"> <div id="outline-container-orgd0889d2" class="outline-4">
<h4 id="orgf0e85c3"><span class="section-number-4">1.4.6</span> Tensor -&gt; Matrix</h4> <h4 id="orgd0889d2"><span class="section-number-4">1.4.6</span> Tensor -&gt; Matrix</h4>
<div class="outline-text-4" id="text-1-4-6"> <div class="outline-text-4" id="text-1-4-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span>
@ -704,8 +704,8 @@ Reshapes a tensor into a vector.
</div> </div>
</div> </div>
<div id="outline-container-org156f22c" class="outline-3"> <div id="outline-container-org35a37b3" class="outline-3">
<h3 id="org156f22c"><span class="section-number-3">1.5</span> Access macros</h3> <h3 id="org35a37b3"><span class="section-number-3">1.5</span> Access macros</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<p> <p>
Macros are provided to ease the access to vectors, matrices and Macros are provided to ease the access to vectors, matrices and
@ -730,12 +730,12 @@ For example:
</div> </div>
</div> </div>
<div id="outline-container-org453dffb" class="outline-3"> <div id="outline-container-org294ab8e" class="outline-3">
<h3 id="org453dffb"><span class="section-number-3">1.6</span> Set all elements</h3> <h3 id="org294ab8e"><span class="section-number-3">1.6</span> Set all elements</h3>
<div class="outline-text-3" id="text-1-6"> <div class="outline-text-3" id="text-1-6">
</div> </div>
<div id="outline-container-orgfbcd531" class="outline-4"> <div id="outline-container-org3362fd5" class="outline-4">
<h4 id="orgfbcd531"><span class="section-number-4">1.6.1</span> Vector</h4> <h4 id="org3362fd5"><span class="section-number-4">1.6.1</span> Vector</h4>
<div class="outline-text-4" id="text-1-6-1"> <div class="outline-text-4" id="text-1-6-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_vector</span>
@ -745,8 +745,8 @@ For example:
</div> </div>
</div> </div>
<div id="outline-container-orgd2c3721" class="outline-4"> <div id="outline-container-org81af898" class="outline-4">
<h4 id="orgd2c3721"><span class="section-number-4">1.6.2</span> Matrix</h4> <h4 id="org81af898"><span class="section-number-4">1.6.2</span> Matrix</h4>
<div class="outline-text-4" id="text-1-6-2"> <div class="outline-text-4" id="text-1-6-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_matrix</span>
@ -756,8 +756,8 @@ For example:
</div> </div>
</div> </div>
<div id="outline-container-org9e054ad" class="outline-4"> <div id="outline-container-orgddd96fd" class="outline-4">
<h4 id="org9e054ad"><span class="section-number-4">1.6.3</span> Tensor</h4> <h4 id="orgddd96fd"><span class="section-number-4">1.6.3</span> Tensor</h4>
<div class="outline-text-4" id="text-1-6-3"> <div class="outline-text-4" id="text-1-6-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_tensor</span>
@ -768,8 +768,8 @@ For example:
</div> </div>
</div> </div>
<div id="outline-container-org4947267" class="outline-3"> <div id="outline-container-org0761f3e" class="outline-3">
<h3 id="org4947267"><span class="section-number-3">1.7</span> Copy to/from to <code>double*</code></h3> <h3 id="org0761f3e"><span class="section-number-3">1.7</span> Copy to/from to <code>double*</code></h3>
<div class="outline-text-3" id="text-1-7"> <div class="outline-text-3" id="text-1-7">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -851,8 +851,8 @@ Converts a <code>double*</code> to a tensor.
</div> </div>
</div> </div>
<div id="outline-container-org66c28be" class="outline-3"> <div id="outline-container-orga532af7" class="outline-3">
<h3 id="org66c28be"><span class="section-number-3">1.8</span> Allocate and copy to <code>double*</code></h3> <h3 id="orga532af7"><span class="section-number-3">1.8</span> Allocate and copy to <code>double*</code></h3>
<div class="outline-text-3" id="text-1-8"> <div class="outline-text-3" id="text-1-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">double</span>* <span style="color: #0000ff;">qmckl_alloc_double_of_vector</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <pre class="src src-c"><span style="color: #228b22;">double</span>* <span style="color: #0000ff;">qmckl_alloc_double_of_vector</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
@ -876,12 +876,12 @@ Converts a <code>double*</code> to a tensor.
</div> </div>
</div> </div>
<div id="outline-container-org48f431b" class="outline-2"> <div id="outline-container-orgcfac69c" class="outline-2">
<h2 id="org48f431b"><span class="section-number-2">2</span> Matrix operations</h2> <h2 id="orgcfac69c"><span class="section-number-2">2</span> Matrix operations</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org592f0e1" class="outline-3"> <div id="outline-container-org5daa417" class="outline-3">
<h3 id="org592f0e1"><span class="section-number-3">2.1</span> <code>qmckl_dgemm</code></h3> <h3 id="org5daa417"><span class="section-number-3">2.1</span> <code>qmckl_dgemm</code></h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
Matrix multiplication with a BLAS interface: Matrix multiplication with a BLAS interface:
@ -893,7 +893,7 @@ Matrix multiplication with a BLAS interface:
\] \]
</p> </p>
<table id="org5824d51" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgd425c16" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1052,8 +1052,8 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org5d733c0" class="outline-3"> <div id="outline-container-orgaf6c7c6" class="outline-3">
<h3 id="org5d733c0"><span class="section-number-3">2.2</span> <code>qmckl_dgemm_safe</code></h3> <h3 id="orgaf6c7c6"><span class="section-number-3">2.2</span> <code>qmckl_dgemm_safe</code></h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
"Size-safe" proxy function with the same functionality as <code>qmckl_dgemm</code> "Size-safe" proxy function with the same functionality as <code>qmckl_dgemm</code>
@ -1062,7 +1062,7 @@ are required primarily for the Python API, where compatibility with
NumPy arrays implies that sizes of the input and output arrays are provided. NumPy arrays implies that sizes of the input and output arrays are provided.
</p> </p>
<table id="org0ddc698" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org22437d0" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1248,8 +1248,8 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org9987bef" class="outline-3"> <div id="outline-container-org95ec930" class="outline-3">
<h3 id="org9987bef"><span class="section-number-3">2.3</span> <code>qmckl_matmul</code></h3> <h3 id="org95ec930"><span class="section-number-3">2.3</span> <code>qmckl_matmul</code></h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
Matrix multiplication using the <code>qmckl_matrix</code> data type: Matrix multiplication using the <code>qmckl_matrix</code> data type:
@ -1261,7 +1261,7 @@ Matrix multiplication using the <code>qmckl_matrix</code> data type:
\] \]
</p> </p>
<table id="orgb8c8993" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org16deb6d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1355,8 +1355,8 @@ Matrix multiplication using the <code>qmckl_matrix</code> data type:
</div> </div>
</div> </div>
<div id="outline-container-orgbd6ac75" class="outline-3"> <div id="outline-container-orgc7af985" class="outline-3">
<h3 id="orgbd6ac75"><span class="section-number-3">2.4</span> <code>qmckl_adjugate</code></h3> <h3 id="orgc7af985"><span class="section-number-3">2.4</span> <code>qmckl_adjugate</code></h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
Given a matrix \(\mathbf{A}\), the adjugate matrix Given a matrix \(\mathbf{A}\), the adjugate matrix
@ -1374,7 +1374,7 @@ of \(\mathbf{A}\).
See also: <a href="https://en.wikipedia.org/wiki/Adjugate_matrix">https://en.wikipedia.org/wiki/Adjugate_matrix</a> See also: <a href="https://en.wikipedia.org/wiki/Adjugate_matrix">https://en.wikipedia.org/wiki/Adjugate_matrix</a>
</p> </p>
<table id="org54566fd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgae881e1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1570,8 +1570,8 @@ determinant with the inverse:
</div> </div>
</div> </div>
<div id="outline-container-orga12e50b" class="outline-3"> <div id="outline-container-orga42244c" class="outline-3">
<h3 id="orga12e50b"><span class="section-number-3">2.5</span> <code>qmckl_adjugate_safe</code></h3> <h3 id="orga42244c"><span class="section-number-3">2.5</span> <code>qmckl_adjugate_safe</code></h3>
<div class="outline-text-3" id="text-2-5"> <div class="outline-text-3" id="text-2-5">
<p> <p>
"Size-safe" proxy function with the same functionality as <code>qmckl_adjugate</code> "Size-safe" proxy function with the same functionality as <code>qmckl_adjugate</code>
@ -1581,7 +1581,7 @@ NumPy arrays implies that sizes of the input and output arrays are provided.
</p> </p>
<table id="org9789bf5" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgb1e1b70" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1703,13 +1703,13 @@ LAPACK library.
</p> </p>
</div> </div>
<div id="outline-container-orgd5a609b" class="outline-4"> <div id="outline-container-org146fd13" class="outline-4">
<h4 id="orgd5a609b"><span class="section-number-4">2.5.1</span> C interface</h4> <h4 id="org146fd13"><span class="section-number-4">2.5.1</span> C interface</h4>
</div> </div>
</div> </div>
<div id="outline-container-org3b5df23" class="outline-3"> <div id="outline-container-org8638cb7" class="outline-3">
<h3 id="org3b5df23"><span class="section-number-3">2.6</span> <code>qmckl_transpose</code></h3> <h3 id="org8638cb7"><span class="section-number-3">2.6</span> <code>qmckl_transpose</code></h3>
<div class="outline-text-3" id="text-2-6"> <div class="outline-text-3" id="text-2-6">
<p> <p>
Transposes a matrix: \(A^\dagger_{ji} = A_{ij}\). Transposes a matrix: \(A^\dagger_{ji} = A_{ij}\).
@ -1770,8 +1770,8 @@ Transposes a matrix: \(A^\dagger_{ji} = A_{ij}\).
</div> </div>
</div> </div>
<div id="outline-container-org6130c41" class="outline-2"> <div id="outline-container-orgfa5d12c" class="outline-2">
<h2 id="org6130c41"><span class="section-number-2">3</span> Utilities</h2> <h2 id="orgfa5d12c"><span class="section-number-2">3</span> Utilities</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
Trick to make MKL efficient on AMD Trick to make MKL efficient on AMD
@ -1789,7 +1789,7 @@ Trick to make MKL efficient on AMD
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

44
qmckl_context.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Context</title> <title>Context</title>
@ -324,21 +324,21 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org800f6d7">1. Context handling</a> <li><a href="#orgabce465">1. Context handling</a>
<ul> <ul>
<li><a href="#org3b362fd">1.1. Data structure</a></li> <li><a href="#org137295f">1.1. Data structure</a></li>
<li><a href="#org0a6af24">1.2. Creation</a></li> <li><a href="#orga4ee292">1.2. Creation</a></li>
<li><a href="#orgfcc1b03">1.3. Locking</a></li> <li><a href="#orgab31a6d">1.3. Locking</a></li>
<li><a href="#org72c01f5">1.4. <span class="todo TODO">TODO</span> Copy</a></li> <li><a href="#orgc55f18a">1.4. <span class="todo TODO">TODO</span> Copy</a></li>
<li><a href="#orgf316511">1.5. Destroy</a></li> <li><a href="#org0c35c4e">1.5. Destroy</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org800f6d7" class="outline-2"> <div id="outline-container-orgabce465" class="outline-2">
<h2 id="org800f6d7"><span class="section-number-2">1</span> Context handling</h2> <h2 id="orgabce465"><span class="section-number-2">1</span> Context handling</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The context variable is a handle for the state of the library, The context variable is a handle for the state of the library,
@ -351,7 +351,7 @@ A value of <code>QMCKL_NULL_CONTEXT</code> for the context is equivalent to a
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="org4088252"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int64_t</span> <span style="color: #228b22;">qmckl_context</span> ; <pre class="src src-c" id="orge64478d"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int64_t</span> <span style="color: #228b22;">qmckl_context</span> ;
<span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_NULL_CONTEXT</span> (qmckl_context) 0 <span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_NULL_CONTEXT</span> (qmckl_context) 0
</pre> </pre>
</div> </div>
@ -369,8 +369,8 @@ and <code>ctx</code> is a <code>qmckl_context_struct*</code> pointer.
</p> </p>
</div> </div>
<div id="outline-container-org3b362fd" class="outline-3"> <div id="outline-container-org137295f" class="outline-3">
<h3 id="org3b362fd"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org137295f"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
The qmckl<sub>extra</sub> pointer lets the other implementation of the library The qmckl<sub>extra</sub> pointer lets the other implementation of the library
@ -406,7 +406,7 @@ to be recomputed. The date is incremented when the context is touched.
<p> <p>
When a new element is added to the context, the functions When a new element is added to the context, the functions
<a href="#org0a6af24"><code>qmckl_context_create</code></a> <a href="#orgf316511"><code>qmckl_context_destroy</code></a> and <a href="#org72c01f5"><code>qmckl_context_copy</code></a> <a href="#orga4ee292"><code>qmckl_context_create</code></a> <a href="#org0c35c4e"><code>qmckl_context_destroy</code></a> and <a href="#orgc55f18a"><code>qmckl_context_copy</code></a>
should be updated in order to make deep copies. should be updated in order to make deep copies.
</p> </p>
@ -427,8 +427,8 @@ This has the effect to increment the date of the context.
</div> </div>
</div> </div>
<div id="outline-container-org0a6af24" class="outline-3"> <div id="outline-container-orga4ee292" class="outline-3">
<h3 id="org0a6af24"><span class="section-number-3">1.2</span> Creation</h3> <h3 id="orga4ee292"><span class="section-number-3">1.2</span> Creation</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
To create a new context, <code>qmckl_context_create()</code> should be used. To create a new context, <code>qmckl_context_create()</code> should be used.
@ -445,8 +445,8 @@ To create a new context, <code>qmckl_context_create()</code> should be used.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgfcc1b03" class="outline-3"> <div id="outline-container-orgab31a6d" class="outline-3">
<h3 id="orgfcc1b03"><span class="section-number-3">1.3</span> Locking</h3> <h3 id="orgab31a6d"><span class="section-number-3">1.3</span> Locking</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
For thread safety, the context may be locked/unlocked. The lock is For thread safety, the context may be locked/unlocked. The lock is
@ -462,8 +462,8 @@ number of times the thread has locked it is saved in the
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org72c01f5" class="outline-3"> <div id="outline-container-orgc55f18a" class="outline-3">
<h3 id="org72c01f5"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Copy</h3> <h3 id="orgc55f18a"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Copy</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<p> <p>
<code>qmckl_context_copy</code> makes a deep copy of a context. It returns <code>qmckl_context_copy</code> makes a deep copy of a context. It returns
@ -471,8 +471,8 @@ number of times the thread has locked it is saved in the
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgf316511" class="outline-3"> <div id="outline-container-org0c35c4e" class="outline-3">
<h3 id="orgf316511"><span class="section-number-3">1.5</span> Destroy</h3> <h3 id="org0c35c4e"><span class="section-number-3">1.5</span> Destroy</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<p> <p>
The context is destroyed with <code>qmckl_context_destroy</code>, leaving the ancestors untouched. The context is destroyed with <code>qmckl_context_destroy</code>, leaving the ancestors untouched.
@ -490,7 +490,7 @@ It frees the context, and returns the previous context.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

120
qmckl_determinant.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Slater Determinant</title> <title>Slater Determinant</title>
@ -324,32 +324,32 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgc5bf56c">1. Context</a> <li><a href="#org9b45740">1. Context</a>
<ul> <ul>
<li><a href="#orgd23242f">1.1. Data structure</a></li> <li><a href="#orgc3ad230">1.1. Data structure</a></li>
<li><a href="#org293643b">1.2. Access functions</a></li> <li><a href="#org567f1c6">1.2. Access functions</a></li>
<li><a href="#orgdcfb839">1.3. Initialization functions</a></li> <li><a href="#org0b8b5ff">1.3. Initialization functions</a></li>
<li><a href="#org36d0a13">1.4. Fortran Interfaces</a></li> <li><a href="#orge8a86fb">1.4. Fortran Interfaces</a></li>
<li><a href="#org7e1ea6e">1.5. Test</a></li> <li><a href="#org4ceca61">1.5. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga18e5eb">2. Computation</a> <li><a href="#org74482a3">2. Computation</a>
<ul> <ul>
<li><a href="#org69e39a5">2.1. Determinant matrix</a> <li><a href="#org9ade114">2.1. Determinant matrix</a>
<ul> <ul>
<li><a href="#orgda4a52a">2.1.1. Get</a></li> <li><a href="#orgbd2bd78">2.1.1. Get</a></li>
<li><a href="#orgfc9af14">2.1.2. Provide</a></li> <li><a href="#org8d6d4d5">2.1.2. Provide</a></li>
<li><a href="#org725c239">2.1.3. Compute alpha</a></li> <li><a href="#orgf3497dc">2.1.3. Compute alpha</a></li>
<li><a href="#orgd61364f">2.1.4. Compute beta</a></li> <li><a href="#org14088f7">2.1.4. Compute beta</a></li>
<li><a href="#org63d651b">2.1.5. Test</a></li> <li><a href="#orgc75f6c2">2.1.5. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org2587eef">2.2. Inverse of Determinant matrix</a> <li><a href="#orgc8ed64b">2.2. Inverse of Determinant matrix</a>
<ul> <ul>
<li><a href="#orga4cb5bc">2.2.1. Get</a></li> <li><a href="#org25d233b">2.2.1. Get</a></li>
<li><a href="#orgf60ac3b">2.2.2. Provide</a></li> <li><a href="#orgd61c65c">2.2.2. Provide</a></li>
<li><a href="#org66f6a2c">2.2.3. Compute alpha</a></li> <li><a href="#org16de6f0">2.2.3. Compute alpha</a></li>
<li><a href="#org39a0c21">2.2.4. Compute beta</a></li> <li><a href="#org71c8566">2.2.4. Compute beta</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -358,8 +358,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgc5bf56c" class="outline-2"> <div id="outline-container-org9b45740" class="outline-2">
<h2 id="orgc5bf56c"><span class="section-number-2">1</span> Context</h2> <h2 id="org9b45740"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following arrays are stored in the context: The following arrays are stored in the context:
@ -535,8 +535,8 @@ Computed data:
</table> </table>
</div> </div>
<div id="outline-container-orgd23242f" class="outline-3"> <div id="outline-container-orgc3ad230" class="outline-3">
<h3 id="orgd23242f"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="orgc3ad230"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_determinant_struct</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_determinant_struct</span> {
@ -604,8 +604,8 @@ this mechanism.
</div> </div>
</div> </div>
<div id="outline-container-org293643b" class="outline-3"> <div id="outline-container-org567f1c6" class="outline-3">
<h3 id="org293643b"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="org567f1c6"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
When all the data for the slater determinants have been provided, the following When all the data for the slater determinants have been provided, the following
@ -619,8 +619,8 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-orgdcfb839" class="outline-3"> <div id="outline-container-org0b8b5ff" class="outline-3">
<h3 id="orgdcfb839"><span class="section-number-3">1.3</span> Initialization functions</h3> <h3 id="org0b8b5ff"><span class="section-number-3">1.3</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
To set the basis set, all the following functions need to be To set the basis set, all the following functions need to be
@ -643,24 +643,24 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-org36d0a13" class="outline-3"> <div id="outline-container-orge8a86fb" class="outline-3">
<h3 id="org36d0a13"><span class="section-number-3">1.4</span> Fortran Interfaces</h3> <h3 id="orge8a86fb"><span class="section-number-3">1.4</span> Fortran Interfaces</h3>
</div> </div>
<div id="outline-container-org7e1ea6e" class="outline-3"> <div id="outline-container-org4ceca61" class="outline-3">
<h3 id="org7e1ea6e"><span class="section-number-3">1.5</span> Test</h3> <h3 id="org4ceca61"><span class="section-number-3">1.5</span> Test</h3>
</div> </div>
</div> </div>
<div id="outline-container-orga18e5eb" class="outline-2"> <div id="outline-container-org74482a3" class="outline-2">
<h2 id="orga18e5eb"><span class="section-number-2">2</span> Computation</h2> <h2 id="org74482a3"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org69e39a5" class="outline-3"> <div id="outline-container-org9ade114" class="outline-3">
<h3 id="org69e39a5"><span class="section-number-3">2.1</span> Determinant matrix</h3> <h3 id="org9ade114"><span class="section-number-3">2.1</span> Determinant matrix</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
</div> </div>
<div id="outline-container-orgda4a52a" class="outline-4"> <div id="outline-container-orgbd2bd78" class="outline-4">
<h4 id="orgda4a52a"><span class="section-number-4">2.1.1</span> Get</h4> <h4 id="orgbd2bd78"><span class="section-number-4">2.1.1</span> Get</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_det_vgl_alpha</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">det_vgl_alpha</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_det_vgl_alpha</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">det_vgl_alpha</span>);
@ -670,14 +670,14 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-orgfc9af14" class="outline-4"> <div id="outline-container-org8d6d4d5" class="outline-4">
<h4 id="orgfc9af14"><span class="section-number-4">2.1.2</span> Provide</h4> <h4 id="org8d6d4d5"><span class="section-number-4">2.1.2</span> Provide</h4>
</div> </div>
<div id="outline-container-org725c239" class="outline-4"> <div id="outline-container-orgf3497dc" class="outline-4">
<h4 id="org725c239"><span class="section-number-4">2.1.3</span> Compute alpha</h4> <h4 id="orgf3497dc"><span class="section-number-4">2.1.3</span> Compute alpha</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<table id="orgae032af" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org5dabc71" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -851,10 +851,10 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-orgd61364f" class="outline-4"> <div id="outline-container-org14088f7" class="outline-4">
<h4 id="orgd61364f"><span class="section-number-4">2.1.4</span> Compute beta</h4> <h4 id="org14088f7"><span class="section-number-4">2.1.4</span> Compute beta</h4>
<div class="outline-text-4" id="text-2-1-4"> <div class="outline-text-4" id="text-2-1-4">
<table id="org3c5743e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgeaf5ff6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1028,18 +1028,18 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-org63d651b" class="outline-4"> <div id="outline-container-orgc75f6c2" class="outline-4">
<h4 id="org63d651b"><span class="section-number-4">2.1.5</span> Test</h4> <h4 id="orgc75f6c2"><span class="section-number-4">2.1.5</span> Test</h4>
</div> </div>
</div> </div>
<div id="outline-container-org2587eef" class="outline-3"> <div id="outline-container-orgc8ed64b" class="outline-3">
<h3 id="org2587eef"><span class="section-number-3">2.2</span> Inverse of Determinant matrix</h3> <h3 id="orgc8ed64b"><span class="section-number-3">2.2</span> Inverse of Determinant matrix</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
</div> </div>
<div id="outline-container-orga4cb5bc" class="outline-4"> <div id="outline-container-org25d233b" class="outline-4">
<h4 id="orga4cb5bc"><span class="section-number-4">2.2.1</span> Get</h4> <h4 id="org25d233b"><span class="section-number-4">2.2.1</span> Get</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_det_inv_matrix_alpha</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">det_inv_matrix_alpha</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_det_inv_matrix_alpha</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">det_inv_matrix_alpha</span>);
@ -1053,14 +1053,14 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-orgf60ac3b" class="outline-4"> <div id="outline-container-orgd61c65c" class="outline-4">
<h4 id="orgf60ac3b"><span class="section-number-4">2.2.2</span> Provide</h4> <h4 id="orgd61c65c"><span class="section-number-4">2.2.2</span> Provide</h4>
</div> </div>
<div id="outline-container-org66f6a2c" class="outline-4"> <div id="outline-container-org16de6f0" class="outline-4">
<h4 id="org66f6a2c"><span class="section-number-4">2.2.3</span> Compute alpha</h4> <h4 id="org16de6f0"><span class="section-number-4">2.2.3</span> Compute alpha</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<table id="org0f1c280" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orge708432" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1222,10 +1222,10 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-org39a0c21" class="outline-4"> <div id="outline-container-org71c8566" class="outline-4">
<h4 id="org39a0c21"><span class="section-number-4">2.2.4</span> Compute beta</h4> <h4 id="org71c8566"><span class="section-number-4">2.2.4</span> Compute beta</h4>
<div class="outline-text-4" id="text-2-2-4"> <div class="outline-text-4" id="text-2-2-4">
<table id="orge213705" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org7cb3ee8" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1392,7 +1392,7 @@ computed to accelerate the calculations.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

114
qmckl_distance.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Inter-particle distances</title> <title>Inter-particle distances</title>
@ -346,54 +346,54 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org6c0b9ae">1. Squared distance</a> <li><a href="#orgc2fed14">1. Squared distance</a>
<ul> <ul>
<li><a href="#org0ceca93">1.1. <code>qmckl_distance_sq</code></a> <li><a href="#orgaf79cfb">1.1. <code>qmckl_distance_sq</code></a>
<ul> <ul>
<li><a href="#org1cc46f5">1.1.1. Performance</a></li> <li><a href="#orgb30d767">1.1.1. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org96b9969">2. Distance</a> <li><a href="#orgeec116f">2. Distance</a>
<ul> <ul>
<li><a href="#org8a0a0cb">2.1. <code>qmckl_distance</code></a> <li><a href="#org6788d1e">2.1. <code>qmckl_distance</code></a>
<ul> <ul>
<li><a href="#org9c56de5">2.1.1. Requirements</a></li> <li><a href="#org1e84fec">2.1.1. Requirements</a></li>
<li><a href="#org10d2f58">2.1.2. C header</a></li> <li><a href="#orgbebdef5">2.1.2. C header</a></li>
<li><a href="#org0fef4bb">2.1.3. Source</a></li> <li><a href="#org8a9f33b">2.1.3. Source</a></li>
<li><a href="#org31aedba">2.1.4. Performance</a></li> <li><a href="#org0b9d582">2.1.4. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org306d696">3. Rescaled Distance</a> <li><a href="#org3f9b700">3. Rescaled Distance</a>
<ul> <ul>
<li><a href="#orgad61d7e">3.1. <code>qmckl_distance_rescaled</code></a> <li><a href="#org871bf19">3.1. <code>qmckl_distance_rescaled</code></a>
<ul> <ul>
<li><a href="#org3cf4e82">3.1.1. Requirements</a></li> <li><a href="#org13627aa">3.1.1. Requirements</a></li>
<li><a href="#org2360ce2">3.1.2. C header</a></li> <li><a href="#orga0657e6">3.1.2. C header</a></li>
<li><a href="#org598a552">3.1.3. Source</a></li> <li><a href="#org5da98c1">3.1.3. Source</a></li>
<li><a href="#org4856ee9">3.1.4. Performance</a></li> <li><a href="#org6d93b21">3.1.4. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org587a85b">4. Rescaled Distance Derivatives</a> <li><a href="#orgc3f7487">4. Rescaled Distance Derivatives</a>
<ul> <ul>
<li><a href="#org4915dd3">4.1. <code>qmckl_distance_rescaled_gl</code></a></li> <li><a href="#orgc389a1a">4.1. <code>qmckl_distance_rescaled_gl</code></a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org6c0b9ae" class="outline-2"> <div id="outline-container-orgc2fed14" class="outline-2">
<h2 id="org6c0b9ae"><span class="section-number-2">1</span> Squared distance</h2> <h2 id="orgc2fed14"><span class="section-number-2">1</span> Squared distance</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-org0ceca93" class="outline-3"> <div id="outline-container-orgaf79cfb" class="outline-3">
<h3 id="org0ceca93"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3> <h3 id="orgaf79cfb"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
<code>qmckl_distance_sq</code> computes the matrix of the squared distances <code>qmckl_distance_sq</code> computes the matrix of the squared distances
@ -406,7 +406,7 @@ between all pairs of points in two sets, one point within each set:
\] \]
</p> </p>
<table id="org2456dce" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc5df88a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -679,8 +679,8 @@ Requirements:
</div> </div>
</div> </div>
<div id="outline-container-org1cc46f5" class="outline-4"> <div id="outline-container-orgb30d767" class="outline-4">
<h4 id="org1cc46f5"><span class="section-number-4">1.1.1</span> Performance</h4> <h4 id="orgb30d767"><span class="section-number-4">1.1.1</span> Performance</h4>
<div class="outline-text-4" id="text-1-1-1"> <div class="outline-text-4" id="text-1-1-1">
<p> <p>
This function is more efficient when <code>A</code> and <code>B</code> are This function is more efficient when <code>A</code> and <code>B</code> are
@ -690,12 +690,12 @@ transposed.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org96b9969" class="outline-2"> <div id="outline-container-orgeec116f" class="outline-2">
<h2 id="org96b9969"><span class="section-number-2">2</span> Distance</h2> <h2 id="orgeec116f"><span class="section-number-2">2</span> Distance</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org8a0a0cb" class="outline-3"> <div id="outline-container-org6788d1e" class="outline-3">
<h3 id="org8a0a0cb"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3> <h3 id="org6788d1e"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
<code>qmckl_distance</code> computes the matrix of the distances between all <code>qmckl_distance</code> computes the matrix of the distances between all
@ -713,7 +713,7 @@ If the input array is normal (<code>'N'</code>), the xyz coordinates are in
the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran. the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran.
</p> </p>
<table id="orgebf0503" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc3cea52" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -814,8 +814,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</table> </table>
</div> </div>
<div id="outline-container-org9c56de5" class="outline-4"> <div id="outline-container-org1e84fec" class="outline-4">
<h4 id="org9c56de5"><span class="section-number-4">2.1.1</span> Requirements</h4> <h4 id="org1e84fec"><span class="section-number-4">2.1.1</span> Requirements</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
@ -833,8 +833,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org10d2f58" class="outline-4"> <div id="outline-container-orgbebdef5" class="outline-4">
<h4 id="org10d2f58"><span class="section-number-4">2.1.2</span> C header</h4> <h4 id="orgbebdef5"><span class="section-number-4">2.1.2</span> C header</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance</span> (
@ -854,8 +854,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org0fef4bb" class="outline-4"> <div id="outline-container-org8a9f33b" class="outline-4">
<h4 id="org0fef4bb"><span class="section-number-4">2.1.3</span> Source</h4> <h4 id="org8a9f33b"><span class="section-number-4">2.1.3</span> Source</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">function</span> <span style="color: #0000ff;">qmckl_distance</span>(context, transa, transb, m, n, <span style="color: #a020f0;">&amp;</span> <pre class="src src-f90"><span style="color: #a020f0;">function</span> <span style="color: #0000ff;">qmckl_distance</span>(context, transa, transb, m, n, <span style="color: #a020f0;">&amp;</span>
@ -1006,8 +1006,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org31aedba" class="outline-4"> <div id="outline-container-org0b9d582" class="outline-4">
<h4 id="org31aedba"><span class="section-number-4">2.1.4</span> Performance</h4> <h4 id="org0b9d582"><span class="section-number-4">2.1.4</span> Performance</h4>
<div class="outline-text-4" id="text-2-1-4"> <div class="outline-text-4" id="text-2-1-4">
<p> <p>
This function is more efficient when <code>A</code> and <code>B</code> are transposed. This function is more efficient when <code>A</code> and <code>B</code> are transposed.
@ -1017,12 +1017,12 @@ This function is more efficient when <code>A</code> and <code>B</code> are trans
</div> </div>
</div> </div>
<div id="outline-container-org306d696" class="outline-2"> <div id="outline-container-org3f9b700" class="outline-2">
<h2 id="org306d696"><span class="section-number-2">3</span> Rescaled Distance</h2> <h2 id="org3f9b700"><span class="section-number-2">3</span> Rescaled Distance</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
</div> </div>
<div id="outline-container-orgad61d7e" class="outline-3"> <div id="outline-container-org871bf19" class="outline-3">
<h3 id="orgad61d7e"><span class="section-number-3">3.1</span> <code>qmckl_distance_rescaled</code></h3> <h3 id="org871bf19"><span class="section-number-3">3.1</span> <code>qmckl_distance_rescaled</code></h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
<code>qmckl_distance_rescaled</code> computes the matrix of the rescaled distances between all <code>qmckl_distance_rescaled</code> computes the matrix of the rescaled distances between all
@ -1040,7 +1040,7 @@ If the input array is normal (<code>'N'</code>), the xyz coordinates are in
the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran. the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran.
</p> </p>
<table id="org878e246" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org565aa60" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1148,8 +1148,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</table> </table>
</div> </div>
<div id="outline-container-org3cf4e82" class="outline-4"> <div id="outline-container-org13627aa" class="outline-4">
<h4 id="org3cf4e82"><span class="section-number-4">3.1.1</span> Requirements</h4> <h4 id="org13627aa"><span class="section-number-4">3.1.1</span> Requirements</h4>
<div class="outline-text-4" id="text-3-1-1"> <div class="outline-text-4" id="text-3-1-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
@ -1167,8 +1167,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org2360ce2" class="outline-4"> <div id="outline-container-orga0657e6" class="outline-4">
<h4 id="org2360ce2"><span class="section-number-4">3.1.2</span> C header</h4> <h4 id="orga0657e6"><span class="section-number-4">3.1.2</span> C header</h4>
<div class="outline-text-4" id="text-3-1-2"> <div class="outline-text-4" id="text-3-1-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance_rescaled</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance_rescaled</span> (
@ -1189,8 +1189,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org598a552" class="outline-4"> <div id="outline-container-org5da98c1" class="outline-4">
<h4 id="org598a552"><span class="section-number-4">3.1.3</span> Source</h4> <h4 id="org5da98c1"><span class="section-number-4">3.1.3</span> Source</h4>
<div class="outline-text-4" id="text-3-1-3"> <div class="outline-text-4" id="text-3-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90"><span style="color: #a020f0;">function</span> <span style="color: #0000ff;">qmckl_distance_rescaled</span>(context, transa, transb, m, n, <span style="color: #a020f0;">&amp;</span> <pre class="src src-f90"><span style="color: #a020f0;">function</span> <span style="color: #0000ff;">qmckl_distance_rescaled</span>(context, transa, transb, m, n, <span style="color: #a020f0;">&amp;</span>
@ -1344,8 +1344,8 @@ the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortra
</div> </div>
</div> </div>
<div id="outline-container-org4856ee9" class="outline-4"> <div id="outline-container-org6d93b21" class="outline-4">
<h4 id="org4856ee9"><span class="section-number-4">3.1.4</span> Performance</h4> <h4 id="org6d93b21"><span class="section-number-4">3.1.4</span> Performance</h4>
<div class="outline-text-4" id="text-3-1-4"> <div class="outline-text-4" id="text-3-1-4">
<p> <p>
This function is more efficient when <code>A</code> and <code>B</code> are transposed. This function is more efficient when <code>A</code> and <code>B</code> are transposed.
@ -1354,12 +1354,12 @@ This function is more efficient when <code>A</code> and <code>B</code> are trans
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org587a85b" class="outline-2"> <div id="outline-container-orgc3f7487" class="outline-2">
<h2 id="org587a85b"><span class="section-number-2">4</span> Rescaled Distance Derivatives</h2> <h2 id="orgc3f7487"><span class="section-number-2">4</span> Rescaled Distance Derivatives</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
</div> </div>
<div id="outline-container-org4915dd3" class="outline-3"> <div id="outline-container-orgc389a1a" class="outline-3">
<h3 id="org4915dd3"><span class="section-number-3">4.1</span> <code>qmckl_distance_rescaled_gl</code></h3> <h3 id="orgc389a1a"><span class="section-number-3">4.1</span> <code>qmckl_distance_rescaled_gl</code></h3>
<div class="outline-text-3" id="text-4-1"> <div class="outline-text-3" id="text-4-1">
<p> <p>
<code>qmckl_distance_rescaled_gl</code> computes the matrix of the gradient and Laplacian of the <code>qmckl_distance_rescaled_gl</code> computes the matrix of the gradient and Laplacian of the
@ -1414,7 +1414,7 @@ If the input array is normal (<code>'N'</code>), the xyz coordinates are in
the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran. the leading dimension: <code>[n][3]</code> in C and <code>(3,n)</code> in Fortran.
</p> </p>
<table id="org85c333c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org93e2178" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1735,7 +1735,7 @@ This function is more efficient when <code>A</code> and <code>B</code> are trans
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

168
qmckl_electron.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Electrons</title> <title>Electrons</title>
@ -346,59 +346,59 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org27df1fa">1. Context</a> <li><a href="#org5e65112">1. Context</a>
<ul> <ul>
<li><a href="#orgfae9421">1.1. Data structure</a></li> <li><a href="#orgff1a506">1.1. Data structure</a></li>
<li><a href="#org283e24c">1.2. Initialization functions</a></li> <li><a href="#org568dbb6">1.2. Initialization functions</a></li>
<li><a href="#org0da40f2">1.3. Access functions</a> <li><a href="#org0a34f63">1.3. Access functions</a>
<ul> <ul>
<li><a href="#org4545096">1.3.1. Number of electrons</a></li> <li><a href="#orgdcb57a4">1.3.1. Number of electrons</a></li>
<li><a href="#orgff8ce3d">1.3.2. Number of walkers</a></li> <li><a href="#org21f5b07">1.3.2. Number of walkers</a></li>
<li><a href="#orga71696a">1.3.3. Electron coordinates</a></li> <li><a href="#org2737af0">1.3.3. Electron coordinates</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org04560f4">1.4. Test</a></li> <li><a href="#orgdb1f3ff">1.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org52c5eb8">2. Computation</a> <li><a href="#org9bd713c">2. Computation</a>
<ul> <ul>
<li><a href="#orgca775cc">2.1. Electron-electron distances</a> <li><a href="#orga04ec1f">2.1. Electron-electron distances</a>
<ul> <ul>
<li><a href="#org0a16ec3">2.1.1. Get</a></li> <li><a href="#org73c8473">2.1.1. Get</a></li>
<li><a href="#orga4929f5">2.1.2. Compute</a></li> <li><a href="#org0ff52ca">2.1.2. Compute</a></li>
<li><a href="#orgdcac449">2.1.3. Test</a></li> <li><a href="#org37ce671">2.1.3. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgeb5224d">2.2. Electron-electron potential</a> <li><a href="#org5713dc9">2.2. Electron-electron potential</a>
<ul> <ul>
<li><a href="#orgebd5d6e">2.2.1. Get</a></li> <li><a href="#orge823c32">2.2.1. Get</a></li>
<li><a href="#org7e53949">2.2.2. Compute</a></li> <li><a href="#org59a5e26">2.2.2. Compute</a></li>
<li><a href="#org92a8fcd">2.2.3. Test</a></li> <li><a href="#org43328fb">2.2.3. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org8d440f4">2.3. Electron-nucleus distances</a> <li><a href="#org7574ac5">2.3. Electron-nucleus distances</a>
<ul> <ul>
<li><a href="#org6b43ca2">2.3.1. Get</a></li> <li><a href="#orgb1f2385">2.3.1. Get</a></li>
<li><a href="#orgf659b75">2.3.2. Compute</a></li> <li><a href="#org57a6b4c">2.3.2. Compute</a></li>
<li><a href="#org9cb2041">2.3.3. Test</a></li> <li><a href="#org3a745f4">2.3.3. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orge80a6eb">2.4. Electron-nucleus potential</a> <li><a href="#orgad0b1b8">2.4. Electron-nucleus potential</a>
<ul> <ul>
<li><a href="#org57f40a5">2.4.1. Get</a></li> <li><a href="#org502a667">2.4.1. Get</a></li>
<li><a href="#orgca304bb">2.4.2. Compute</a></li> <li><a href="#org911d269">2.4.2. Compute</a></li>
<li><a href="#orgf24b58c">2.4.3. Test</a></li> <li><a href="#org3f25f88">2.4.3. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org8e91670">2.5. Generate initial coordinates</a></li> <li><a href="#org57c3cd1">2.5. Generate initial coordinates</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org27df1fa" class="outline-2"> <div id="outline-container-org5e65112" class="outline-2">
<h2 id="org27df1fa"><span class="section-number-2">1</span> Context</h2> <h2 id="org5e65112"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following data stored in the context: The following data stored in the context:
@ -539,8 +539,8 @@ Computed data:
</table> </table>
</div> </div>
<div id="outline-container-orgfae9421" class="outline-3"> <div id="outline-container-orgff1a506" class="outline-3">
<h3 id="orgfae9421"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="orgff1a506"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"> <pre class="src src-c">
@ -609,8 +609,8 @@ this mechanism.
</div> </div>
</div> </div>
<div id="outline-container-org283e24c" class="outline-3"> <div id="outline-container-org568dbb6" class="outline-3">
<h3 id="org283e24c"><span class="section-number-3">1.2</span> Initialization functions</h3> <h3 id="org568dbb6"><span class="section-number-3">1.2</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
To set the data relative to the electrons in the context, the To set the data relative to the electrons in the context, the
@ -683,8 +683,8 @@ in the context.
</div> </div>
</div> </div>
<div id="outline-container-org0da40f2" class="outline-3"> <div id="outline-container-org0a34f63" class="outline-3">
<h3 id="org0da40f2"><span class="section-number-3">1.3</span> Access functions</h3> <h3 id="org0a34f63"><span class="section-number-3">1.3</span> Access functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
Access functions return <code>QMCKL_SUCCESS</code> when the data has been Access functions return <code>QMCKL_SUCCESS</code> when the data has been
@ -696,12 +696,12 @@ contains the requested data. Otherwise, this variable is untouched.
</p> </p>
</div> </div>
<div id="outline-container-org4545096" class="outline-4"> <div id="outline-container-orgdcb57a4" class="outline-4">
<h4 id="org4545096"><span class="section-number-4">1.3.1</span> Number of electrons</h4> <h4 id="orgdcb57a4"><span class="section-number-4">1.3.1</span> Number of electrons</h4>
</div> </div>
<div id="outline-container-orgff8ce3d" class="outline-4"> <div id="outline-container-org21f5b07" class="outline-4">
<h4 id="orgff8ce3d"><span class="section-number-4">1.3.2</span> Number of walkers</h4> <h4 id="org21f5b07"><span class="section-number-4">1.3.2</span> Number of walkers</h4>
<div class="outline-text-4" id="text-1-3-2"> <div class="outline-text-4" id="text-1-3-2">
<p> <p>
A walker is a set of electron coordinates that are arguments of A walker is a set of electron coordinates that are arguments of
@ -710,8 +710,8 @@ the wave function. <code>walk_num</code> is the number of walkers.
</div> </div>
</div> </div>
<div id="outline-container-orga71696a" class="outline-4"> <div id="outline-container-org2737af0" class="outline-4">
<h4 id="orga71696a"><span class="section-number-4">1.3.3</span> Electron coordinates</h4> <h4 id="org2737af0"><span class="section-number-4">1.3.3</span> Electron coordinates</h4>
<div class="outline-text-4" id="text-1-3-3"> <div class="outline-text-4" id="text-1-3-3">
<p> <p>
Returns the current electron coordinates. The pointer is assumed Returns the current electron coordinates. The pointer is assumed
@ -776,8 +776,8 @@ current points.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org04560f4" class="outline-3"> <div id="outline-container-orgdb1f3ff" class="outline-3">
<h3 id="org04560f4"><span class="section-number-3">1.4</span> Test</h3> <h3 id="orgdb1f3ff"><span class="section-number-3">1.4</span> Test</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */ <pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */
@ -856,8 +856,8 @@ rc = qmckl_get_electron_coord (context, <span style="color: #8b2252;">'N'</span>
</div> </div>
</div> </div>
<div id="outline-container-org52c5eb8" class="outline-2"> <div id="outline-container-org9bd713c" class="outline-2">
<h2 id="org52c5eb8"><span class="section-number-2">2</span> Computation</h2> <h2 id="org9bd713c"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The computed data is stored in the context so that it can be reused The computed data is stored in the context so that it can be reused
@ -870,12 +870,12 @@ current date is stored.
</p> </p>
</div> </div>
<div id="outline-container-orgca775cc" class="outline-3"> <div id="outline-container-orga04ec1f" class="outline-3">
<h3 id="orgca775cc"><span class="section-number-3">2.1</span> Electron-electron distances</h3> <h3 id="orga04ec1f"><span class="section-number-3">2.1</span> Electron-electron distances</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
</div> </div>
<div id="outline-container-org0a16ec3" class="outline-4"> <div id="outline-container-org73c8473" class="outline-4">
<h4 id="org0a16ec3"><span class="section-number-4">2.1.1</span> Get</h4> <h4 id="org73c8473"><span class="section-number-4">2.1.1</span> Get</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_ee_distance</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">distance</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_ee_distance</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">distance</span>);
@ -884,10 +884,10 @@ current date is stored.
</div> </div>
</div> </div>
<div id="outline-container-orga4929f5" class="outline-4"> <div id="outline-container-org0ff52ca" class="outline-4">
<h4 id="orga4929f5"><span class="section-number-4">2.1.2</span> Compute</h4> <h4 id="org0ff52ca"><span class="section-number-4">2.1.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<table id="orga92df62" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga6c0b49" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -992,8 +992,8 @@ current date is stored.
</div> </div>
</div> </div>
<div id="outline-container-orgdcac449" class="outline-4"> <div id="outline-container-org37ce671" class="outline-4">
<h4 id="orgdcac449"><span class="section-number-4">2.1.3</span> Test</h4> <h4 id="org37ce671"><span class="section-number-4">2.1.3</span> Test</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #0000ff;">assert</span>(<span style="color: #228b22;">qmckl_electron_provided</span>(<span style="color: #a0522d;">context</span>)); <pre class="src src-c"><span style="color: #0000ff;">assert</span>(<span style="color: #228b22;">qmckl_electron_provided</span>(<span style="color: #a0522d;">context</span>));
@ -1027,8 +1027,8 @@ rc = qmckl_get_electron_ee_distance(context, ee_distance);
</div> </div>
</div> </div>
<div id="outline-container-orgeb5224d" class="outline-3"> <div id="outline-container-org5713dc9" class="outline-3">
<h3 id="orgeb5224d"><span class="section-number-3">2.2</span> Electron-electron potential</h3> <h3 id="org5713dc9"><span class="section-number-3">2.2</span> Electron-electron potential</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
<code>ee_potential</code> is given by <code>ee_potential</code> is given by
@ -1046,8 +1046,8 @@ distance.
</p> </p>
</div> </div>
<div id="outline-container-orgebd5d6e" class="outline-4"> <div id="outline-container-orge823c32" class="outline-4">
<h4 id="orgebd5d6e"><span class="section-number-4">2.2.1</span> Get</h4> <h4 id="orge823c32"><span class="section-number-4">2.2.1</span> Get</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_ee_potential</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">ee_potential</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_ee_potential</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">ee_potential</span>);
@ -1056,10 +1056,10 @@ distance.
</div> </div>
</div> </div>
<div id="outline-container-org7e53949" class="outline-4"> <div id="outline-container-org59a5e26" class="outline-4">
<h4 id="org7e53949"><span class="section-number-4">2.2.2</span> Compute</h4> <h4 id="org59a5e26"><span class="section-number-4">2.2.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-2-2"> <div class="outline-text-4" id="text-2-2-2">
<table id="org0902637" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orge0ece75" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1175,8 +1175,8 @@ distance.
</div> </div>
</div> </div>
<div id="outline-container-org92a8fcd" class="outline-4"> <div id="outline-container-org43328fb" class="outline-4">
<h4 id="org92a8fcd"><span class="section-number-4">2.2.3</span> Test</h4> <h4 id="org43328fb"><span class="section-number-4">2.2.3</span> Test</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">double</span> <span style="color: #a0522d;">ee_potential</span>[walk_num]; <pre class="src src-c"><span style="color: #228b22;">double</span> <span style="color: #a0522d;">ee_potential</span>[walk_num];
@ -1188,12 +1188,12 @@ rc = qmckl_get_electron_ee_potential(context, &amp;(ee_potential[0]));
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org8d440f4" class="outline-3"> <div id="outline-container-org7574ac5" class="outline-3">
<h3 id="org8d440f4"><span class="section-number-3">2.3</span> Electron-nucleus distances</h3> <h3 id="org7574ac5"><span class="section-number-3">2.3</span> Electron-nucleus distances</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
</div> </div>
<div id="outline-container-org6b43ca2" class="outline-4"> <div id="outline-container-orgb1f2385" class="outline-4">
<h4 id="org6b43ca2"><span class="section-number-4">2.3.1</span> Get</h4> <h4 id="orgb1f2385"><span class="section-number-4">2.3.1</span> Get</h4>
<div class="outline-text-4" id="text-2-3-1"> <div class="outline-text-4" id="text-2-3-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_en_distance</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">distance</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_en_distance</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">distance</span>);
@ -1202,10 +1202,10 @@ rc = qmckl_get_electron_ee_potential(context, &amp;(ee_potential[0]));
</div> </div>
</div> </div>
<div id="outline-container-orgf659b75" class="outline-4"> <div id="outline-container-org57a6b4c" class="outline-4">
<h4 id="orgf659b75"><span class="section-number-4">2.3.2</span> Compute</h4> <h4 id="org57a6b4c"><span class="section-number-4">2.3.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-3-2"> <div class="outline-text-4" id="text-2-3-2">
<table id="org97eca18" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org5e498da" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1312,8 +1312,8 @@ rc = qmckl_get_electron_ee_potential(context, &amp;(ee_potential[0]));
</div> </div>
</div> </div>
<div id="outline-container-org9cb2041" class="outline-4"> <div id="outline-container-org3a745f4" class="outline-4">
<h4 id="org9cb2041"><span class="section-number-4">2.3.3</span> Test</h4> <h4 id="org3a745f4"><span class="section-number-4">2.3.3</span> Test</h4>
<div class="outline-text-4" id="text-2-3-3"> <div class="outline-text-4" id="text-2-3-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"> <pre class="src src-c">
@ -1361,8 +1361,8 @@ rc = qmckl_get_electron_en_distance(context, &amp;(en_distance[0][0][0]));
</div> </div>
</div> </div>
<div id="outline-container-orge80a6eb" class="outline-3"> <div id="outline-container-orgad0b1b8" class="outline-3">
<h3 id="orge80a6eb"><span class="section-number-3">2.4</span> Electron-nucleus potential</h3> <h3 id="orgad0b1b8"><span class="section-number-3">2.4</span> Electron-nucleus potential</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
<code>en_potential</code> stores the <code>en</code> potential energy <code>en_potential</code> stores the <code>en</code> potential energy
@ -1380,8 +1380,8 @@ distance and \[Z_A\] is the nuclear charge.
</p> </p>
</div> </div>
<div id="outline-container-org57f40a5" class="outline-4"> <div id="outline-container-org502a667" class="outline-4">
<h4 id="org57f40a5"><span class="section-number-4">2.4.1</span> Get</h4> <h4 id="org502a667"><span class="section-number-4">2.4.1</span> Get</h4>
<div class="outline-text-4" id="text-2-4-1"> <div class="outline-text-4" id="text-2-4-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_en_potential</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">en_potential</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_en_potential</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">en_potential</span>);
@ -1390,10 +1390,10 @@ distance and \[Z_A\] is the nuclear charge.
</div> </div>
</div> </div>
<div id="outline-container-orgca304bb" class="outline-4"> <div id="outline-container-org911d269" class="outline-4">
<h4 id="orgca304bb"><span class="section-number-4">2.4.2</span> Compute</h4> <h4 id="org911d269"><span class="section-number-4">2.4.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-4-2"> <div class="outline-text-4" id="text-2-4-2">
<table id="orgeaa6a94" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org46081a9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1527,8 +1527,8 @@ distance and \[Z_A\] is the nuclear charge.
</div> </div>
</div> </div>
<div id="outline-container-orgf24b58c" class="outline-4"> <div id="outline-container-org3f25f88" class="outline-4">
<h4 id="orgf24b58c"><span class="section-number-4">2.4.3</span> Test</h4> <h4 id="org3f25f88"><span class="section-number-4">2.4.3</span> Test</h4>
<div class="outline-text-4" id="text-2-4-3"> <div class="outline-text-4" id="text-2-4-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">double</span> <span style="color: #a0522d;">en_potential</span>[walk_num]; <pre class="src src-c"><span style="color: #228b22;">double</span> <span style="color: #a0522d;">en_potential</span>[walk_num];
@ -1541,14 +1541,14 @@ rc = qmckl_get_electron_en_potential(context, &amp;(en_potential[0]));
</div> </div>
</div> </div>
<div id="outline-container-org8e91670" class="outline-3"> <div id="outline-container-org57c3cd1" class="outline-3">
<h3 id="org8e91670"><span class="section-number-3">2.5</span> Generate initial coordinates</h3> <h3 id="org57c3cd1"><span class="section-number-3">2.5</span> Generate initial coordinates</h3>
</div> </div>
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

70
qmckl_error.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Error handling</title> <title>Error handling</title>
@ -324,29 +324,29 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org6ac845d">-</a></li> <li><a href="#org110626b">-</a></li>
<li><a href="#orgf499b4e">1. Decoding errors</a></li> <li><a href="#org3dfee39">1. Decoding errors</a></li>
<li><a href="#orgb81b3c7">2. Data structure in context</a></li> <li><a href="#orgbab7efd">2. Data structure in context</a></li>
<li><a href="#org159b983">3. Updating errors in the context</a></li> <li><a href="#org84ec6c5">3. Updating errors in the context</a></li>
<li><a href="#org75d7f5e">4. Get the error</a></li> <li><a href="#org53c67b5">4. Get the error</a></li>
<li><a href="#org6aa65d9">5. Failing</a></li> <li><a href="#org646abad">5. Failing</a></li>
<li><a href="#orgdc19264">6. Last error</a> <li><a href="#org6c3d73b">6. Last error</a>
<ul> <ul>
<li><a href="#org95b2edc">6.1. Fortran inteface</a></li> <li><a href="#orgcf133e3">6.1. Fortran inteface</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org1488732">7. Helper functions for debugging</a> <li><a href="#org6272aa7">7. Helper functions for debugging</a>
<ul> <ul>
<li><a href="#orgbadd1e5">7.1. Fortran inteface</a></li> <li><a href="#org3451f30">7.1. Fortran inteface</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org6ac845d" class="outline-2"> <div id="outline-container-org110626b" class="outline-2">
<h2 id="org6ac845d">-</h2> <h2 id="org110626b">-</h2>
<div class="outline-text-2" id="text-org6ac845d"> <div class="outline-text-2" id="text-org110626b">
<p> <p>
The library should never make the calling programs abort, nor The library should never make the calling programs abort, nor
perform any input/output operations. This decision has to be taken perform any input/output operations. This decision has to be taken
@ -357,7 +357,7 @@ by the developer of the code calling the library.
All the functions return with an exit code, defined as All the functions return with an exit code, defined as
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="org6ad9a94"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>; <pre class="src src-c" id="org321ee21"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>;
</pre> </pre>
</div> </div>
@ -374,7 +374,7 @@ error code is returned to the program.
Here is the complete list of exit codes. Here is the complete list of exit codes.
</p> </p>
<table id="org15807be" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgec6477e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -582,8 +582,8 @@ string is assumed to be large enough to contain the error message
</div> </div>
</div> </div>
<div id="outline-container-orgf499b4e" class="outline-2"> <div id="outline-container-org3dfee39" class="outline-2">
<h2 id="orgf499b4e"><span class="section-number-2">1</span> Decoding errors</h2> <h2 id="org3dfee39"><span class="section-number-2">1</span> Decoding errors</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
To decode the error messages, <code>qmckl_string_of_error</code> converts an To decode the error messages, <code>qmckl_string_of_error</code> converts an
@ -601,8 +601,8 @@ The text strings are extracted from the previous table.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgb81b3c7" class="outline-2"> <div id="outline-container-orgbab7efd" class="outline-2">
<h2 id="orgb81b3c7"><span class="section-number-2">2</span> Data structure in context</h2> <h2 id="orgbab7efd"><span class="section-number-2">2</span> Data structure in context</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The strings are declared internally with a maximum fixed size to avoid The strings are declared internally with a maximum fixed size to avoid
@ -625,8 +625,8 @@ dynamic memory allocation.
</div> </div>
</div> </div>
<div id="outline-container-org159b983" class="outline-2"> <div id="outline-container-org84ec6c5" class="outline-2">
<h2 id="org159b983"><span class="section-number-2">3</span> Updating errors in the context</h2> <h2 id="org84ec6c5"><span class="section-number-2">3</span> Updating errors in the context</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
The error is updated in the context using <code>qmckl_set_error</code>. The error is updated in the context using <code>qmckl_set_error</code>.
@ -645,8 +645,8 @@ explaining the error. The exit code can't be <code>QMCKL_SUCCESS</code>.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org75d7f5e" class="outline-2"> <div id="outline-container-org53c67b5" class="outline-2">
<h2 id="org75d7f5e"><span class="section-number-2">4</span> Get the error</h2> <h2 id="org53c67b5"><span class="section-number-2">4</span> Get the error</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
Upon error, the error type and message can be obtained from the Upon error, the error type and message can be obtained from the
@ -665,8 +665,8 @@ function name and message is mandatory.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org6aa65d9" class="outline-2"> <div id="outline-container-org646abad" class="outline-2">
<h2 id="org6aa65d9"><span class="section-number-2">5</span> Failing</h2> <h2 id="org646abad"><span class="section-number-2">5</span> Failing</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
<p> <p>
To make a function fail, the <code>qmckl_failwith</code> function should be To make a function fail, the <code>qmckl_failwith</code> function should be
@ -703,8 +703,8 @@ For example, this function can be used as
</div> </div>
</div> </div>
<div id="outline-container-orgdc19264" class="outline-2"> <div id="outline-container-org6c3d73b" class="outline-2">
<h2 id="orgdc19264"><span class="section-number-2">6</span> Last error</h2> <h2 id="org6c3d73b"><span class="section-number-2">6</span> Last error</h2>
<div class="outline-text-2" id="text-6"> <div class="outline-text-2" id="text-6">
<p> <p>
Returns a string describing the last error, using <code>qmckl_get_error</code>. Returns a string describing the last error, using <code>qmckl_get_error</code>.
@ -716,13 +716,13 @@ Returns a string describing the last error, using <code>qmckl_get_error</code>.
</pre> </pre>
</div> </div>
</div> </div>
<div id="outline-container-org95b2edc" class="outline-3"> <div id="outline-container-orgcf133e3" class="outline-3">
<h3 id="org95b2edc"><span class="section-number-3">6.1</span> Fortran inteface</h3> <h3 id="orgcf133e3"><span class="section-number-3">6.1</span> Fortran inteface</h3>
</div> </div>
</div> </div>
<div id="outline-container-org1488732" class="outline-2"> <div id="outline-container-org6272aa7" class="outline-2">
<h2 id="org1488732"><span class="section-number-2">7</span> Helper functions for debugging</h2> <h2 id="org6272aa7"><span class="section-number-2">7</span> Helper functions for debugging</h2>
<div class="outline-text-2" id="text-7"> <div class="outline-text-2" id="text-7">
<p> <p>
The following function prints to <code>stderr</code> an error message is the return code is The following function prints to <code>stderr</code> an error message is the return code is
@ -748,14 +748,14 @@ It should be used as:
</div> </div>
</div> </div>
<div id="outline-container-orgbadd1e5" class="outline-3"> <div id="outline-container-org3451f30" class="outline-3">
<h3 id="orgbadd1e5"><span class="section-number-3">7.1</span> Fortran inteface</h3> <h3 id="org3451f30"><span class="section-number-3">7.1</span> Fortran inteface</h3>
</div> </div>
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

48
qmckl_examples.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Code examples</title> <title>Code examples</title>
@ -346,25 +346,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgb3d614a">1. Overlap matrix in the MO basis</a> <li><a href="#orgb6a2f6a">1. Overlap matrix in the MO basis</a>
<ul> <ul>
<li><a href="#orgfb74c64">1.1. Python</a></li> <li><a href="#org289d296">1.1. Python</a></li>
<li><a href="#org6365afa">1.2. C</a></li> <li><a href="#orgf473537">1.2. C</a></li>
<li><a href="#org5540f9d">1.3. Fortran</a></li> <li><a href="#org852d69c">1.3. Fortran</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgb7cb9e9">2. Fortran</a> <li><a href="#orgd18858a">2. Fortran</a>
<ul> <ul>
<li><a href="#org733d48f">2.1. Checking errors</a></li> <li><a href="#orgee75a18">2.1. Checking errors</a></li>
<li><a href="#orgabdd635">2.2. Computing an atomic orbital on a grid</a></li> <li><a href="#orgba822e1">2.2. Computing an atomic orbital on a grid</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgb3d614a" class="outline-2"> <div id="outline-container-orgb6a2f6a" class="outline-2">
<h2 id="orgb3d614a"><span class="section-number-2">1</span> Overlap matrix in the MO basis</h2> <h2 id="orgb6a2f6a"><span class="section-number-2">1</span> Overlap matrix in the MO basis</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The focal point of this example is the numerical evaluation of the overlap The focal point of this example is the numerical evaluation of the overlap
@ -417,8 +417,8 @@ code.
</p> </p>
</div> </div>
<div id="outline-container-orgfb74c64" class="outline-3"> <div id="outline-container-org289d296" class="outline-3">
<h3 id="orgfb74c64"><span class="section-number-3">1.1</span> Python</h3> <h3 id="org289d296"><span class="section-number-3">1.1</span> Python</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
In this example, we will compute numerically the overlap In this example, we will compute numerically the overlap
@ -593,8 +593,8 @@ and finally we compute the overlap between all the MOs as
</div> </div>
</div> </div>
<div id="outline-container-org6365afa" class="outline-3"> <div id="outline-container-orgf473537" class="outline-3">
<h3 id="org6365afa"><span class="section-number-3">1.2</span> C</h3> <h3 id="orgf473537"><span class="section-number-3">1.2</span> C</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
In this example, electron-nucleus cusp fitting is added. In this example, electron-nucleus cusp fitting is added.
@ -922,8 +922,8 @@ and finally we compute the overlap between all the MOs as
</div> </div>
<div id="outline-container-org5540f9d" class="outline-3"> <div id="outline-container-org852d69c" class="outline-3">
<h3 id="org5540f9d"><span class="section-number-3">1.3</span> Fortran</h3> <h3 id="org852d69c"><span class="section-number-3">1.3</span> Fortran</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
Here is the same piece of code translated in Fortran Here is the same piece of code translated in Fortran
@ -1099,12 +1099,12 @@ Here is the same piece of code translated in Fortran
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgb7cb9e9" class="outline-2"> <div id="outline-container-orgd18858a" class="outline-2">
<h2 id="orgb7cb9e9"><span class="section-number-2">2</span> Fortran</h2> <h2 id="orgd18858a"><span class="section-number-2">2</span> Fortran</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org733d48f" class="outline-3"> <div id="outline-container-orgee75a18" class="outline-3">
<h3 id="org733d48f"><span class="section-number-3">2.1</span> Checking errors</h3> <h3 id="orgee75a18"><span class="section-number-3">2.1</span> Checking errors</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
All QMCkl functions return an error code. A convenient way to handle All QMCkl functions return an error code. A convenient way to handle
@ -1113,7 +1113,7 @@ error in text format and exits the program.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-f90" id="orge1a444d"><span style="color: #a020f0;">subroutine</span> <span style="color: #0000ff;">qmckl_check_error</span>(rc, message) <pre class="src src-f90" id="org5134ea9"><span style="color: #a020f0;">subroutine</span> <span style="color: #0000ff;">qmckl_check_error</span>(rc, message)
<span style="color: #a020f0;">use</span> <span style="color: #0000ff;">qmckl</span> <span style="color: #a020f0;">use</span> <span style="color: #0000ff;">qmckl</span>
<span style="color: #a020f0;">implicit</span> <span style="color: #228b22;">none</span> <span style="color: #a020f0;">implicit</span> <span style="color: #228b22;">none</span>
<span style="color: #228b22;">integer</span>(qmckl_exit_code), <span style="color: #a020f0;">intent</span>(in) ::<span style="color: #a0522d;"> rc</span> <span style="color: #228b22;">integer</span>(qmckl_exit_code), <span style="color: #a020f0;">intent</span>(in) ::<span style="color: #a0522d;"> rc</span>
@ -1131,8 +1131,8 @@ error in text format and exits the program.
</div> </div>
</div> </div>
<div id="outline-container-orgabdd635" class="outline-3"> <div id="outline-container-orgba822e1" class="outline-3">
<h3 id="orgabdd635"><span class="section-number-3">2.2</span> Computing an atomic orbital on a grid</h3> <h3 id="orgba822e1"><span class="section-number-3">2.2</span> Computing an atomic orbital on a grid</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
The following program, in Fortran, computes the values of an atomic The following program, in Fortran, computes the values of an atomic
@ -1351,7 +1351,7 @@ We finally print the value and Laplacian of the AO:
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

646
qmckl_jastrow_champ.html
View File

File diff suppressed because it is too large Load Diff

156
qmckl_local_energy.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Local Energy</title> <title>Local Energy</title>
@ -346,44 +346,44 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org4ae66c4">1. Context</a> <li><a href="#orgbab7030">1. Context</a>
<ul> <ul>
<li><a href="#orgbb2c2af">1.1. Data structure</a></li> <li><a href="#org267a011">1.1. Data structure</a></li>
<li><a href="#org380ba19">1.2. Access functions</a></li> <li><a href="#org4c50544">1.2. Access functions</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga8ac86d">2. Computation</a> <li><a href="#orge7e7b1e">2. Computation</a>
<ul> <ul>
<li><a href="#org2c321fc">2.1. Kinetic energy</a> <li><a href="#org8d9aa09">2.1. Kinetic energy</a>
<ul> <ul>
<li><a href="#org05e9906">2.1.1. Get</a></li> <li><a href="#org0a65aa3">2.1.1. Get</a></li>
<li><a href="#org8465430">2.1.2. Provide</a></li> <li><a href="#org4d76910">2.1.2. Provide</a></li>
<li><a href="#org9d1e715">2.1.3. Compute kinetic enregy</a></li> <li><a href="#org2ffafa1">2.1.3. Compute kinetic enregy</a></li>
<li><a href="#org7880e5e">2.1.4. Test</a></li> <li><a href="#org04c6767">2.1.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org9b92a5c">2.2. Potential energy</a> <li><a href="#org5e471f9">2.2. Potential energy</a>
<ul> <ul>
<li><a href="#org938454f">2.2.1. Get</a></li> <li><a href="#org5a4161a">2.2.1. Get</a></li>
<li><a href="#org6056e7e">2.2.2. Provide</a></li> <li><a href="#org3ac5cba">2.2.2. Provide</a></li>
<li><a href="#orgd940e4b">2.2.3. Compute potential enregy</a></li> <li><a href="#org29afc0b">2.2.3. Compute potential enregy</a></li>
<li><a href="#orgee3f5d0">2.2.4. Test</a></li> <li><a href="#org0e168c6">2.2.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org635e5c3">2.3. Local energy</a> <li><a href="#org4755598">2.3. Local energy</a>
<ul> <ul>
<li><a href="#org5f55b2c">2.3.1. Get</a></li> <li><a href="#orgeae0bdc">2.3.1. Get</a></li>
<li><a href="#orgbb5fe84">2.3.2. Provide</a></li> <li><a href="#orgdc21632">2.3.2. Provide</a></li>
<li><a href="#orgba4fd2d">2.3.3. Compute local enregy</a></li> <li><a href="#org89085ee">2.3.3. Compute local enregy</a></li>
<li><a href="#org7b51e71">2.3.4. Test</a></li> <li><a href="#orgfc8ae1e">2.3.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org45e74d5">2.4. Drift vector</a> <li><a href="#org458e6fc">2.4. Drift vector</a>
<ul> <ul>
<li><a href="#org52f14ff">2.4.1. Get</a></li> <li><a href="#orgcb15aaa">2.4.1. Get</a></li>
<li><a href="#orgcc24856">2.4.2. Provide</a></li> <li><a href="#orgd64c6de">2.4.2. Provide</a></li>
<li><a href="#org495ea66">2.4.3. Compute drift vector</a></li> <li><a href="#org02899f9">2.4.3. Compute drift vector</a></li>
<li><a href="#org5b47321">2.4.4. Test</a></li> <li><a href="#org97b4c3f">2.4.4. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -392,8 +392,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org4ae66c4" class="outline-2"> <div id="outline-container-orgbab7030" class="outline-2">
<h2 id="org4ae66c4"><span class="section-number-2">1</span> Context</h2> <h2 id="orgbab7030"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following arrays are stored in the context: The following arrays are stored in the context:
@ -466,8 +466,8 @@ Computed data:
</table> </table>
</div> </div>
<div id="outline-container-orgbb2c2af" class="outline-3"> <div id="outline-container-org267a011" class="outline-3">
<h3 id="orgbb2c2af"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org267a011"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_local_energy_struct</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_local_energy_struct</span> {
@ -501,8 +501,8 @@ this mechanism.
</div> </div>
</div> </div>
<div id="outline-container-org380ba19" class="outline-3"> <div id="outline-container-org4c50544" class="outline-3">
<h3 id="org380ba19"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="org4c50544"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
When all the data for the local energy have been provided, the following When all the data for the local energy have been provided, the following
@ -517,12 +517,12 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-orga8ac86d" class="outline-2"> <div id="outline-container-orge7e7b1e" class="outline-2">
<h2 id="orga8ac86d"><span class="section-number-2">2</span> Computation</h2> <h2 id="orge7e7b1e"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org2c321fc" class="outline-3"> <div id="outline-container-org8d9aa09" class="outline-3">
<h3 id="org2c321fc"><span class="section-number-3">2.1</span> Kinetic energy</h3> <h3 id="org8d9aa09"><span class="section-number-3">2.1</span> Kinetic energy</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
Where the kinetic energy is given as: Where the kinetic energy is given as:
@ -546,8 +546,8 @@ case is given as follows:
</p> </p>
</div> </div>
<div id="outline-container-org05e9906" class="outline-4"> <div id="outline-container-org0a65aa3" class="outline-4">
<h4 id="org05e9906"><span class="section-number-4">2.1.1</span> Get</h4> <h4 id="org0a65aa3"><span class="section-number-4">2.1.1</span> Get</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_kinetic_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">kinetic_energy</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_kinetic_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">kinetic_energy</span>);
@ -556,14 +556,14 @@ case is given as follows:
</div> </div>
</div> </div>
<div id="outline-container-org8465430" class="outline-4"> <div id="outline-container-org4d76910" class="outline-4">
<h4 id="org8465430"><span class="section-number-4">2.1.2</span> Provide</h4> <h4 id="org4d76910"><span class="section-number-4">2.1.2</span> Provide</h4>
</div> </div>
<div id="outline-container-org9d1e715" class="outline-4"> <div id="outline-container-org2ffafa1" class="outline-4">
<h4 id="org9d1e715"><span class="section-number-4">2.1.3</span> Compute kinetic enregy</h4> <h4 id="org2ffafa1"><span class="section-number-4">2.1.3</span> Compute kinetic enregy</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<table id="org4541df7" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org51312be" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -792,12 +792,12 @@ case is given as follows:
</div> </div>
</div> </div>
<div id="outline-container-org7880e5e" class="outline-4"> <div id="outline-container-org04c6767" class="outline-4">
<h4 id="org7880e5e"><span class="section-number-4">2.1.4</span> Test</h4> <h4 id="org04c6767"><span class="section-number-4">2.1.4</span> Test</h4>
</div> </div>
</div> </div>
<div id="outline-container-org9b92a5c" class="outline-3"> <div id="outline-container-org5e471f9" class="outline-3">
<h3 id="org9b92a5c"><span class="section-number-3">2.2</span> Potential energy</h3> <h3 id="org5e471f9"><span class="section-number-3">2.2</span> Potential energy</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
The potential energy is the sum of all the following terms The potential energy is the sum of all the following terms
@ -833,8 +833,8 @@ contributions.
</p> </p>
</div> </div>
<div id="outline-container-org938454f" class="outline-4"> <div id="outline-container-org5a4161a" class="outline-4">
<h4 id="org938454f"><span class="section-number-4">2.2.1</span> Get</h4> <h4 id="org5a4161a"><span class="section-number-4">2.2.1</span> Get</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_potential_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">potential_energy</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_potential_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">potential_energy</span>);
@ -843,14 +843,14 @@ contributions.
</div> </div>
</div> </div>
<div id="outline-container-org6056e7e" class="outline-4"> <div id="outline-container-org3ac5cba" class="outline-4">
<h4 id="org6056e7e"><span class="section-number-4">2.2.2</span> Provide</h4> <h4 id="org3ac5cba"><span class="section-number-4">2.2.2</span> Provide</h4>
</div> </div>
<div id="outline-container-orgd940e4b" class="outline-4"> <div id="outline-container-org29afc0b" class="outline-4">
<h4 id="orgd940e4b"><span class="section-number-4">2.2.3</span> Compute potential enregy</h4> <h4 id="org29afc0b"><span class="section-number-4">2.2.3</span> Compute potential enregy</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<table id="org6c44352" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org157fdcf" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -977,12 +977,12 @@ contributions.
</div> </div>
</div> </div>
<div id="outline-container-orgee3f5d0" class="outline-4"> <div id="outline-container-org0e168c6" class="outline-4">
<h4 id="orgee3f5d0"><span class="section-number-4">2.2.4</span> Test</h4> <h4 id="org0e168c6"><span class="section-number-4">2.2.4</span> Test</h4>
</div> </div>
</div> </div>
<div id="outline-container-org635e5c3" class="outline-3"> <div id="outline-container-org4755598" class="outline-3">
<h3 id="org635e5c3"><span class="section-number-3">2.3</span> Local energy</h3> <h3 id="org4755598"><span class="section-number-3">2.3</span> Local energy</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
The local energy is the sum of kinetic and potential energies. The local energy is the sum of kinetic and potential energies.
@ -996,8 +996,8 @@ E_L = KE + PE
</div> </div>
<div id="outline-container-org5f55b2c" class="outline-4"> <div id="outline-container-orgeae0bdc" class="outline-4">
<h4 id="org5f55b2c"><span class="section-number-4">2.3.1</span> Get</h4> <h4 id="orgeae0bdc"><span class="section-number-4">2.3.1</span> Get</h4>
<div class="outline-text-4" id="text-2-3-1"> <div class="outline-text-4" id="text-2-3-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_local_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">local_energy</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_local_energy</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">local_energy</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>);
@ -1006,14 +1006,14 @@ E_L = KE + PE
</div> </div>
</div> </div>
<div id="outline-container-orgbb5fe84" class="outline-4"> <div id="outline-container-orgdc21632" class="outline-4">
<h4 id="orgbb5fe84"><span class="section-number-4">2.3.2</span> Provide</h4> <h4 id="orgdc21632"><span class="section-number-4">2.3.2</span> Provide</h4>
</div> </div>
<div id="outline-container-orgba4fd2d" class="outline-4"> <div id="outline-container-org89085ee" class="outline-4">
<h4 id="orgba4fd2d"><span class="section-number-4">2.3.3</span> Compute local enregy</h4> <h4 id="org89085ee"><span class="section-number-4">2.3.3</span> Compute local enregy</h4>
<div class="outline-text-4" id="text-2-3-3"> <div class="outline-text-4" id="text-2-3-3">
<table id="org3a56b7f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org5a265c5" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1109,12 +1109,12 @@ E_L = KE + PE
</div> </div>
</div> </div>
<div id="outline-container-org7b51e71" class="outline-4"> <div id="outline-container-orgfc8ae1e" class="outline-4">
<h4 id="org7b51e71"><span class="section-number-4">2.3.4</span> Test</h4> <h4 id="orgfc8ae1e"><span class="section-number-4">2.3.4</span> Test</h4>
</div> </div>
</div> </div>
<div id="outline-container-org45e74d5" class="outline-3"> <div id="outline-container-org458e6fc" class="outline-3">
<h3 id="org45e74d5"><span class="section-number-3">2.4</span> Drift vector</h3> <h3 id="org458e6fc"><span class="section-number-3">2.4</span> Drift vector</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
The drift vector is calculated as the ration of the gradient The drift vector is calculated as the ration of the gradient
@ -1128,8 +1128,8 @@ with the determinant of the wavefunction.
</p> </p>
</div> </div>
<div id="outline-container-org52f14ff" class="outline-4"> <div id="outline-container-orgcb15aaa" class="outline-4">
<h4 id="org52f14ff"><span class="section-number-4">2.4.1</span> Get</h4> <h4 id="orgcb15aaa"><span class="section-number-4">2.4.1</span> Get</h4>
<div class="outline-text-4" id="text-2-4-1"> <div class="outline-text-4" id="text-2-4-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_drift_vector</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">drift_vector</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_drift_vector</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">drift_vector</span>);
@ -1138,14 +1138,14 @@ with the determinant of the wavefunction.
</div> </div>
</div> </div>
<div id="outline-container-orgcc24856" class="outline-4"> <div id="outline-container-orgd64c6de" class="outline-4">
<h4 id="orgcc24856"><span class="section-number-4">2.4.2</span> Provide</h4> <h4 id="orgd64c6de"><span class="section-number-4">2.4.2</span> Provide</h4>
</div> </div>
<div id="outline-container-org495ea66" class="outline-4"> <div id="outline-container-org02899f9" class="outline-4">
<h4 id="org495ea66"><span class="section-number-4">2.4.3</span> Compute drift vector</h4> <h4 id="org02899f9"><span class="section-number-4">2.4.3</span> Compute drift vector</h4>
<div class="outline-text-4" id="text-2-4-3"> <div class="outline-text-4" id="text-2-4-3">
<table id="org4531396" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgdb690fe" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1366,15 +1366,15 @@ with the determinant of the wavefunction.
</div> </div>
</div> </div>
<div id="outline-container-org5b47321" class="outline-4"> <div id="outline-container-org97b4c3f" class="outline-4">
<h4 id="org5b47321"><span class="section-number-4">2.4.4</span> Test</h4> <h4 id="org97b4c3f"><span class="section-number-4">2.4.4</span> Test</h4>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

28
qmckl_memory.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Memory management</title> <title>Memory management</title>
@ -324,16 +324,16 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org64cf58f">1. Memory data structure for the context</a></li> <li><a href="#org333085e">1. Memory data structure for the context</a></li>
<li><a href="#org36db111">2. Passing info to allocation routines</a></li> <li><a href="#org2194e7d">2. Passing info to allocation routines</a></li>
<li><a href="#orgd2f71f0">3. Allocation/deallocation functions</a></li> <li><a href="#orgc0586af">3. Allocation/deallocation functions</a></li>
<li><a href="#org2d5b30b">4. Get the size of a memory block</a></li> <li><a href="#org01b7a6c">4. Get the size of a memory block</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org64cf58f" class="outline-2"> <div id="outline-container-org333085e" class="outline-2">
<h2 id="org64cf58f"><span class="section-number-2">1</span> Memory data structure for the context</h2> <h2 id="org333085e"><span class="section-number-2">1</span> Memory data structure for the context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
Every time a new block of memory is allocated, the information Every time a new block of memory is allocated, the information
@ -375,8 +375,8 @@ array, and the number of allocated blocks.
</div> </div>
</div> </div>
<div id="outline-container-org36db111" class="outline-2"> <div id="outline-container-org2194e7d" class="outline-2">
<h2 id="org36db111"><span class="section-number-2">2</span> Passing info to allocation routines</h2> <h2 id="org2194e7d"><span class="section-number-2">2</span> Passing info to allocation routines</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
Passing information to the allocation routine should be done by Passing information to the allocation routine should be done by
@ -385,8 +385,8 @@ passing an instance of a <code>qmckl_memory_info_struct</code>.
</div> </div>
</div> </div>
<div id="outline-container-orgd2f71f0" class="outline-2"> <div id="outline-container-orgc0586af" class="outline-2">
<h2 id="orgd2f71f0"><span class="section-number-2">3</span> Allocation/deallocation functions</h2> <h2 id="orgc0586af"><span class="section-number-2">3</span> Allocation/deallocation functions</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
Memory allocation inside the library should be done with Memory allocation inside the library should be done with
@ -645,8 +645,8 @@ successful deallocation of the memory block.</li>
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org2d5b30b" class="outline-2"> <div id="outline-container-org01b7a6c" class="outline-2">
<h2 id="org2d5b30b"><span class="section-number-2">4</span> Get the size of a memory block</h2> <h2 id="org01b7a6c"><span class="section-number-2">4</span> Get the size of a memory block</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
All the blocks allocated with <code>qmckl_malloc</code> keep track of how many All the blocks allocated with <code>qmckl_malloc</code> keep track of how many
@ -741,7 +741,7 @@ rc = qmckl_context_destroy(context);
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

192
qmckl_mo.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Molecular Orbitals</title> <title>Molecular Orbitals</title>
@ -346,72 +346,72 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgf83c43e">1. Context</a> <li><a href="#org7186b91">1. Context</a>
<ul> <ul>
<li><a href="#org774e36a">1.1. Data structure</a></li> <li><a href="#orgf90455c">1.1. Data structure</a></li>
<li><a href="#orgaf2f483">1.2. Initialization functions</a></li> <li><a href="#org6fbbf6b">1.2. Initialization functions</a></li>
<li><a href="#orgec17c1d">1.3. Cusp adjsutment functions</a></li> <li><a href="#org6ba70cd">1.3. Cusp adjsutment functions</a></li>
<li><a href="#org60b60cd">1.4. Access functions</a> <li><a href="#orgfa57ca6">1.4. Access functions</a>
<ul> <ul>
<li><a href="#org9015030">1.4.1. Fortran interfaces</a></li> <li><a href="#org9707911">1.4.1. Fortran interfaces</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgf1f5080">1.5. Update</a> <li><a href="#orgccfecdd">1.5. Update</a>
<ul> <ul>
<li><a href="#org4083f0c">1.5.1. Fortran interface</a></li> <li><a href="#org655a068">1.5.1. Fortran interface</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org855904d">2. Computation</a> <li><a href="#orga194f0e">2. Computation</a>
<ul> <ul>
<li><a href="#org1c9c30f">2.1. Parameters of the cusp-correction functions</a></li> <li><a href="#orgdcaff35">2.1. Parameters of the cusp-correction functions</a></li>
<li><a href="#orga0136ae">2.2. Computation of MOs: values only</a> <li><a href="#org4db9c37">2.2. Computation of MOs: values only</a>
<ul> <ul>
<li><a href="#orgce5927d">2.2.1. Get</a></li> <li><a href="#org21dc506">2.2.1. Get</a></li>
<li><a href="#org76a05ab">2.2.2. Provide</a></li> <li><a href="#org46524e6">2.2.2. Provide</a></li>
<li><a href="#org2b74b9c">2.2.3. Compute</a></li> <li><a href="#org2316118">2.2.3. Compute</a></li>
<li><a href="#org1babcf4">2.2.4. HPC version</a> <li><a href="#orge944c56">2.2.4. HPC version</a>
<ul> <ul>
<li><a href="#org796ea30">2.2.4.1. Single-precision</a></li> <li><a href="#org372a0ed">2.2.4.1. Single-precision</a></li>
<li><a href="#org699e4bd">2.2.4.2. Double-precision</a></li> <li><a href="#org36a23f7">2.2.4.2. Double-precision</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org193aef2">2.3. Computation of MOs: values, gradient, Laplacian</a> <li><a href="#orgf538c42">2.3. Computation of MOs: values, gradient, Laplacian</a>
<ul> <ul>
<li><a href="#org6bae88c">2.3.1. Get</a></li> <li><a href="#org13be620">2.3.1. Get</a></li>
<li><a href="#org3682081">2.3.2. Provide</a></li> <li><a href="#org170a90f">2.3.2. Provide</a></li>
<li><a href="#org2a6a7b8">2.3.3. Compute</a></li> <li><a href="#org013c975">2.3.3. Compute</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgc38c12c">2.4. Computation of cusp-corrected MOs: values only</a> <li><a href="#orga4e27ea">2.4. Computation of cusp-corrected MOs: values only</a>
<ul> <ul>
<li><a href="#org6361d2f">2.4.1. Compute</a></li> <li><a href="#org6c13f9b">2.4.1. Compute</a></li>
<li><a href="#org4216a23">2.4.2. HPC version</a></li> <li><a href="#orga91d82f">2.4.2. HPC version</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org454b6cb">2.5. Computation of cusp-corrected MOs: values, gradient, Laplacian</a> <li><a href="#orgd8c7b5b">2.5. Computation of cusp-corrected MOs: values, gradient, Laplacian</a>
<ul> <ul>
<li><a href="#org15e7a59">2.5.1. Compute</a></li> <li><a href="#org0775657">2.5.1. Compute</a></li>
<li><a href="#orgb7ec7c8">2.5.2. HPC version</a></li> <li><a href="#org27491c1">2.5.2. HPC version</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgec9da3d">2.6. Rescaling of MO coefficients</a> <li><a href="#orgb3034a5">2.6. Rescaling of MO coefficients</a>
<ul> <ul>
<li><a href="#org930038e">2.6.1. Fortran interface</a></li> <li><a href="#org04e2d2c">2.6.1. Fortran interface</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org53d3b35">2.7. Test</a></li> <li><a href="#org269a076">2.7. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgf83c43e" class="outline-2"> <div id="outline-container-org7186b91" class="outline-2">
<h2 id="orgf83c43e"><span class="section-number-2">1</span> Context</h2> <h2 id="org7186b91"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following arrays are stored in the context: The following arrays are stored in the context:
@ -490,8 +490,8 @@ Computed data:
</table> </table>
</div> </div>
<div id="outline-container-org774e36a" class="outline-3"> <div id="outline-container-orgf90455c" class="outline-3">
<h3 id="org774e36a"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="orgf90455c"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_mo_basis_struct</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_mo_basis_struct</span> {
@ -548,8 +548,8 @@ this mechanism.
</div> </div>
</div> </div>
<div id="outline-container-orgaf2f483" class="outline-3"> <div id="outline-container-org6fbbf6b" class="outline-3">
<h3 id="orgaf2f483"><span class="section-number-3">1.2</span> Initialization functions</h3> <h3 id="org6fbbf6b"><span class="section-number-3">1.2</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
To set the basis set, all the following functions need to be To set the basis set, all the following functions need to be
@ -570,8 +570,8 @@ computed to accelerate the calculations.
</div> </div>
</div> </div>
<div id="outline-container-orgec17c1d" class="outline-3"> <div id="outline-container-org6ba70cd" class="outline-3">
<h3 id="orgec17c1d"><span class="section-number-3">1.3</span> Cusp adjsutment functions</h3> <h3 id="org6ba70cd"><span class="section-number-3">1.3</span> Cusp adjsutment functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
To activate the cusp adjustment, the user must enter the radius of To activate the cusp adjustment, the user must enter the radius of
@ -586,8 +586,8 @@ of the non-\(s\) AOs at the center.
</div> </div>
</div> </div>
<div id="outline-container-org60b60cd" class="outline-3"> <div id="outline-container-orgfa57ca6" class="outline-3">
<h3 id="org60b60cd"><span class="section-number-3">1.4</span> Access functions</h3> <h3 id="orgfa57ca6"><span class="section-number-3">1.4</span> Access functions</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<p> <p>
When all the data for the AOs have been provided, the following When all the data for the AOs have been provided, the following
@ -600,13 +600,13 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-org9015030" class="outline-4"> <div id="outline-container-org9707911" class="outline-4">
<h4 id="org9015030"><span class="section-number-4">1.4.1</span> Fortran interfaces</h4> <h4 id="org9707911"><span class="section-number-4">1.4.1</span> Fortran interfaces</h4>
</div> </div>
</div> </div>
<div id="outline-container-orgf1f5080" class="outline-3"> <div id="outline-container-orgccfecdd" class="outline-3">
<h3 id="orgf1f5080"><span class="section-number-3">1.5</span> Update</h3> <h3 id="orgccfecdd"><span class="section-number-3">1.5</span> Update</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<p> <p>
It may be desirable to remove certain molecular orbitals (MOs) that It may be desirable to remove certain molecular orbitals (MOs) that
@ -633,25 +633,25 @@ calculation. If the integer is non-zero, the MO will be kept.
</div> </div>
</div> </div>
<div id="outline-container-org4083f0c" class="outline-4"> <div id="outline-container-org655a068" class="outline-4">
<h4 id="org4083f0c"><span class="section-number-4">1.5.1</span> Fortran interface</h4> <h4 id="org655a068"><span class="section-number-4">1.5.1</span> Fortran interface</h4>
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org855904d" class="outline-2"> <div id="outline-container-orga194f0e" class="outline-2">
<h2 id="org855904d"><span class="section-number-2">2</span> Computation</h2> <h2 id="orga194f0e"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org1c9c30f" class="outline-3"> <div id="outline-container-orgdcaff35" class="outline-3">
<h3 id="org1c9c30f"><span class="section-number-3">2.1</span> Parameters of the cusp-correction functions</h3> <h3 id="orgdcaff35"><span class="section-number-3">2.1</span> Parameters of the cusp-correction functions</h3>
</div> </div>
<div id="outline-container-orga0136ae" class="outline-3"> <div id="outline-container-org4db9c37" class="outline-3">
<h3 id="orga0136ae"><span class="section-number-3">2.2</span> Computation of MOs: values only</h3> <h3 id="org4db9c37"><span class="section-number-3">2.2</span> Computation of MOs: values only</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
</div> </div>
<div id="outline-container-orgce5927d" class="outline-4"> <div id="outline-container-org21dc506" class="outline-4">
<h4 id="orgce5927d"><span class="section-number-4">2.2.1</span> Get</h4> <h4 id="org21dc506"><span class="section-number-4">2.2.1</span> Get</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -675,8 +675,8 @@ Uses the given array to compute the values.
</div> </div>
</div> </div>
<div id="outline-container-org76a05ab" class="outline-4"> <div id="outline-container-org46524e6" class="outline-4">
<h4 id="org76a05ab"><span class="section-number-4">2.2.2</span> Provide</h4> <h4 id="org46524e6"><span class="section-number-4">2.2.2</span> Provide</h4>
<div class="outline-text-4" id="text-2-2-2"> <div class="outline-text-4" id="text-2-2-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_provide_mo_basis_mo_value</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_provide_mo_basis_mo_value</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>);
@ -761,10 +761,10 @@ Uses the given array to compute the values.
</div> </div>
</div> </div>
<div id="outline-container-org2b74b9c" class="outline-4"> <div id="outline-container-org2316118" class="outline-4">
<h4 id="org2b74b9c"><span class="section-number-4">2.2.3</span> Compute</h4> <h4 id="org2316118"><span class="section-number-4">2.2.3</span> Compute</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<table id="orga1a462d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgf553733" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -919,8 +919,8 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
</div> </div>
<div id="outline-container-org1babcf4" class="outline-4"> <div id="outline-container-orge944c56" class="outline-4">
<h4 id="org1babcf4"><span class="section-number-4">2.2.4</span> HPC version</h4> <h4 id="orge944c56"><span class="section-number-4">2.2.4</span> HPC version</h4>
<div class="outline-text-4" id="text-2-2-4"> <div class="outline-text-4" id="text-2-2-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC
@ -947,8 +947,8 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
<div id="outline-container-org796ea30" class="outline-5"> <div id="outline-container-org372a0ed" class="outline-5">
<h5 id="org796ea30"><span class="section-number-5">2.2.4.1</span> Single-precision</h5> <h5 id="org372a0ed"><span class="section-number-5">2.2.4.1</span> Single-precision</h5>
<div class="outline-text-5" id="text-2-2-4-1"> <div class="outline-text-5" id="text-2-2-4-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC
@ -1063,8 +1063,8 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
</div> </div>
<div id="outline-container-org699e4bd" class="outline-5"> <div id="outline-container-org36a23f7" class="outline-5">
<h5 id="org699e4bd"><span class="section-number-5">2.2.4.2</span> Double-precision</h5> <h5 id="org36a23f7"><span class="section-number-5">2.2.4.2</span> Double-precision</h5>
<div class="outline-text-5" id="text-2-2-4-2"> <div class="outline-text-5" id="text-2-2-4-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC
@ -1173,12 +1173,12 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
</div> </div>
<div id="outline-container-org193aef2" class="outline-3"> <div id="outline-container-orgf538c42" class="outline-3">
<h3 id="org193aef2"><span class="section-number-3">2.3</span> Computation of MOs: values, gradient, Laplacian</h3> <h3 id="orgf538c42"><span class="section-number-3">2.3</span> Computation of MOs: values, gradient, Laplacian</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
</div> </div>
<div id="outline-container-org6bae88c" class="outline-4"> <div id="outline-container-org13be620" class="outline-4">
<h4 id="org6bae88c"><span class="section-number-4">2.3.1</span> Get</h4> <h4 id="org13be620"><span class="section-number-4">2.3.1</span> Get</h4>
<div class="outline-text-4" id="text-2-3-1"> <div class="outline-text-4" id="text-2-3-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -1202,8 +1202,8 @@ Uses the given array to compute the VGL.
</div> </div>
</div> </div>
<div id="outline-container-org3682081" class="outline-4"> <div id="outline-container-org170a90f" class="outline-4">
<h4 id="org3682081"><span class="section-number-4">2.3.2</span> Provide</h4> <h4 id="org170a90f"><span class="section-number-4">2.3.2</span> Provide</h4>
<div class="outline-text-4" id="text-2-3-2"> <div class="outline-text-4" id="text-2-3-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_provide_mo_basis_mo_vgl</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_provide_mo_basis_mo_vgl</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>);
@ -1287,10 +1287,10 @@ Uses the given array to compute the VGL.
</div> </div>
</div> </div>
<div id="outline-container-org2a6a7b8" class="outline-4"> <div id="outline-container-org013c975" class="outline-4">
<h4 id="org2a6a7b8"><span class="section-number-4">2.3.3</span> Compute</h4> <h4 id="org013c975"><span class="section-number-4">2.3.3</span> Compute</h4>
<div class="outline-text-4" id="text-2-3-3"> <div class="outline-text-4" id="text-2-3-3">
<table id="org0577a60" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgba3e5e0" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1464,14 +1464,14 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
</div> </div>
<div id="outline-container-orgc38c12c" class="outline-3"> <div id="outline-container-orga4e27ea" class="outline-3">
<h3 id="orgc38c12c"><span class="section-number-3">2.4</span> Computation of cusp-corrected MOs: values only</h3> <h3 id="orga4e27ea"><span class="section-number-3">2.4</span> Computation of cusp-corrected MOs: values only</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
</div> </div>
<div id="outline-container-org6361d2f" class="outline-4"> <div id="outline-container-org6c13f9b" class="outline-4">
<h4 id="org6361d2f"><span class="section-number-4">2.4.1</span> Compute</h4> <h4 id="org6c13f9b"><span class="section-number-4">2.4.1</span> Compute</h4>
<div class="outline-text-4" id="text-2-4-1"> <div class="outline-text-4" id="text-2-4-1">
<table id="org39234fb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc52e8c0" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -1710,8 +1710,8 @@ matrix multiplication instead of a dgemm, as exposed in
</div> </div>
</div> </div>
<div id="outline-container-org4216a23" class="outline-4"> <div id="outline-container-orga91d82f" class="outline-4">
<h4 id="org4216a23"><span class="section-number-4">2.4.2</span> HPC version</h4> <h4 id="orga91d82f"><span class="section-number-4">2.4.2</span> HPC version</h4>
<div class="outline-text-4" id="text-2-4-2"> <div class="outline-text-4" id="text-2-4-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC
@ -1851,14 +1851,14 @@ IVDEP
</div> </div>
</div> </div>
<div id="outline-container-org454b6cb" class="outline-3"> <div id="outline-container-orgd8c7b5b" class="outline-3">
<h3 id="org454b6cb"><span class="section-number-3">2.5</span> Computation of cusp-corrected MOs: values, gradient, Laplacian</h3> <h3 id="orgd8c7b5b"><span class="section-number-3">2.5</span> Computation of cusp-corrected MOs: values, gradient, Laplacian</h3>
<div class="outline-text-3" id="text-2-5"> <div class="outline-text-3" id="text-2-5">
</div> </div>
<div id="outline-container-org15e7a59" class="outline-4"> <div id="outline-container-org0775657" class="outline-4">
<h4 id="org15e7a59"><span class="section-number-4">2.5.1</span> Compute</h4> <h4 id="org0775657"><span class="section-number-4">2.5.1</span> Compute</h4>
<div class="outline-text-4" id="text-2-5-1"> <div class="outline-text-4" id="text-2-5-1">
<table id="org9149207" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org829788f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -2154,8 +2154,8 @@ IVDEP
</div> </div>
</div> </div>
<div id="outline-container-orgb7ec7c8" class="outline-4"> <div id="outline-container-org27491c1" class="outline-4">
<h4 id="orgb7ec7c8"><span class="section-number-4">2.5.2</span> HPC version</h4> <h4 id="org27491c1"><span class="section-number-4">2.5.2</span> HPC version</h4>
<div class="outline-text-4" id="text-2-5-2"> <div class="outline-text-4" id="text-2-5-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_HPC
@ -2356,8 +2356,8 @@ IVDEP
</div> </div>
</div> </div>
<div id="outline-container-orgec9da3d" class="outline-3"> <div id="outline-container-orgb3034a5" class="outline-3">
<h3 id="orgec9da3d"><span class="section-number-3">2.6</span> Rescaling of MO coefficients</h3> <h3 id="orgb3034a5"><span class="section-number-3">2.6</span> Rescaling of MO coefficients</h3>
<div class="outline-text-3" id="text-2-6"> <div class="outline-text-3" id="text-2-6">
<p> <p>
When evaluating Slater determinants, the value of the determinants When evaluating Slater determinants, the value of the determinants
@ -2374,19 +2374,19 @@ correct range.
</div> </div>
</div> </div>
<div id="outline-container-org930038e" class="outline-4"> <div id="outline-container-org04e2d2c" class="outline-4">
<h4 id="org930038e"><span class="section-number-4">2.6.1</span> Fortran interface</h4> <h4 id="org04e2d2c"><span class="section-number-4">2.6.1</span> Fortran interface</h4>
</div> </div>
</div> </div>
<div id="outline-container-org53d3b35" class="outline-3"> <div id="outline-container-org269a076" class="outline-3">
<h3 id="org53d3b35"><span class="section-number-3">2.7</span> Test</h3> <h3 id="org269a076"><span class="section-number-3">2.7</span> Test</h3>
</div> </div>
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

92
qmckl_nucleus.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Nucleus</title> <title>Nucleus</title>
@ -346,28 +346,28 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgd3cb4e8">1. Context</a> <li><a href="#org9034fd7">1. Context</a>
<ul> <ul>
<li><a href="#orgbcaf5f3">1.1. Data structure</a></li> <li><a href="#org0962649">1.1. Data structure</a></li>
<li><a href="#orgc6e014f">1.2. Access functions</a></li> <li><a href="#org6d995a3">1.2. Access functions</a></li>
<li><a href="#orgfee63ef">1.3. Initialization functions</a></li> <li><a href="#org3afaf9c">1.3. Initialization functions</a></li>
<li><a href="#org3743edd">1.4. Test</a></li> <li><a href="#orgb5b451b">1.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org46ca294">2. Computation</a> <li><a href="#orgd06fd89">2. Computation</a>
<ul> <ul>
<li><a href="#org6f0c81e">2.1. Nucleus-nucleus distances</a> <li><a href="#orga3f80ae">2.1. Nucleus-nucleus distances</a>
<ul> <ul>
<li><a href="#org2d593c4">2.1.1. Get</a></li> <li><a href="#org4143879">2.1.1. Get</a></li>
<li><a href="#orgc05091b">2.1.2. Compute</a></li> <li><a href="#orgb8c8588">2.1.2. Compute</a></li>
<li><a href="#org7f9e933">2.1.3. Test</a></li> <li><a href="#orge425b45">2.1.3. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgb9f70c5">2.2. Nuclear repulsion energy</a> <li><a href="#orga799f63">2.2. Nuclear repulsion energy</a>
<ul> <ul>
<li><a href="#org0705213">2.2.1. Get</a></li> <li><a href="#orga652e72">2.2.1. Get</a></li>
<li><a href="#org4dc08a6">2.2.2. Compute</a></li> <li><a href="#orge494dc3">2.2.2. Compute</a></li>
<li><a href="#org1e12f4b">2.2.3. Test</a></li> <li><a href="#orgc65579a">2.2.3. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -376,8 +376,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgd3cb4e8" class="outline-2"> <div id="outline-container-org9034fd7" class="outline-2">
<h2 id="orgd3cb4e8"><span class="section-number-2">1</span> Context</h2> <h2 id="org9034fd7"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following data stored in the context: The following data stored in the context:
@ -474,8 +474,8 @@ Computed data:
</table> </table>
</div> </div>
<div id="outline-container-orgbcaf5f3" class="outline-3"> <div id="outline-container-org0962649" class="outline-3">
<h3 id="orgbcaf5f3"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org0962649"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_nucleus_struct</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_nucleus_struct</span> {
@ -529,8 +529,8 @@ this mechanism.
</div> </div>
</div> </div>
<div id="outline-container-orgc6e014f" class="outline-3"> <div id="outline-container-org6d995a3" class="outline-3">
<h3 id="orgc6e014f"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="org6d995a3"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
When all the data relative to nuclei have been set, the following When all the data relative to nuclei have been set, the following
@ -544,8 +544,8 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-orgfee63ef" class="outline-3"> <div id="outline-container-org3afaf9c" class="outline-3">
<h3 id="orgfee63ef"><span class="section-number-3">1.3</span> Initialization functions</h3> <h3 id="org3afaf9c"><span class="section-number-3">1.3</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
To set the data relative to the nuclei in the context, the To set the data relative to the nuclei in the context, the
@ -591,8 +591,8 @@ are be given in atomic units.
</div> </div>
</div> </div>
<div id="outline-container-org3743edd" class="outline-3"> <div id="outline-container-orgb5b451b" class="outline-3">
<h3 id="org3743edd"><span class="section-number-3">1.4</span> Test</h3> <h3 id="orgb5b451b"><span class="section-number-3">1.4</span> Test</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">nucl_charge</span> = chbrclf_charge; <pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">nucl_charge</span> = chbrclf_charge;
@ -661,8 +661,8 @@ rc = qmckl_get_nucleus_charge(context, nucl_charge2, chbrclf_nucl_num);
</div> </div>
</div> </div>
<div id="outline-container-org46ca294" class="outline-2"> <div id="outline-container-orgd06fd89" class="outline-2">
<h2 id="org46ca294"><span class="section-number-2">2</span> Computation</h2> <h2 id="orgd06fd89"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The computed data is stored in the context so that it can be reused The computed data is stored in the context so that it can be reused
@ -675,12 +675,12 @@ current date is stored.
</p> </p>
</div> </div>
<div id="outline-container-org6f0c81e" class="outline-3"> <div id="outline-container-orga3f80ae" class="outline-3">
<h3 id="org6f0c81e"><span class="section-number-3">2.1</span> Nucleus-nucleus distances</h3> <h3 id="orga3f80ae"><span class="section-number-3">2.1</span> Nucleus-nucleus distances</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
</div> </div>
<div id="outline-container-org2d593c4" class="outline-4"> <div id="outline-container-org4143879" class="outline-4">
<h4 id="org2d593c4"><span class="section-number-4">2.1.1</span> Get</h4> <h4 id="org4143879"><span class="section-number-4">2.1.1</span> Get</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -692,10 +692,10 @@ current date is stored.
</div> </div>
</div> </div>
<div id="outline-container-orgc05091b" class="outline-4"> <div id="outline-container-orgb8c8588" class="outline-4">
<h4 id="orgc05091b"><span class="section-number-4">2.1.2</span> Compute</h4> <h4 id="orgb8c8588"><span class="section-number-4">2.1.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<table id="orga2b8740" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org8a33f46" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -773,8 +773,8 @@ current date is stored.
</div> </div>
</div> </div>
<div id="outline-container-org7f9e933" class="outline-4"> <div id="outline-container-orge425b45" class="outline-4">
<h4 id="org7f9e933"><span class="section-number-4">2.1.3</span> Test</h4> <h4 id="orge425b45"><span class="section-number-4">2.1.3</span> Test</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */ <pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */
@ -793,8 +793,8 @@ rc = qmckl_get_nucleus_nn_distance(context, distance, chbrclf_nucl_num*chbrclf_n
</div> </div>
</div> </div>
<div id="outline-container-orgb9f70c5" class="outline-3"> <div id="outline-container-orga799f63" class="outline-3">
<h3 id="orgb9f70c5"><span class="section-number-3">2.2</span> Nuclear repulsion energy</h3> <h3 id="orga799f63"><span class="section-number-3">2.2</span> Nuclear repulsion energy</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
\[ \[
@ -803,8 +803,8 @@ rc = qmckl_get_nucleus_nn_distance(context, distance, chbrclf_nucl_num*chbrclf_n
</p> </p>
</div> </div>
<div id="outline-container-org0705213" class="outline-4"> <div id="outline-container-orga652e72" class="outline-4">
<h4 id="org0705213"><span class="section-number-4">2.2.1</span> Get</h4> <h4 id="orga652e72"><span class="section-number-4">2.2.1</span> Get</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_nucleus_repulsion</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">energy</span>); <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_nucleus_repulsion</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">energy</span>);
@ -813,10 +813,10 @@ rc = qmckl_get_nucleus_nn_distance(context, distance, chbrclf_nucl_num*chbrclf_n
</div> </div>
</div> </div>
<div id="outline-container-org4dc08a6" class="outline-4"> <div id="outline-container-orge494dc3" class="outline-4">
<h4 id="org4dc08a6"><span class="section-number-4">2.2.2</span> Compute</h4> <h4 id="orge494dc3"><span class="section-number-4">2.2.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-2-2"> <div class="outline-text-4" id="text-2-2-2">
<table id="org2985cc5" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org18fa1ec" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -906,8 +906,8 @@ rc = qmckl_get_nucleus_nn_distance(context, distance, chbrclf_nucl_num*chbrclf_n
</div> </div>
</div> </div>
<div id="outline-container-org1e12f4b" class="outline-4"> <div id="outline-container-orgc65579a" class="outline-4">
<h4 id="org1e12f4b"><span class="section-number-4">2.2.3</span> Test</h4> <h4 id="orgc65579a"><span class="section-number-4">2.2.3</span> Test</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */ <pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */
@ -927,7 +927,7 @@ rc = qmckl_get_nucleus_repulsion(context, &amp;rep);
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

54
qmckl_numprec.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title> <title>&lrm;</title>
@ -345,18 +345,18 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orga7758b7">1. Control of the numerical precision</a></li> <li><a href="#org0af112e">1. Control of the numerical precision</a></li>
<li><a href="#orgaef4cc2">2. Precision</a></li> <li><a href="#orgf783026">2. Precision</a></li>
<li><a href="#org3556767">3. Range</a></li> <li><a href="#org2e77d1b">3. Range</a></li>
<li><a href="#org05dde97">4. Helper functions</a> <li><a href="#org4d49690">4. Helper functions</a>
<ul> <ul>
<li><a href="#orgbaeb19d">4.1. Epsilon</a></li> <li><a href="#org4984ce5">4.1. Epsilon</a></li>
<li><a href="#org4b9c21d">4.2. Testing the number of unchanged bits</a></li> <li><a href="#org0ceda11">4.2. Testing the number of unchanged bits</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga14c0b4">5. Approximate functions</a> <li><a href="#org788f5d9">5. Approximate functions</a>
<ul> <ul>
<li><a href="#org42fca28">5.1. Exponential</a></li> <li><a href="#orgd7cc8eb">5.1. Exponential</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -366,8 +366,8 @@ for the JavaScript code in this tag.
3+TITLE: Numerical precision 3+TITLE: Numerical precision
</p> </p>
<div id="outline-container-orga7758b7" class="outline-2"> <div id="outline-container-org0af112e" class="outline-2">
<h2 id="orga7758b7"><span class="section-number-2">1</span> Control of the numerical precision</h2> <h2 id="org0af112e"><span class="section-number-2">1</span> Control of the numerical precision</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
Controlling numerical precision enables optimizations. Here, the Controlling numerical precision enables optimizations. Here, the
@ -378,7 +378,7 @@ Arithmetic (IEEE 754),
sign bit) and <i>range</i> refers to the number of exponent bits. sign bit) and <i>range</i> refers to the number of exponent bits.
</p> </p>
<table id="orgc22a454" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga2f0907" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -422,8 +422,8 @@ integer. The update functions return <code>QMCKL_SUCCESS</code> or
</div> </div>
</div> </div>
<div id="outline-container-orgaef4cc2" class="outline-2"> <div id="outline-container-orgf783026" class="outline-2">
<h2 id="orgaef4cc2"><span class="section-number-2">2</span> Precision</h2> <h2 id="orgf783026"><span class="section-number-2">2</span> Precision</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
<code>qmckl_context_set_numprec_precision</code> modifies the parameter for the <code>qmckl_context_set_numprec_precision</code> modifies the parameter for the
@ -510,8 +510,8 @@ numerical precision in the context.
</div> </div>
</div> </div>
<div id="outline-container-org3556767" class="outline-2"> <div id="outline-container-org2e77d1b" class="outline-2">
<h2 id="org3556767"><span class="section-number-2">3</span> Range</h2> <h2 id="org2e77d1b"><span class="section-number-2">3</span> Range</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
<code>qmckl_set_numprec_range</code> modifies the parameter for the numerical <code>qmckl_set_numprec_range</code> modifies the parameter for the numerical
@ -586,12 +586,12 @@ range in a given context.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org05dde97" class="outline-2"> <div id="outline-container-org4d49690" class="outline-2">
<h2 id="org05dde97"><span class="section-number-2">4</span> Helper functions</h2> <h2 id="org4d49690"><span class="section-number-2">4</span> Helper functions</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
</div> </div>
<div id="outline-container-orgbaeb19d" class="outline-3"> <div id="outline-container-org4984ce5" class="outline-3">
<h3 id="orgbaeb19d"><span class="section-number-3">4.1</span> Epsilon</h3> <h3 id="org4984ce5"><span class="section-number-3">4.1</span> Epsilon</h3>
<div class="outline-text-3" id="text-4-1"> <div class="outline-text-3" id="text-4-1">
<p> <p>
<code>qmckl_get_numprec_epsilon</code> returns \(\epsilon = 2^{1-n}\) where <code>n</code> is the precision. <code>qmckl_get_numprec_epsilon</code> returns \(\epsilon = 2^{1-n}\) where <code>n</code> is the precision.
@ -610,8 +610,8 @@ We need to remove the sign bit from the precision.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org4b9c21d" class="outline-3"> <div id="outline-container-org0ceda11" class="outline-3">
<h3 id="org4b9c21d"><span class="section-number-3">4.2</span> Testing the number of unchanged bits</h3> <h3 id="org0ceda11"><span class="section-number-3">4.2</span> Testing the number of unchanged bits</h3>
<div class="outline-text-3" id="text-4-2"> <div class="outline-text-3" id="text-4-2">
<p> <p>
To test that a given approximation keeps a given number of bits To test that a given approximation keeps a given number of bits
@ -681,12 +681,12 @@ numbers differ.
</div> </div>
</div> </div>
<div id="outline-container-orga14c0b4" class="outline-2"> <div id="outline-container-org788f5d9" class="outline-2">
<h2 id="orga14c0b4"><span class="section-number-2">5</span> Approximate functions</h2> <h2 id="org788f5d9"><span class="section-number-2">5</span> Approximate functions</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
</div> </div>
<div id="outline-container-org42fca28" class="outline-3"> <div id="outline-container-orgd7cc8eb" class="outline-3">
<h3 id="org42fca28"><span class="section-number-3">5.1</span> Exponential</h3> <h3 id="orgd7cc8eb"><span class="section-number-3">5.1</span> Exponential</h3>
<div class="outline-text-3" id="text-5-1"> <div class="outline-text-3" id="text-5-1">
<p> <p>
Fast exponential function, adapted from Johan Rade's implementation Fast exponential function, adapted from Johan Rade's implementation
@ -741,7 +741,7 @@ N. Schraudolph, "A Fast, Compact Approximation of the Exponential Function",
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

46
qmckl_point.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Point</title> <title>Point</title>
@ -346,25 +346,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org7613844">1. Context</a> <li><a href="#org960c05e">1. Context</a>
<ul> <ul>
<li><a href="#orgc691605">1.1. Data structure</a></li> <li><a href="#org5ec145b">1.1. Data structure</a></li>
<li><a href="#org650aeda">1.2. Access functions</a> <li><a href="#org081e736">1.2. Access functions</a>
<ul> <ul>
<li><a href="#orge85fd98">1.2.1. Number of points</a></li> <li><a href="#org5364916">1.2.1. Number of points</a></li>
<li><a href="#orge1dc760">1.2.2. Point coordinates</a></li> <li><a href="#org1020d99">1.2.2. Point coordinates</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org753fbd9">1.3. Initialization functions</a></li> <li><a href="#orgca4460f">1.3. Initialization functions</a></li>
<li><a href="#org83d014d">1.4. Test</a></li> <li><a href="#org0fd9f0c">1.4. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org7613844" class="outline-2"> <div id="outline-container-org960c05e" class="outline-2">
<h2 id="org7613844"><span class="section-number-2">1</span> Context</h2> <h2 id="org960c05e"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following data stored in the context: The following data stored in the context:
@ -414,8 +414,8 @@ corresponds to the 3 &times; <code>num</code> matrix.
</p> </p>
</div> </div>
<div id="outline-container-orgc691605" class="outline-3"> <div id="outline-container-org5ec145b" class="outline-3">
<h3 id="orgc691605"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org5ec145b"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_point_struct</span> { <pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_point_struct</span> {
@ -451,8 +451,8 @@ corresponds to the 3 &times; <code>num</code> matrix.
</div> </div>
</div> </div>
<div id="outline-container-org650aeda" class="outline-3"> <div id="outline-container-org081e736" class="outline-3">
<h3 id="org650aeda"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="org081e736"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
Access functions return <code>QMCKL_SUCCESS</code> when the data has been Access functions return <code>QMCKL_SUCCESS</code> when the data has been
@ -463,8 +463,8 @@ contains the requested data. Otherwise, this variable is untouched.
</p> </p>
</div> </div>
<div id="outline-container-orge85fd98" class="outline-4"> <div id="outline-container-org5364916" class="outline-4">
<h4 id="orge85fd98"><span class="section-number-4">1.2.1</span> Number of points</h4> <h4 id="org5364916"><span class="section-number-4">1.2.1</span> Number of points</h4>
<div class="outline-text-4" id="text-1-2-1"> <div class="outline-text-4" id="text-1-2-1">
<p> <p>
Returns the number of points stored in the context. Returns the number of points stored in the context.
@ -486,8 +486,8 @@ Returns the number of points stored in the context.
</div> </div>
</div> </div>
<div id="outline-container-orge1dc760" class="outline-4"> <div id="outline-container-org1020d99" class="outline-4">
<h4 id="orge1dc760"><span class="section-number-4">1.2.2</span> Point coordinates</h4> <h4 id="org1020d99"><span class="section-number-4">1.2.2</span> Point coordinates</h4>
<div class="outline-text-4" id="text-1-2-2"> <div class="outline-text-4" id="text-1-2-2">
<p> <p>
Returns the point coordinates as sequences of (x,y,z). Returns the point coordinates as sequences of (x,y,z).
@ -515,8 +515,8 @@ The pointer is assumed to point on a memory block of size
</div> </div>
<div id="outline-container-org753fbd9" class="outline-3"> <div id="outline-container-orgca4460f" class="outline-3">
<h3 id="org753fbd9"><span class="section-number-3">1.3</span> Initialization functions</h3> <h3 id="orgca4460f"><span class="section-number-3">1.3</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
When the data is set in the context, if the arrays are large When the data is set in the context, if the arrays are large
@ -655,8 +655,8 @@ Copy a sequence of <code>num</code> points \((x,y,z)\) into the context.
</div> </div>
<div id="outline-container-org83d014d" class="outline-3"> <div id="outline-container-org0fd9f0c" class="outline-3">
<h3 id="org83d014d"><span class="section-number-3">1.4</span> Test</h3> <h3 id="org0fd9f0c"><span class="section-number-3">1.4</span> Test</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */ <pre class="src src-c">/* <span style="color: #b22222;">Reference input data</span> */
@ -715,7 +715,7 @@ rc = qmckl_get_point (context, <span style="color: #8b2252;">'N'</span>, coord3,
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

398
qmckl_sherman_morrison_woodbury.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Sherman-Morrison-Woodbury</title> <title>Sherman-Morrison-Woodbury</title>
@ -346,118 +346,118 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org4b761ff">1. Headers</a></li> <li><a href="#orgc6e46f5">1. Headers</a></li>
<li><a href="#orgf74b9d9">2. Naïve Sherman-Morrison</a> <li><a href="#org9aeb01c">2. Naïve Sherman-Morrison</a>
<ul> <ul>
<li><a href="#org414f0f5">2.1. <code>qmckl_sm_naive</code></a> <li><a href="#orge607e86">2.1. <code>qmckl_sm_naive</code></a>
<ul> <ul>
<li><a href="#org2483b3b">2.1.1. Introduction</a></li> <li><a href="#org709c90f">2.1.1. Introduction</a></li>
<li><a href="#org6234408">2.1.2. API</a></li> <li><a href="#org432247f">2.1.2. API</a></li>
<li><a href="#org93ca85f">2.1.3. Requirements</a></li> <li><a href="#org4410d21">2.1.3. Requirements</a></li>
<li><a href="#org4d42f2f">2.1.4. Pedagogical kernel source (in Fortran)</a> <li><a href="#org1ed3f85">2.1.4. Pedagogical kernel source (in Fortran)</a>
<ul> <ul>
<li><a href="#orge1a8601">2.1.4.1. C interface (not directly exposed)</a></li> <li><a href="#orgccdc8c2">2.1.4.1. C interface (not directly exposed)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgd57e8e2">2.1.5. C headers (exposed in qmckl.h)</a></li> <li><a href="#orgd5a0981">2.1.5. C headers (exposed in qmckl.h)</a></li>
<li><a href="#orgb1966ba">2.1.6. C sources</a></li> <li><a href="#orgd5c8d77">2.1.6. C sources</a></li>
<li><a href="#org8f517d4">2.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li> <li><a href="#org008f1e4">2.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li>
<li><a href="#org79ce62a">2.1.8. Performance</a></li> <li><a href="#org280a353">2.1.8. Performance</a></li>
<li><a href="#org177cf9d">2.1.9. Tests</a></li> <li><a href="#org679d7d3">2.1.9. Tests</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#orgce485ea">3. Sherman-Morrison with Slagel Splitting (core)</a> <li><a href="#org66e819b">3. Sherman-Morrison with Slagel Splitting (core)</a>
<ul> <ul>
<li><a href="#orgd2c38d2">3.1. <code>qmckl_sm_splitting_core</code></a> <li><a href="#org3145b90">3.1. <code>qmckl_sm_splitting_core</code></a>
<ul> <ul>
<li><a href="#org27dab55">3.1.1. Introduction</a></li> <li><a href="#orgaaa37f0">3.1.1. Introduction</a></li>
<li><a href="#orge5857a4">3.1.2. API</a></li> <li><a href="#orgac836f2">3.1.2. API</a></li>
<li><a href="#org5534f32">3.1.3. Requirements</a></li> <li><a href="#orga630fdc">3.1.3. Requirements</a></li>
<li><a href="#org4896c83">3.1.4. Pedagogical kernel source (in Fortran)</a> <li><a href="#orge5b131b">3.1.4. Pedagogical kernel source (in Fortran)</a>
<ul> <ul>
<li><a href="#org4462144">3.1.4.1. C interface to the pedagogical kernel (not directly exposed)</a></li> <li><a href="#org42dbe50">3.1.4.1. C interface to the pedagogical kernel (not directly exposed)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgb855439">3.1.5. C headers (exposed in qmckl.h)</a></li> <li><a href="#org245cce6">3.1.5. C headers (exposed in qmckl.h)</a></li>
<li><a href="#org5d8cb2c">3.1.6. C sources</a></li> <li><a href="#org68c207d">3.1.6. C sources</a></li>
<li><a href="#orgea8db29">3.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li> <li><a href="#orgdcab0cf">3.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li>
<li><a href="#org93d4b1c">3.1.8. Performance</a></li> <li><a href="#org2901a0a">3.1.8. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org2dbbaa6">4. Woodbury 2x2</a> <li><a href="#orgce22a6a">4. Woodbury 2x2</a>
<ul> <ul>
<li><a href="#orgf7e65ca">4.1. <code>qmckl_woodbury_2x2</code></a> <li><a href="#org030a1b3">4.1. <code>qmckl_woodbury_2x2</code></a>
<ul> <ul>
<li><a href="#org50a6ece">4.1.1. Introduction</a></li> <li><a href="#orgd58cc16">4.1.1. Introduction</a></li>
<li><a href="#orge299f5b">4.1.2. API</a></li> <li><a href="#orge8d9fb1">4.1.2. API</a></li>
<li><a href="#org67d8828">4.1.3. Requirements</a></li> <li><a href="#orgade39bd">4.1.3. Requirements</a></li>
<li><a href="#orgf512ccf">4.1.4. Pedagogical kernel source (in Fortran)</a> <li><a href="#orgfe6bf97">4.1.4. Pedagogical kernel source (in Fortran)</a>
<ul> <ul>
<li><a href="#orge15f565">4.1.4.1. C interface (not directly exposed)</a></li> <li><a href="#orgcf03f2f">4.1.4.1. C interface (not directly exposed)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgf66b3fe">4.1.5. C headers (exposed in qmckl.h)</a></li> <li><a href="#orga05866f">4.1.5. C headers (exposed in qmckl.h)</a></li>
<li><a href="#orgeff6b95">4.1.6. C sources</a></li> <li><a href="#orgba336fe">4.1.6. C sources</a></li>
<li><a href="#orgae64b69">4.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li> <li><a href="#org4e8479b">4.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li>
<li><a href="#org5fdd27d">4.1.8. Performance</a></li> <li><a href="#org162f059">4.1.8. Performance</a></li>
<li><a href="#org3661773">4.1.9. Tests</a></li> <li><a href="#orgb52be07">4.1.9. Tests</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org1b902a2">5. Woodbury 3x3</a> <li><a href="#org03b3087">5. Woodbury 3x3</a>
<ul> <ul>
<li><a href="#orgc6b4e40">5.1. <code>qmckl_woodbury_3x3</code></a> <li><a href="#org19d5f1f">5.1. <code>qmckl_woodbury_3x3</code></a>
<ul> <ul>
<li><a href="#orgc94efb8">5.1.1. Introduction</a></li> <li><a href="#orgb928790">5.1.1. Introduction</a></li>
<li><a href="#org44f2dc5">5.1.2. API</a></li> <li><a href="#orgac5390d">5.1.2. API</a></li>
<li><a href="#org3bb26d9">5.1.3. Requirements</a></li> <li><a href="#orgd670c86">5.1.3. Requirements</a></li>
<li><a href="#orgd677b43">5.1.4. Pedagogical kernel source (in Fortran)</a> <li><a href="#orgdbd0139">5.1.4. Pedagogical kernel source (in Fortran)</a>
<ul> <ul>
<li><a href="#org9511294">5.1.4.1. C interface (not directly exposed)</a></li> <li><a href="#org91fb00c">5.1.4.1. C interface (not directly exposed)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgf067d44">5.1.5. C headers (exposed in qmckl.h)</a></li> <li><a href="#orge7a0ba3">5.1.5. C headers (exposed in qmckl.h)</a></li>
<li><a href="#orgf0ec943">5.1.6. C sources</a></li> <li><a href="#org0651076">5.1.6. C sources</a></li>
<li><a href="#orgde2185f">5.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li> <li><a href="#org5f72441">5.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li>
<li><a href="#org7896467">5.1.8. Performance</a></li> <li><a href="#org4668176">5.1.8. Performance</a></li>
<li><a href="#org8043627">5.1.9. Tests</a></li> <li><a href="#orgddab051">5.1.9. Tests</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org5a840a3">6. Sherman-Morrison with Slagel Splitting</a> <li><a href="#orgd42e663">6. Sherman-Morrison with Slagel Splitting</a>
<ul> <ul>
<li><a href="#orga050147">6.1. <code>qmckl_sm_splitting</code></a> <li><a href="#orgfff2266">6.1. <code>qmckl_sm_splitting</code></a>
<ul> <ul>
<li><a href="#org1a54ddd">6.1.1. Introduction</a></li> <li><a href="#org12516ca">6.1.1. Introduction</a></li>
<li><a href="#org8e09e0e">6.1.2. API</a></li> <li><a href="#org67a4578">6.1.2. API</a></li>
<li><a href="#orgdd71d3d">6.1.3. Requirements</a></li> <li><a href="#org358d3a9">6.1.3. Requirements</a></li>
<li><a href="#org911127e">6.1.4. Pedagogical kernel source (in Fortran)</a> <li><a href="#orgf7dd741">6.1.4. Pedagogical kernel source (in Fortran)</a>
<ul> <ul>
<li><a href="#org04eaa7b">6.1.4.1. C interface to the pedagogical kernel (not directly exposed)</a></li> <li><a href="#org75b7357">6.1.4.1. C interface to the pedagogical kernel (not directly exposed)</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org32843ca">6.1.5. C headers (exposed in qmckl.h)</a></li> <li><a href="#org363817e">6.1.5. C headers (exposed in qmckl.h)</a></li>
<li><a href="#org46145b4">6.1.6. C source</a></li> <li><a href="#orgbfc148f">6.1.6. C source</a></li>
<li><a href="#orgaa9fa94">6.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li> <li><a href="#org8d11b71">6.1.7. Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</a></li>
<li><a href="#org475bf1a">6.1.8. Performance&#x2026;</a></li> <li><a href="#org4f9cc81">6.1.8. Performance&#x2026;</a></li>
<li><a href="#org1bfbb86">6.1.9. Test</a></li> <li><a href="#orgcc5073c">6.1.9. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org1b9c251">7. End of files</a></li> <li><a href="#orgc08599f">7. End of files</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org4b761ff" class="outline-2"> <div id="outline-container-orgc6e46f5" class="outline-2">
<h2 id="org4b761ff"><span class="section-number-2">1</span> Headers</h2> <h2 id="orgc6e46f5"><span class="section-number-2">1</span> Headers</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#include</span> <span style="color: #8b2252;">"qmckl.h"</span> <pre class="src src-c"><span style="color: #483d8b;">#include</span> <span style="color: #8b2252;">"qmckl.h"</span>
@ -479,17 +479,17 @@ This is the range that determines the how many high performance kernel instantce
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgf74b9d9" class="outline-2"> <div id="outline-container-org9aeb01c" class="outline-2">
<h2 id="orgf74b9d9"><span class="section-number-2">2</span> Naïve Sherman-Morrison</h2> <h2 id="org9aeb01c"><span class="section-number-2">2</span> Naïve Sherman-Morrison</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org414f0f5" class="outline-3"> <div id="outline-container-orge607e86" class="outline-3">
<h3 id="org414f0f5"><span class="section-number-3">2.1</span> <code>qmckl_sm_naive</code></h3> <h3 id="orge607e86"><span class="section-number-3">2.1</span> <code>qmckl_sm_naive</code></h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
</div> </div>
<div id="outline-container-org2483b3b" class="outline-4"> <div id="outline-container-org709c90f" class="outline-4">
<h4 id="org2483b3b"><span class="section-number-4">2.1.1</span> Introduction</h4> <h4 id="org709c90f"><span class="section-number-4">2.1.1</span> Introduction</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<p> <p>
This is the simplest of the available Sherman-Morrison-Woodbury kernels. It applies rank-1 updates one by one in This is the simplest of the available Sherman-Morrison-Woodbury kernels. It applies rank-1 updates one by one in
@ -539,10 +539,10 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org6234408" class="outline-4"> <div id="outline-container-org432247f" class="outline-4">
<h4 id="org6234408"><span class="section-number-4">2.1.2</span> API</h4> <h4 id="org432247f"><span class="section-number-4">2.1.2</span> API</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<table id="orge8345cb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgacc264c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -630,8 +630,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org93ca85f" class="outline-4"> <div id="outline-container-org4410d21" class="outline-4">
<h4 id="org93ca85f"><span class="section-number-4">2.1.3</span> Requirements</h4> <h4 id="org4410d21"><span class="section-number-4">2.1.3</span> Requirements</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
@ -647,8 +647,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org4d42f2f" class="outline-4"> <div id="outline-container-org1ed3f85" class="outline-4">
<h4 id="org4d42f2f"><span class="section-number-4">2.1.4</span> Pedagogical kernel source (in Fortran)</h4> <h4 id="org1ed3f85"><span class="section-number-4">2.1.4</span> Pedagogical kernel source (in Fortran)</h4>
<div class="outline-text-4" id="text-2-1-4"> <div class="outline-text-4" id="text-2-1-4">
<p> <p>
The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is
@ -742,8 +742,8 @@ not be used in real workloads.
</div> </div>
</div> </div>
<div id="outline-container-orge1a8601" class="outline-5"> <div id="outline-container-orgccdc8c2" class="outline-5">
<h5 id="orge1a8601"><span class="section-number-5">2.1.4.1</span> C interface (not directly exposed)</h5> <h5 id="orgccdc8c2"><span class="section-number-5">2.1.4.1</span> C interface (not directly exposed)</h5>
<div class="outline-text-5" id="text-2-1-4-1"> <div class="outline-text-5" id="text-2-1-4-1">
<p> <p>
The following Fortran function <code>qmckl_sm_naive_doc</code> makes sure The following Fortran function <code>qmckl_sm_naive_doc</code> makes sure
@ -755,8 +755,8 @@ for C users and in the module file 'qmckl<sub>f.F90</sub>' for Fortran users.
</div> </div>
</div> </div>
<div id="outline-container-orgd57e8e2" class="outline-4"> <div id="outline-container-orgd5a0981" class="outline-4">
<h4 id="orgd57e8e2"><span class="section-number-4">2.1.5</span> C headers (exposed in qmckl.h)</h4> <h4 id="orgd5a0981"><span class="section-number-4">2.1.5</span> C headers (exposed in qmckl.h)</h4>
<div class="outline-text-4" id="text-2-1-5"> <div class="outline-text-4" id="text-2-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_naive</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_naive</span> (
@ -802,8 +802,8 @@ for C users and in the module file 'qmckl<sub>f.F90</sub>' for Fortran users.
</div> </div>
</div> </div>
<div id="outline-container-orgb1966ba" class="outline-4"> <div id="outline-container-orgd5c8d77" class="outline-4">
<h4 id="orgb1966ba"><span class="section-number-4">2.1.6</span> C sources</h4> <h4 id="orgd5c8d77"><span class="section-number-4">2.1.6</span> C sources</h4>
<div class="outline-text-4" id="text-2-1-6"> <div class="outline-text-4" id="text-2-1-6">
<p> <p>
Common includes and macros used by all the Sherman-Morrison-Woodbury kernels. Common includes and macros used by all the Sherman-Morrison-Woodbury kernels.
@ -905,7 +905,7 @@ multiple of <code>SIMD_LENGTH</code>.
<code>qmckl_exit_code qmckl_sm_naive_{Dim}</code> is a C function-template that is used to genereate instances of C fucntions based on the range given above. The advantage of this method is that for each of these instances all the dimensions and loop-bounds are known at compile time, allowing the compiler to optimize more aggressively. <code>qmckl_exit_code qmckl_sm_naive_{Dim}</code> is a C function-template that is used to genereate instances of C fucntions based on the range given above. The advantage of this method is that for each of these instances all the dimensions and loop-bounds are known at compile time, allowing the compiler to optimize more aggressively.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="orgfb38e67"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_sm_naive_</span>{Dim}( <pre class="src src-c" id="org48672bf"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_sm_naive_</span>{Dim}(
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">N_updates</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">N_updates</span>,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates,
@ -981,7 +981,7 @@ multiple of <code>SIMD_LENGTH</code>.
This is the kernel generator written in Python. It uses the kernel generator range and templates defined above to generate the C kernel instances. This is the kernel generator written in Python. It uses the kernel generator range and templates defined above to generate the C kernel instances.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-python" id="org618a746"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span> <pre class="src src-python" id="orgece40bd"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span>
<span style="color: #8b2252;">static inline qmckl_exit_code qmckl_sm_naive_{Dim}(</span> <span style="color: #8b2252;">static inline qmckl_exit_code qmckl_sm_naive_{Dim}(</span>
<span style="color: #8b2252;"> const qmckl_context context,</span> <span style="color: #8b2252;"> const qmckl_context context,</span>
<span style="color: #8b2252;"> const uint64_t N_updates,</span> <span style="color: #8b2252;"> const uint64_t N_updates,</span>
@ -1065,7 +1065,7 @@ This is the kernel generator written in Python. It uses the kernel generator ran
Python script that generated C switch cases that call individual kernel instances. Python script that generated C switch cases that call individual kernel instances.
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-python" id="org66e46e2"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span> <pre class="src src-python" id="org1c92a5d"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span>
<span style="color: #8b2252;">case {Dim}: </span> <span style="color: #8b2252;">case {Dim}: </span>
<span style="color: #8b2252;"> return qmckl_sm_naive_{Dim}(context,</span> <span style="color: #8b2252;"> return qmckl_sm_naive_{Dim}(context,</span>
<span style="color: #8b2252;"> N_updates,</span> <span style="color: #8b2252;"> N_updates,</span>
@ -2705,14 +2705,14 @@ Python script that generated C switch cases that call individual kernel instance
</div> </div>
</div> </div>
<div id="outline-container-org8f517d4" class="outline-4"> <div id="outline-container-org008f1e4" class="outline-4">
<h4 id="org8f517d4"><span class="section-number-4">2.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4> <h4 id="org008f1e4"><span class="section-number-4">2.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4>
<div class="outline-text-4" id="text-2-1-7"> <div class="outline-text-4" id="text-2-1-7">
</div> </div>
</div> </div>
<div id="outline-container-org79ce62a" class="outline-4"> <div id="outline-container-org280a353" class="outline-4">
<h4 id="org79ce62a"><span class="section-number-4">2.1.8</span> Performance</h4> <h4 id="org280a353"><span class="section-number-4">2.1.8</span> Performance</h4>
<div class="outline-text-4" id="text-2-1-8"> <div class="outline-text-4" id="text-2-1-8">
<p> <p>
This function performs best when there is only 1 rank-1 update in the update cycle. It is This function performs best when there is only 1 rank-1 update in the update cycle. It is
@ -2721,8 +2721,8 @@ can never resolve a situation where applying the update causes singular behaviou
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org177cf9d" class="outline-4"> <div id="outline-container-org679d7d3" class="outline-4">
<h4 id="org177cf9d"><span class="section-number-4">2.1.9</span> Tests</h4> <h4 id="org679d7d3"><span class="section-number-4">2.1.9</span> Tests</h4>
<div class="outline-text-4" id="text-2-1-9"> <div class="outline-text-4" id="text-2-1-9">
<p> <p>
The tests for the kernels are executed on datasets that are extracted from a run of The tests for the kernels are executed on datasets that are extracted from a run of
@ -2790,17 +2790,17 @@ rc = QMCKL_SUCCESS;
</div> </div>
<div id="outline-container-orgce485ea" class="outline-2"> <div id="outline-container-org66e819b" class="outline-2">
<h2 id="orgce485ea"><span class="section-number-2">3</span> Sherman-Morrison with Slagel Splitting (core)</h2> <h2 id="org66e819b"><span class="section-number-2">3</span> Sherman-Morrison with Slagel Splitting (core)</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
</div> </div>
<div id="outline-container-orgd2c38d2" class="outline-3"> <div id="outline-container-org3145b90" class="outline-3">
<h3 id="orgd2c38d2"><span class="section-number-3">3.1</span> <code>qmckl_sm_splitting_core</code></h3> <h3 id="org3145b90"><span class="section-number-3">3.1</span> <code>qmckl_sm_splitting_core</code></h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
</div> </div>
<div id="outline-container-org27dab55" class="outline-4"> <div id="outline-container-orgaaa37f0" class="outline-4">
<h4 id="org27dab55"><span class="section-number-4">3.1.1</span> Introduction</h4> <h4 id="orgaaa37f0"><span class="section-number-4">3.1.1</span> Introduction</h4>
<div class="outline-text-4" id="text-3-1-1"> <div class="outline-text-4" id="text-3-1-1">
<p> <p>
<code>qmckl_sm_splitting_core</code> is the inner core part of 'Sherman-Morrison with update splitting' in the next section. <code>qmckl_sm_splitting_core</code> is the inner core part of 'Sherman-Morrison with update splitting' in the next section.
@ -2828,10 +2828,10 @@ If the determinant is passed it will only be partially updated if there were any
</div> </div>
</div> </div>
<div id="outline-container-orge5857a4" class="outline-4"> <div id="outline-container-orgac836f2" class="outline-4">
<h4 id="orge5857a4"><span class="section-number-4">3.1.2</span> API</h4> <h4 id="orgac836f2"><span class="section-number-4">3.1.2</span> API</h4>
<div class="outline-text-4" id="text-3-1-2"> <div class="outline-text-4" id="text-3-1-2">
<table id="orgd3b077b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc221050" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -2940,8 +2940,8 @@ If the determinant is passed it will only be partially updated if there were any
</div> </div>
</div> </div>
<div id="outline-container-org5534f32" class="outline-4"> <div id="outline-container-orga630fdc" class="outline-4">
<h4 id="org5534f32"><span class="section-number-4">3.1.3</span> Requirements</h4> <h4 id="orga630fdc"><span class="section-number-4">3.1.3</span> Requirements</h4>
<div class="outline-text-4" id="text-3-1-3"> <div class="outline-text-4" id="text-3-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li><code>LDS &gt;= 2</code></li> <li><code>LDS &gt;= 2</code></li>
@ -2958,8 +2958,8 @@ If the determinant is passed it will only be partially updated if there were any
</div> </div>
</div> </div>
<div id="outline-container-org4896c83" class="outline-4"> <div id="outline-container-orge5b131b" class="outline-4">
<h4 id="org4896c83"><span class="section-number-4">3.1.4</span> Pedagogical kernel source (in Fortran)</h4> <h4 id="orge5b131b"><span class="section-number-4">3.1.4</span> Pedagogical kernel source (in Fortran)</h4>
<div class="outline-text-4" id="text-3-1-4"> <div class="outline-text-4" id="text-3-1-4">
<p> <p>
The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is
@ -3075,8 +3075,8 @@ not be used in real workloads.
</div> </div>
</div> </div>
<div id="outline-container-org4462144" class="outline-5"> <div id="outline-container-org42dbe50" class="outline-5">
<h5 id="org4462144"><span class="section-number-5">3.1.4.1</span> C interface to the pedagogical kernel (not directly exposed)</h5> <h5 id="org42dbe50"><span class="section-number-5">3.1.4.1</span> C interface to the pedagogical kernel (not directly exposed)</h5>
<div class="outline-text-5" id="text-3-1-4-1"> <div class="outline-text-5" id="text-3-1-4-1">
<p> <p>
The function <code>qmckl_sm_splitting_core_doc</code> makes sure that The function <code>qmckl_sm_splitting_core_doc</code> makes sure that
@ -3089,8 +3089,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgb855439" class="outline-4"> <div id="outline-container-org245cce6" class="outline-4">
<h4 id="orgb855439"><span class="section-number-4">3.1.5</span> C headers (exposed in qmckl.h)</h4> <h4 id="org245cce6"><span class="section-number-4">3.1.5</span> C headers (exposed in qmckl.h)</h4>
<div class="outline-text-4" id="text-3-1-5"> <div class="outline-text-4" id="text-3-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting_core</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting_core</span> (
@ -3145,8 +3145,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-org5d8cb2c" class="outline-4"> <div id="outline-container-org68c207d" class="outline-4">
<h4 id="org5d8cb2c"><span class="section-number-4">3.1.6</span> C sources</h4> <h4 id="org68c207d"><span class="section-number-4">3.1.6</span> C sources</h4>
<div class="outline-text-4" id="text-3-1-6"> <div class="outline-text-4" id="text-3-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting_core_hpc</span>( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting_core_hpc</span>(
@ -3235,7 +3235,7 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="org1f757b6"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_sm_splitting_core_</span>{Dim}( <pre class="src src-c" id="orgbda1313"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_sm_splitting_core_</span>{Dim}(
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">N_updates</span>, <span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">N_updates</span>,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates,
@ -3319,7 +3319,7 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-python" id="orgf0cfdfd"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span> <pre class="src src-python" id="org7a902fe"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span>
<span style="color: #8b2252;">static inline qmckl_exit_code qmckl_sm_splitting_core_{Dim}(</span> <span style="color: #8b2252;">static inline qmckl_exit_code qmckl_sm_splitting_core_{Dim}(</span>
<span style="color: #8b2252;"> const qmckl_context context,</span> <span style="color: #8b2252;"> const qmckl_context context,</span>
<span style="color: #8b2252;"> uint64_t N_updates,</span> <span style="color: #8b2252;"> uint64_t N_updates,</span>
@ -3411,7 +3411,7 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-python" id="org9a71d96"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span> <pre class="src src-python" id="org927bcdc"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span>
<span style="color: #8b2252;">case {Dim}: {</span> <span style="color: #8b2252;">case {Dim}: {</span>
<span style="color: #8b2252;"> return qmckl_sm_splitting_core_{Dim}(</span> <span style="color: #8b2252;"> return qmckl_sm_splitting_core_{Dim}(</span>
<span style="color: #8b2252;"> context,</span> <span style="color: #8b2252;"> context,</span>
@ -5379,14 +5379,14 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgea8db29" class="outline-4"> <div id="outline-container-orgdcab0cf" class="outline-4">
<h4 id="orgea8db29"><span class="section-number-4">3.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4> <h4 id="orgdcab0cf"><span class="section-number-4">3.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4>
<div class="outline-text-4" id="text-3-1-7"> <div class="outline-text-4" id="text-3-1-7">
</div> </div>
</div> </div>
<div id="outline-container-org93d4b1c" class="outline-4"> <div id="outline-container-org2901a0a" class="outline-4">
<h4 id="org93d4b1c"><span class="section-number-4">3.1.8</span> Performance</h4> <h4 id="org2901a0a"><span class="section-number-4">3.1.8</span> Performance</h4>
<div class="outline-text-4" id="text-3-1-8"> <div class="outline-text-4" id="text-3-1-8">
<p> <p>
This function cannot be used by itself and is used in Sherman-Morrison with update splitting and Woodbury 3x3 and 2x2 This function cannot be used by itself and is used in Sherman-Morrison with update splitting and Woodbury 3x3 and 2x2
@ -5398,17 +5398,17 @@ with Sherman-Morrison and update splitting. Please look at the performance recco
</div> </div>
<div id="outline-container-org2dbbaa6" class="outline-2"> <div id="outline-container-orgce22a6a" class="outline-2">
<h2 id="org2dbbaa6"><span class="section-number-2">4</span> Woodbury 2x2</h2> <h2 id="orgce22a6a"><span class="section-number-2">4</span> Woodbury 2x2</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
</div> </div>
<div id="outline-container-orgf7e65ca" class="outline-3"> <div id="outline-container-org030a1b3" class="outline-3">
<h3 id="orgf7e65ca"><span class="section-number-3">4.1</span> <code>qmckl_woodbury_2x2</code></h3> <h3 id="org030a1b3"><span class="section-number-3">4.1</span> <code>qmckl_woodbury_2x2</code></h3>
<div class="outline-text-3" id="text-4-1"> <div class="outline-text-3" id="text-4-1">
</div> </div>
<div id="outline-container-org50a6ece" class="outline-4"> <div id="outline-container-orgd58cc16" class="outline-4">
<h4 id="org50a6ece"><span class="section-number-4">4.1.1</span> Introduction</h4> <h4 id="orgd58cc16"><span class="section-number-4">4.1.1</span> Introduction</h4>
<div class="outline-text-4" id="text-4-1-1"> <div class="outline-text-4" id="text-4-1-1">
<p> <p>
The Woodbury 2x2 kernel. It is used to apply two rank-1 updates at once. The formula used in The Woodbury 2x2 kernel. It is used to apply two rank-1 updates at once. The formula used in
@ -5432,10 +5432,10 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-orge299f5b" class="outline-4"> <div id="outline-container-orge8d9fb1" class="outline-4">
<h4 id="orge299f5b"><span class="section-number-4">4.1.2</span> API</h4> <h4 id="orge8d9fb1"><span class="section-number-4">4.1.2</span> API</h4>
<div class="outline-text-4" id="text-4-1-2"> <div class="outline-text-4" id="text-4-1-2">
<table id="org9f57c2b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc079004" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -5516,8 +5516,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org67d8828" class="outline-4"> <div id="outline-container-orgade39bd" class="outline-4">
<h4 id="org67d8828"><span class="section-number-4">4.1.3</span> Requirements</h4> <h4 id="orgade39bd"><span class="section-number-4">4.1.3</span> Requirements</h4>
<div class="outline-text-4" id="text-4-1-3"> <div class="outline-text-4" id="text-4-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>qmckl_null_context</code></li> <li><code>context</code> is not <code>qmckl_null_context</code></li>
@ -5531,8 +5531,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-orgf512ccf" class="outline-4"> <div id="outline-container-orgfe6bf97" class="outline-4">
<h4 id="orgf512ccf"><span class="section-number-4">4.1.4</span> Pedagogical kernel source (in Fortran)</h4> <h4 id="orgfe6bf97"><span class="section-number-4">4.1.4</span> Pedagogical kernel source (in Fortran)</h4>
<div class="outline-text-4" id="text-4-1-4"> <div class="outline-text-4" id="text-4-1-4">
<p> <p>
The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is
@ -5668,8 +5668,8 @@ not be used in real workloads.
</div> </div>
</div> </div>
<div id="outline-container-orge15f565" class="outline-5"> <div id="outline-container-orgcf03f2f" class="outline-5">
<h5 id="orge15f565"><span class="section-number-5">4.1.4.1</span> C interface (not directly exposed)</h5> <h5 id="orgcf03f2f"><span class="section-number-5">4.1.4.1</span> C interface (not directly exposed)</h5>
<div class="outline-text-5" id="text-4-1-4-1"> <div class="outline-text-5" id="text-4-1-4-1">
<p> <p>
The function <code>qmckl_sm_splitting_core_doc</code> makes sure that The function <code>qmckl_sm_splitting_core_doc</code> makes sure that
@ -5682,8 +5682,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgf66b3fe" class="outline-4"> <div id="outline-container-orga05866f" class="outline-4">
<h4 id="orgf66b3fe"><span class="section-number-4">4.1.5</span> C headers (exposed in qmckl.h)</h4> <h4 id="orga05866f"><span class="section-number-4">4.1.5</span> C headers (exposed in qmckl.h)</h4>
<div class="outline-text-4" id="text-4-1-5"> <div class="outline-text-4" id="text-4-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_2x2</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_2x2</span> (
@ -5726,8 +5726,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgeff6b95" class="outline-4"> <div id="outline-container-orgba336fe" class="outline-4">
<h4 id="orgeff6b95"><span class="section-number-4">4.1.6</span> C sources</h4> <h4 id="orgba336fe"><span class="section-number-4">4.1.6</span> C sources</h4>
<div class="outline-text-4" id="text-4-1-6"> <div class="outline-text-4" id="text-4-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_2x2_hpc</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_2x2_hpc</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
@ -5817,7 +5817,7 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="orgefc02bb"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_woodbury_2x2_</span>{Dim}( <pre class="src src-c" id="orgf606718"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_woodbury_2x2_</span>{Dim}(
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">__restrict</span> Updates_index, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">__restrict</span> Updates_index,
@ -7767,14 +7767,14 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgae64b69" class="outline-4"> <div id="outline-container-org4e8479b" class="outline-4">
<h4 id="orgae64b69"><span class="section-number-4">4.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4> <h4 id="org4e8479b"><span class="section-number-4">4.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4>
<div class="outline-text-4" id="text-4-1-7"> <div class="outline-text-4" id="text-4-1-7">
</div> </div>
</div> </div>
<div id="outline-container-org5fdd27d" class="outline-4"> <div id="outline-container-org162f059" class="outline-4">
<h4 id="org5fdd27d"><span class="section-number-4">4.1.8</span> Performance</h4> <h4 id="org162f059"><span class="section-number-4">4.1.8</span> Performance</h4>
<div class="outline-text-4" id="text-4-1-8"> <div class="outline-text-4" id="text-4-1-8">
<p> <p>
This function is most efficient when used in cases where there are only 2 rank-1 updates and This function is most efficient when used in cases where there are only 2 rank-1 updates and
@ -7783,8 +7783,8 @@ it is sure they will not result in a singular matrix.
</div> </div>
</div> </div>
<div id="outline-container-org3661773" class="outline-4"> <div id="outline-container-orgb52be07" class="outline-4">
<h4 id="org3661773"><span class="section-number-4">4.1.9</span> Tests</h4> <h4 id="orgb52be07"><span class="section-number-4">4.1.9</span> Tests</h4>
<div class="outline-text-4" id="text-4-1-9"> <div class="outline-text-4" id="text-4-1-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates2 != <span style="color: #008b8b;">NULL</span>); <pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates2 != <span style="color: #008b8b;">NULL</span>);
@ -7821,17 +7821,17 @@ rc = QMCKL_SUCCESS;
</div> </div>
<div id="outline-container-org1b902a2" class="outline-2"> <div id="outline-container-org03b3087" class="outline-2">
<h2 id="org1b902a2"><span class="section-number-2">5</span> Woodbury 3x3</h2> <h2 id="org03b3087"><span class="section-number-2">5</span> Woodbury 3x3</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
</div> </div>
<div id="outline-container-orgc6b4e40" class="outline-3"> <div id="outline-container-org19d5f1f" class="outline-3">
<h3 id="orgc6b4e40"><span class="section-number-3">5.1</span> <code>qmckl_woodbury_3x3</code></h3> <h3 id="org19d5f1f"><span class="section-number-3">5.1</span> <code>qmckl_woodbury_3x3</code></h3>
<div class="outline-text-3" id="text-5-1"> <div class="outline-text-3" id="text-5-1">
</div> </div>
<div id="outline-container-orgc94efb8" class="outline-4"> <div id="outline-container-orgb928790" class="outline-4">
<h4 id="orgc94efb8"><span class="section-number-4">5.1.1</span> Introduction</h4> <h4 id="orgb928790"><span class="section-number-4">5.1.1</span> Introduction</h4>
<div class="outline-text-4" id="text-5-1-1"> <div class="outline-text-4" id="text-5-1-1">
<p> <p>
The Woodbury 3x3 kernel. It is used to apply two rank-1 updates at once. The formula used in The Woodbury 3x3 kernel. It is used to apply two rank-1 updates at once. The formula used in
@ -7855,10 +7855,10 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org44f2dc5" class="outline-4"> <div id="outline-container-orgac5390d" class="outline-4">
<h4 id="org44f2dc5"><span class="section-number-4">5.1.2</span> API</h4> <h4 id="orgac5390d"><span class="section-number-4">5.1.2</span> API</h4>
<div class="outline-text-4" id="text-5-1-2"> <div class="outline-text-4" id="text-5-1-2">
<table id="orga5e3d17" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgdc6bdbc" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -7939,8 +7939,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org3bb26d9" class="outline-4"> <div id="outline-container-orgd670c86" class="outline-4">
<h4 id="org3bb26d9"><span class="section-number-4">5.1.3</span> Requirements</h4> <h4 id="orgd670c86"><span class="section-number-4">5.1.3</span> Requirements</h4>
<div class="outline-text-4" id="text-5-1-3"> <div class="outline-text-4" id="text-5-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>qmckl_null_context</code></li> <li><code>context</code> is not <code>qmckl_null_context</code></li>
@ -7954,8 +7954,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-orgd677b43" class="outline-4"> <div id="outline-container-orgdbd0139" class="outline-4">
<h4 id="orgd677b43"><span class="section-number-4">5.1.4</span> Pedagogical kernel source (in Fortran)</h4> <h4 id="orgdbd0139"><span class="section-number-4">5.1.4</span> Pedagogical kernel source (in Fortran)</h4>
<div class="outline-text-4" id="text-5-1-4"> <div class="outline-text-4" id="text-5-1-4">
<p> <p>
The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is
@ -8100,8 +8100,8 @@ not be used in real workloads.
</div> </div>
</div> </div>
<div id="outline-container-org9511294" class="outline-5"> <div id="outline-container-org91fb00c" class="outline-5">
<h5 id="org9511294"><span class="section-number-5">5.1.4.1</span> C interface (not directly exposed)</h5> <h5 id="org91fb00c"><span class="section-number-5">5.1.4.1</span> C interface (not directly exposed)</h5>
<div class="outline-text-5" id="text-5-1-4-1"> <div class="outline-text-5" id="text-5-1-4-1">
<p> <p>
The function <code>qmckl_sm_splitting_core_doc</code> makes sure that The function <code>qmckl_sm_splitting_core_doc</code> makes sure that
@ -8114,8 +8114,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgf067d44" class="outline-4"> <div id="outline-container-orge7a0ba3" class="outline-4">
<h4 id="orgf067d44"><span class="section-number-4">5.1.5</span> C headers (exposed in qmckl.h)</h4> <h4 id="orge7a0ba3"><span class="section-number-4">5.1.5</span> C headers (exposed in qmckl.h)</h4>
<div class="outline-text-4" id="text-5-1-5"> <div class="outline-text-4" id="text-5-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_3x3</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_3x3</span> (
@ -8158,8 +8158,8 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgf0ec943" class="outline-4"> <div id="outline-container-org0651076" class="outline-4">
<h4 id="orgf0ec943"><span class="section-number-4">5.1.6</span> C sources</h4> <h4 id="org0651076"><span class="section-number-4">5.1.6</span> C sources</h4>
<div class="outline-text-4" id="text-5-1-6"> <div class="outline-text-4" id="text-5-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_3x3_hpc</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_woodbury_3x3_hpc</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
@ -8269,7 +8269,7 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="orgb5c3cf4"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_woodbury_3x3_</span>{Dim}( <pre class="src src-c" id="org48cc4d7"><span style="color: #a020f0;">static</span> <span style="color: #a020f0;">inline</span> <span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #a0522d;">qmckl_woodbury_3x3_</span>{Dim}(
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">__restrict</span> Updates,
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">__restrict</span> Updates_index, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">__restrict</span> Updates_index,
@ -10639,14 +10639,14 @@ exposed in <code>qmckl.h</code> and <code>qmckl_f.F90</code>, but
</div> </div>
</div> </div>
<div id="outline-container-orgde2185f" class="outline-4"> <div id="outline-container-org5f72441" class="outline-4">
<h4 id="orgde2185f"><span class="section-number-4">5.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4> <h4 id="org5f72441"><span class="section-number-4">5.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4>
<div class="outline-text-4" id="text-5-1-7"> <div class="outline-text-4" id="text-5-1-7">
</div> </div>
</div> </div>
<div id="outline-container-org7896467" class="outline-4"> <div id="outline-container-org4668176" class="outline-4">
<h4 id="org7896467"><span class="section-number-4">5.1.8</span> Performance</h4> <h4 id="org4668176"><span class="section-number-4">5.1.8</span> Performance</h4>
<div class="outline-text-4" id="text-5-1-8"> <div class="outline-text-4" id="text-5-1-8">
<p> <p>
This function is most efficient when used in cases where there are only 3 rank-1 updates and This function is most efficient when used in cases where there are only 3 rank-1 updates and
@ -10655,8 +10655,8 @@ it is sure they will not result in a singular matrix.
</div> </div>
</div> </div>
<div id="outline-container-org8043627" class="outline-4"> <div id="outline-container-orgddab051" class="outline-4">
<h4 id="org8043627"><span class="section-number-4">5.1.9</span> Tests</h4> <h4 id="orgddab051"><span class="section-number-4">5.1.9</span> Tests</h4>
<div class="outline-text-4" id="text-5-1-9"> <div class="outline-text-4" id="text-5-1-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates3 != <span style="color: #008b8b;">NULL</span>); <pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates3 != <span style="color: #008b8b;">NULL</span>);
@ -10693,17 +10693,17 @@ rc = QMCKL_SUCCESS;
</div> </div>
<div id="outline-container-org5a840a3" class="outline-2"> <div id="outline-container-orgd42e663" class="outline-2">
<h2 id="org5a840a3"><span class="section-number-2">6</span> Sherman-Morrison with Slagel Splitting</h2> <h2 id="orgd42e663"><span class="section-number-2">6</span> Sherman-Morrison with Slagel Splitting</h2>
<div class="outline-text-2" id="text-6"> <div class="outline-text-2" id="text-6">
</div> </div>
<div id="outline-container-orga050147" class="outline-3"> <div id="outline-container-orgfff2266" class="outline-3">
<h3 id="orga050147"><span class="section-number-3">6.1</span> <code>qmckl_sm_splitting</code></h3> <h3 id="orgfff2266"><span class="section-number-3">6.1</span> <code>qmckl_sm_splitting</code></h3>
<div class="outline-text-3" id="text-6-1"> <div class="outline-text-3" id="text-6-1">
</div> </div>
<div id="outline-container-org1a54ddd" class="outline-4"> <div id="outline-container-org12516ca" class="outline-4">
<h4 id="org1a54ddd"><span class="section-number-4">6.1.1</span> Introduction</h4> <h4 id="org12516ca"><span class="section-number-4">6.1.1</span> Introduction</h4>
<div class="outline-text-4" id="text-6-1-1"> <div class="outline-text-4" id="text-6-1-1">
<p> <p>
This is a variation on the 'Naive' Sherman-Morrison kernel. Whenever the denominator \(1+v_j^T S^{-1} u_j\) in This is a variation on the 'Naive' Sherman-Morrison kernel. Whenever the denominator \(1+v_j^T S^{-1} u_j\) in
@ -10727,10 +10727,10 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org8e09e0e" class="outline-4"> <div id="outline-container-org67a4578" class="outline-4">
<h4 id="org8e09e0e"><span class="section-number-4">6.1.2</span> API</h4> <h4 id="org67a4578"><span class="section-number-4">6.1.2</span> API</h4>
<div class="outline-text-4" id="text-6-1-2"> <div class="outline-text-4" id="text-6-1-2">
<table id="orgf9f507e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org0405687" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -10818,8 +10818,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-orgdd71d3d" class="outline-4"> <div id="outline-container-org358d3a9" class="outline-4">
<h4 id="orgdd71d3d"><span class="section-number-4">6.1.3</span> Requirements</h4> <h4 id="org358d3a9"><span class="section-number-4">6.1.3</span> Requirements</h4>
<div class="outline-text-4" id="text-6-1-3"> <div class="outline-text-4" id="text-6-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
@ -10834,8 +10834,8 @@ from applying the updates to the original matrix.
</div> </div>
</div> </div>
<div id="outline-container-org911127e" class="outline-4"> <div id="outline-container-orgf7dd741" class="outline-4">
<h4 id="org911127e"><span class="section-number-4">6.1.4</span> Pedagogical kernel source (in Fortran)</h4> <h4 id="orgf7dd741"><span class="section-number-4">6.1.4</span> Pedagogical kernel source (in Fortran)</h4>
<div class="outline-text-4" id="text-6-1-4"> <div class="outline-text-4" id="text-6-1-4">
<p> <p>
The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is The following source code written in Fortran is inteded to illustrate how the kernel works. Even though the kernel is
@ -10914,8 +10914,8 @@ not be used in real workloads.
</div> </div>
</div> </div>
<div id="outline-container-org04eaa7b" class="outline-5"> <div id="outline-container-org75b7357" class="outline-5">
<h5 id="org04eaa7b"><span class="section-number-5">6.1.4.1</span> C interface to the pedagogical kernel (not directly exposed)</h5> <h5 id="org75b7357"><span class="section-number-5">6.1.4.1</span> C interface to the pedagogical kernel (not directly exposed)</h5>
<div class="outline-text-5" id="text-6-1-4-1"> <div class="outline-text-5" id="text-6-1-4-1">
<p> <p>
The following Fortran function <code>qmckl_sm_splitting_core_doc</code> makes sure The following Fortran function <code>qmckl_sm_splitting_core_doc</code> makes sure
@ -10928,8 +10928,8 @@ for C users and in the module file 'qmckl<sub>f.F90</sub>' for Fortran users.
</div> </div>
</div> </div>
<div id="outline-container-org32843ca" class="outline-4"> <div id="outline-container-org363817e" class="outline-4">
<h4 id="org32843ca"><span class="section-number-4">6.1.5</span> C headers (exposed in qmckl.h)</h4> <h4 id="org363817e"><span class="section-number-4">6.1.5</span> C headers (exposed in qmckl.h)</h4>
<div class="outline-text-4" id="text-6-1-5"> <div class="outline-text-4" id="text-6-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting</span> ( <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_sm_splitting</span> (
@ -10975,11 +10975,11 @@ for C users and in the module file 'qmckl<sub>f.F90</sub>' for Fortran users.
</div> </div>
</div> </div>
<div id="outline-container-org46145b4" class="outline-4"> <div id="outline-container-orgbfc148f" class="outline-4">
<h4 id="org46145b4"><span class="section-number-4">6.1.6</span> C source</h4> <h4 id="orgbfc148f"><span class="section-number-4">6.1.6</span> C source</h4>
<div class="outline-text-4" id="text-6-1-6"> <div class="outline-text-4" id="text-6-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-python" id="org04af02c"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span> <pre class="src src-python" id="org3c1ea1f"><span style="color: #a0522d;">text</span>=<span style="color: #8b2252;">"""</span>
<span style="color: #8b2252;">case {Dim}: {</span> <span style="color: #8b2252;">case {Dim}: {</span>
<span style="color: #8b2252;"> rc = qmckl_sm_splitting_core_{Dim}(</span> <span style="color: #8b2252;"> rc = qmckl_sm_splitting_core_{Dim}(</span>
<span style="color: #8b2252;"> context,</span> <span style="color: #8b2252;"> context,</span>
@ -11382,14 +11382,14 @@ for C users and in the module file 'qmckl<sub>f.F90</sub>' for Fortran users.
</div> </div>
</div> </div>
<div id="outline-container-orgaa9fa94" class="outline-4"> <div id="outline-container-org8d11b71" class="outline-4">
<h4 id="orgaa9fa94"><span class="section-number-4">6.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4> <h4 id="org8d11b71"><span class="section-number-4">6.1.7</span> Fortran interfaces (exposed in qmckl<sub>f.F90</sub>)</h4>
<div class="outline-text-4" id="text-6-1-7"> <div class="outline-text-4" id="text-6-1-7">
</div> </div>
</div> </div>
<div id="outline-container-org475bf1a" class="outline-4"> <div id="outline-container-org4f9cc81" class="outline-4">
<h4 id="org475bf1a"><span class="section-number-4">6.1.8</span> Performance&#x2026;</h4> <h4 id="org4f9cc81"><span class="section-number-4">6.1.8</span> Performance&#x2026;</h4>
<div class="outline-text-4" id="text-6-1-8"> <div class="outline-text-4" id="text-6-1-8">
<p> <p>
This kernel performs best when there are 2 or more rank-1 update cycles and fail-rate is high. This kernel performs best when there are 2 or more rank-1 update cycles and fail-rate is high.
@ -11397,8 +11397,8 @@ This kernel performs best when there are 2 or more rank-1 update cycles and fail
</div> </div>
</div> </div>
<div id="outline-container-org1bfbb86" class="outline-4"> <div id="outline-container-orgcc5073c" class="outline-4">
<h4 id="org1bfbb86"><span class="section-number-4">6.1.9</span> Test</h4> <h4 id="orgcc5073c"><span class="section-number-4">6.1.9</span> Test</h4>
<div class="outline-text-4" id="text-6-1-9"> <div class="outline-text-4" id="text-6-1-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates3 != <span style="color: #008b8b;">NULL</span>); <pre class="src src-c"><span style="color: #0000ff;">assert</span>(Updates3 != <span style="color: #008b8b;">NULL</span>);
@ -11436,8 +11436,8 @@ rc = QMCKL_SUCCESS;
<div id="outline-container-org1b9c251" class="outline-2"> <div id="outline-container-orgc08599f" class="outline-2">
<h2 id="org1b9c251"><span class="section-number-2">7</span> End of files</h2> <h2 id="orgc08599f"><span class="section-number-2">7</span> End of files</h2>
<div class="outline-text-2" id="text-7"> <div class="outline-text-2" id="text-7">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #0000ff;">assert</span> (<span style="color: #228b22;">qmckl_context_destroy</span>(<span style="color: #a0522d;">context</span>) == QMCKL_SUCCESS); <pre class="src src-c"><span style="color: #0000ff;">assert</span> (<span style="color: #228b22;">qmckl_context_destroy</span>(<span style="color: #a0522d;">context</span>) == QMCKL_SUCCESS);
@ -11451,7 +11451,7 @@ rc = QMCKL_SUCCESS;
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

58
qmckl_tests.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Data for Tests</title> <title>Data for Tests</title>
@ -246,27 +246,27 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgb3eab25">1. CHBrClF</a> <li><a href="#orge157b48">1. CHBrClF</a>
<ul> <ul>
<li><a href="#orgc939a40">1.1. XYZ coordinates</a></li> <li><a href="#org4f2e9d5">1.1. XYZ coordinates</a></li>
<li><a href="#org6c54df5">1.2. Atomic basis set</a></li> <li><a href="#org1123fb6">1.2. Atomic basis set</a></li>
<li><a href="#org38c9fe3">1.3. Molecular orbitals</a></li> <li><a href="#orge9bc628">1.3. Molecular orbitals</a></li>
<li><a href="#orgf4ec9b3">1.4. Electron coordinates</a></li> <li><a href="#orga5f2ae2">1.4. Electron coordinates</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgc9e520d">2. N2</a> <li><a href="#org7fcd6bc">2. N2</a>
<ul> <ul>
<li><a href="#orgcddb5c3">2.1. XYZ coordinates</a></li> <li><a href="#orgc11d1a0">2.1. XYZ coordinates</a></li>
<li><a href="#orgba3be67">2.2. Electron coordinates</a></li> <li><a href="#orgbf6664f">2.2. Electron coordinates</a></li>
<li><a href="#org377c6a5">2.3. Jastrow related data</a></li> <li><a href="#org56b1eb6">2.3. Jastrow related data</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgb3eab25" class="outline-2"> <div id="outline-container-orge157b48" class="outline-2">
<h2 id="orgb3eab25"><span class="section-number-2">1</span> CHBrClF</h2> <h2 id="orge157b48"><span class="section-number-2">1</span> CHBrClF</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
This test is the all-electron Hartree-Fock wave function of CHClBr, This test is the all-electron Hartree-Fock wave function of CHClBr,
@ -350,8 +350,8 @@ and with a high maximum angular momentum.
</div> </div>
<div id="outline-container-orgc939a40" class="outline-3"> <div id="outline-container-org4f2e9d5" class="outline-3">
<h3 id="orgc939a40"><span class="section-number-3">1.1</span> XYZ coordinates</h3> <h3 id="org4f2e9d5"><span class="section-number-3">1.1</span> XYZ coordinates</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<pre class="example"> <pre class="example">
5 5
@ -381,8 +381,8 @@ Nuclear coordinates are stored in atomic units in transposed format.
</div> </div>
</div> </div>
<div id="outline-container-org6c54df5" class="outline-3"> <div id="outline-container-org1123fb6" class="outline-3">
<h3 id="org6c54df5"><span class="section-number-3">1.2</span> Atomic basis set</h3> <h3 id="org1123fb6"><span class="section-number-3">1.2</span> Atomic basis set</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<pre class="example"> <pre class="example">
HYDROGEN HYDROGEN
@ -1301,8 +1301,8 @@ F 1
</div> </div>
</div> </div>
<div id="outline-container-org38c9fe3" class="outline-3"> <div id="outline-container-orge9bc628" class="outline-3">
<h3 id="org38c9fe3"><span class="section-number-3">1.3</span> Molecular orbitals</h3> <h3 id="orge9bc628"><span class="section-number-3">1.3</span> Molecular orbitals</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">chbrclf_mo_num</span> ((<span style="color: #228b22;">int64_t</span>) 224) <pre class="src src-c"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">chbrclf_mo_num</span> ((<span style="color: #228b22;">int64_t</span>) 224)
@ -60226,8 +60226,8 @@ F 1
</div> </div>
</div> </div>
<div id="outline-container-orgf4ec9b3" class="outline-3"> <div id="outline-container-orga5f2ae2" class="outline-3">
<h3 id="orgf4ec9b3"><span class="section-number-3">1.4</span> Electron coordinates</h3> <h3 id="orga5f2ae2"><span class="section-number-3">1.4</span> Electron coordinates</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<p> <p>
Electron coordinates are stored in atomic units in normal format. Electron coordinates are stored in atomic units in normal format.
@ -60386,8 +60386,8 @@ Electron coordinates are stored in atomic units in normal format.
</div> </div>
</div> </div>
<div id="outline-container-orgc9e520d" class="outline-2"> <div id="outline-container-org7fcd6bc" class="outline-2">
<h2 id="orgc9e520d"><span class="section-number-2">2</span> N2</h2> <h2 id="org7fcd6bc"><span class="section-number-2">2</span> N2</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
This test is mainly for the Jastrow factor and was supplied by This test is mainly for the Jastrow factor and was supplied by
@ -60428,8 +60428,8 @@ treated by pseudopotentials thus excluded from the actual calculation.
</table> </table>
</div> </div>
<div id="outline-container-orgcddb5c3" class="outline-3"> <div id="outline-container-orgc11d1a0" class="outline-3">
<h3 id="orgcddb5c3"><span class="section-number-3">2.1</span> XYZ coordinates</h3> <h3 id="orgc11d1a0"><span class="section-number-3">2.1</span> XYZ coordinates</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<pre class="example"> <pre class="example">
2 2
@ -60456,8 +60456,8 @@ Nuclear coordinates are stored in atomic units in transposed format.
</div> </div>
</div> </div>
<div id="outline-container-orgba3be67" class="outline-3"> <div id="outline-container-orgbf6664f" class="outline-3">
<h3 id="orgba3be67"><span class="section-number-3">2.2</span> Electron coordinates</h3> <h3 id="orgbf6664f"><span class="section-number-3">2.2</span> Electron coordinates</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
Electron coordinates are stored in atomic units in normal format. Electron coordinates are stored in atomic units in normal format.
@ -60486,8 +60486,8 @@ Electron coordinates are stored in atomic units in normal format.
</div> </div>
</div> </div>
<div id="outline-container-org377c6a5" class="outline-3"> <div id="outline-container-org56b1eb6" class="outline-3">
<h3 id="org377c6a5"><span class="section-number-3">2.3</span> Jastrow related data</h3> <h3 id="org56b1eb6"><span class="section-number-3">2.3</span> Jastrow related data</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
This test is mainly for the Jastrow factor and was supplied by This test is mainly for the Jastrow factor and was supplied by
@ -60586,7 +60586,7 @@ Ramon Panades Baruetta.
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

196
qmckl_trexio.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO I/O library</title> <title>TREXIO I/O library</title>
@ -324,53 +324,53 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgf814289">1. Local functions</a> <li><a href="#orgbe9d71b">1. Local functions</a>
<ul> <ul>
<li><a href="#orgede1612">1.1. Open file</a></li> <li><a href="#orga458563">1.1. Open file</a></li>
<li><a href="#org60bdcd5">1.2. Electron</a></li> <li><a href="#org46abe95">1.2. Electron</a></li>
<li><a href="#org9d5b31c">1.3. Nucleus</a> <li><a href="#org61dc4f1">1.3. Nucleus</a>
<ul> <ul>
<li><a href="#org1d3edc5">1.3.1. Number of nuclei</a></li> <li><a href="#org38f784c">1.3.1. Number of nuclei</a></li>
<li><a href="#org7cc4b7b">1.3.2. Nuclear charges</a></li> <li><a href="#org7fa2fd8">1.3.2. Nuclear charges</a></li>
<li><a href="#org138fd49">1.3.3. Nuclear coordinates</a></li> <li><a href="#orgab09171">1.3.3. Nuclear coordinates</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org385ef18">1.4. Basis set and AOs</a> <li><a href="#org2af3d98">1.4. Basis set and AOs</a>
<ul> <ul>
<li><a href="#org923cfc4">1.4.1. Basis set type</a></li> <li><a href="#org5183ae6">1.4.1. Basis set type</a></li>
<li><a href="#org0f1f41e">1.4.2. Number of shells</a></li> <li><a href="#org64c08ff">1.4.2. Number of shells</a></li>
<li><a href="#orgeca2636">1.4.3. Number of primitives</a></li> <li><a href="#org0b94fd7">1.4.3. Number of primitives</a></li>
<li><a href="#orgfcda10f">1.4.4. Number of atomic orbitals</a></li> <li><a href="#org00de29e">1.4.4. Number of atomic orbitals</a></li>
<li><a href="#org5846c42">1.4.5. Nucleus<sub>index</sub> array</a></li> <li><a href="#org2647dfa">1.4.5. Nucleus<sub>index</sub> array</a></li>
<li><a href="#org9f3c0bc">1.4.6. Number of shells per nucleus</a></li> <li><a href="#orgfeaeed3">1.4.6. Number of shells per nucleus</a></li>
<li><a href="#orgfb303b3">1.4.7. Angular momentum</a></li> <li><a href="#org362de35">1.4.7. Angular momentum</a></li>
<li><a href="#orga6a3b8b">1.4.8. Number of primitives per shell</a></li> <li><a href="#org45c3a1a">1.4.8. Number of primitives per shell</a></li>
<li><a href="#org6c19df3">1.4.9. Indices of the primitives</a></li> <li><a href="#orgadcce53">1.4.9. Indices of the primitives</a></li>
<li><a href="#orgc4cb54e">1.4.10. Normalization of the shells</a></li> <li><a href="#org56acbd3">1.4.10. Normalization of the shells</a></li>
<li><a href="#orgab4c7c7">1.4.11. Exponents</a></li> <li><a href="#orgf62c917">1.4.11. Exponents</a></li>
<li><a href="#orga3b1ae8">1.4.12. Coefficients</a></li> <li><a href="#org998ab04">1.4.12. Coefficients</a></li>
<li><a href="#org4dfb6a1">1.4.13. Normalization of the primitivies</a></li> <li><a href="#orgb5609b4">1.4.13. Normalization of the primitivies</a></li>
<li><a href="#orgb22267a">1.4.14. AO Normalization</a></li> <li><a href="#orgd5a219c">1.4.14. AO Normalization</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org43f9385">1.5. Molecular orbitals</a> <li><a href="#org418ee56">1.5. Molecular orbitals</a>
<ul> <ul>
<li><a href="#orgb3d9b34">1.5.1. Number of MOs</a></li> <li><a href="#org32e528f">1.5.1. Number of MOs</a></li>
<li><a href="#org4cb8f9f">1.5.2. MO coefficients</a></li> <li><a href="#org61a456e">1.5.2. MO coefficients</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org1412f06">1.6. <span class="todo TODO">TODO</span> ECP</a></li> <li><a href="#orga32d6bb">1.6. <span class="todo TODO">TODO</span> ECP</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgda39af9">2. Read everything</a></li> <li><a href="#org4ca0cde">2. Read everything</a></li>
<li><a href="#org21e5396">3. Test</a> <li><a href="#orga8eb4cf">3. Test</a>
<ul> <ul>
<li> <li>
<ul> <ul>
<li><a href="#orga1b8cfc">3.0.1. Electrons</a></li> <li><a href="#org7378838">3.0.1. Electrons</a></li>
<li><a href="#orgcc30495">3.0.2. Nuclei</a></li> <li><a href="#org60c6401">3.0.2. Nuclei</a></li>
<li><a href="#orgd9a2f68">3.0.3. Atomic basis</a></li> <li><a href="#org1505c1c">3.0.3. Atomic basis</a></li>
<li><a href="#org3591e08">3.0.4. MO Basis</a></li> <li><a href="#orgdf10677">3.0.4. MO Basis</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -379,8 +379,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgf814289" class="outline-2"> <div id="outline-container-orgbe9d71b" class="outline-2">
<h2 id="orgf814289"><span class="section-number-2">1</span> Local functions</h2> <h2 id="orgbe9d71b"><span class="section-number-2">1</span> Local functions</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
Functions defined in this section are all local: they should not be Functions defined in this section are all local: they should not be
@ -403,8 +403,8 @@ In the functions defined in this section, we use as local variables
</ul> </ul>
</div> </div>
<div id="outline-container-orgede1612" class="outline-3"> <div id="outline-container-orga458563" class="outline-3">
<h3 id="orgede1612"><span class="section-number-3">1.1</span> Open file</h3> <h3 id="orga458563"><span class="section-number-3">1.1</span> Open file</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
We first define a helper function to open a file by first trying to We first define a helper function to open a file by first trying to
@ -442,8 +442,8 @@ groups of data by passing the <code>trexio_t</code> handle.
</div> </div>
</div> </div>
<div id="outline-container-org60bdcd5" class="outline-3"> <div id="outline-container-org46abe95" class="outline-3">
<h3 id="org60bdcd5"><span class="section-number-3">1.2</span> Electron</h3> <h3 id="org46abe95"><span class="section-number-3">1.2</span> Electron</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
In this section we read all the data into the electron data structure. In this section we read all the data into the electron data structure.
@ -494,8 +494,8 @@ We read the number of up-spin and down-spin electrons.
</div> </div>
</div> </div>
<div id="outline-container-org9d5b31c" class="outline-3"> <div id="outline-container-org61dc4f1" class="outline-3">
<h3 id="org9d5b31c"><span class="section-number-3">1.3</span> Nucleus</h3> <h3 id="org61dc4f1"><span class="section-number-3">1.3</span> Nucleus</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
In this section we read the number of nuclei, the molecular geometry and nuclear charges. In this section we read the number of nuclei, the molecular geometry and nuclear charges.
@ -515,8 +515,8 @@ In this section we read the number of nuclei, the molecular geometry and nuclear
</div> </div>
</div> </div>
<div id="outline-container-org1d3edc5" class="outline-4"> <div id="outline-container-org38f784c" class="outline-4">
<h4 id="org1d3edc5"><span class="section-number-4">1.3.1</span> Number of nuclei</h4> <h4 id="org38f784c"><span class="section-number-4">1.3.1</span> Number of nuclei</h4>
<div class="outline-text-4" id="text-1-3-1"> <div class="outline-text-4" id="text-1-3-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">nucleus_num</span> = 0L; <pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">nucleus_num</span> = 0L;
@ -539,8 +539,8 @@ rc = qmckl_set_nucleus_num(context, nucleus_num);
</div> </div>
</div> </div>
<div id="outline-container-org7cc4b7b" class="outline-4"> <div id="outline-container-org7fa2fd8" class="outline-4">
<h4 id="org7cc4b7b"><span class="section-number-4">1.3.2</span> Nuclear charges</h4> <h4 id="org7fa2fd8"><span class="section-number-4">1.3.2</span> Nuclear charges</h4>
<div class="outline-text-4" id="text-1-3-2"> <div class="outline-text-4" id="text-1-3-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -580,8 +580,8 @@ rc = qmckl_set_nucleus_num(context, nucleus_num);
</div> </div>
</div> </div>
<div id="outline-container-org138fd49" class="outline-4"> <div id="outline-container-orgab09171" class="outline-4">
<h4 id="org138fd49"><span class="section-number-4">1.3.3</span> Nuclear coordinates</h4> <h4 id="orgab09171"><span class="section-number-4">1.3.3</span> Nuclear coordinates</h4>
<div class="outline-text-4" id="text-1-3-3"> <div class="outline-text-4" id="text-1-3-3">
<p> <p>
Now, we read the molecular geometry. It is stored in normal format Now, we read the molecular geometry. It is stored in normal format
@ -636,8 +636,8 @@ in the TREXIO file (<code>'N'</code>), so it will be automatically transposed in
</div> </div>
</div> </div>
<div id="outline-container-org385ef18" class="outline-3"> <div id="outline-container-org2af3d98" class="outline-3">
<h3 id="org385ef18"><span class="section-number-3">1.4</span> Basis set and AOs</h3> <h3 id="org2af3d98"><span class="section-number-3">1.4</span> Basis set and AOs</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<p> <p>
In this section we read the atomic basis set and atomic orbitals. In this section we read the atomic basis set and atomic orbitals.
@ -663,8 +663,8 @@ In this section we read the atomic basis set and atomic orbitals.
</div> </div>
</div> </div>
<div id="outline-container-org923cfc4" class="outline-4"> <div id="outline-container-org5183ae6" class="outline-4">
<h4 id="org923cfc4"><span class="section-number-4">1.4.1</span> Basis set type</h4> <h4 id="org5183ae6"><span class="section-number-4">1.4.1</span> Basis set type</h4>
<div class="outline-text-4" id="text-1-4-1"> <div class="outline-text-4" id="text-1-4-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">MAX_STR_LEN</span> 1024 <pre class="src src-c"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">MAX_STR_LEN</span> 1024
@ -695,8 +695,8 @@ In this section we read the atomic basis set and atomic orbitals.
</div> </div>
</div> </div>
<div id="outline-container-org0f1f41e" class="outline-4"> <div id="outline-container-org64c08ff" class="outline-4">
<h4 id="org0f1f41e"><span class="section-number-4">1.4.2</span> Number of shells</h4> <h4 id="org64c08ff"><span class="section-number-4">1.4.2</span> Number of shells</h4>
<div class="outline-text-4" id="text-1-4-2"> <div class="outline-text-4" id="text-1-4-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">shell_num</span> = 0L; <pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">shell_num</span> = 0L;
@ -720,8 +720,8 @@ rc = qmckl_set_ao_basis_shell_num(context, shell_num);
</div> </div>
</div> </div>
<div id="outline-container-orgeca2636" class="outline-4"> <div id="outline-container-org0b94fd7" class="outline-4">
<h4 id="orgeca2636"><span class="section-number-4">1.4.3</span> Number of primitives</h4> <h4 id="org0b94fd7"><span class="section-number-4">1.4.3</span> Number of primitives</h4>
<div class="outline-text-4" id="text-1-4-3"> <div class="outline-text-4" id="text-1-4-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">prim_num</span> = 0L; <pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">prim_num</span> = 0L;
@ -745,8 +745,8 @@ rc = qmckl_set_ao_basis_prim_num(context, prim_num);
</div> </div>
</div> </div>
<div id="outline-container-orgfcda10f" class="outline-4"> <div id="outline-container-org00de29e" class="outline-4">
<h4 id="orgfcda10f"><span class="section-number-4">1.4.4</span> Number of atomic orbitals</h4> <h4 id="org00de29e"><span class="section-number-4">1.4.4</span> Number of atomic orbitals</h4>
<div class="outline-text-4" id="text-1-4-4"> <div class="outline-text-4" id="text-1-4-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">ao_num</span> = 0LL; <pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">ao_num</span> = 0LL;
@ -770,8 +770,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-org5846c42" class="outline-4"> <div id="outline-container-org2647dfa" class="outline-4">
<h4 id="org5846c42"><span class="section-number-4">1.4.5</span> Nucleus<sub>index</sub> array</h4> <h4 id="org2647dfa"><span class="section-number-4">1.4.5</span> Nucleus<sub>index</sub> array</h4>
<div class="outline-text-4" id="text-1-4-5"> <div class="outline-text-4" id="text-1-4-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -851,8 +851,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-org9f3c0bc" class="outline-4"> <div id="outline-container-orgfeaeed3" class="outline-4">
<h4 id="org9f3c0bc"><span class="section-number-4">1.4.6</span> Number of shells per nucleus</h4> <h4 id="orgfeaeed3"><span class="section-number-4">1.4.6</span> Number of shells per nucleus</h4>
<div class="outline-text-4" id="text-1-4-6"> <div class="outline-text-4" id="text-1-4-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -937,8 +937,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orgfb303b3" class="outline-4"> <div id="outline-container-org362de35" class="outline-4">
<h4 id="orgfb303b3"><span class="section-number-4">1.4.7</span> Angular momentum</h4> <h4 id="org362de35"><span class="section-number-4">1.4.7</span> Angular momentum</h4>
<div class="outline-text-4" id="text-1-4-7"> <div class="outline-text-4" id="text-1-4-7">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -983,8 +983,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orga6a3b8b" class="outline-4"> <div id="outline-container-org45c3a1a" class="outline-4">
<h4 id="orga6a3b8b"><span class="section-number-4">1.4.8</span> Number of primitives per shell</h4> <h4 id="org45c3a1a"><span class="section-number-4">1.4.8</span> Number of primitives per shell</h4>
<div class="outline-text-4" id="text-1-4-8"> <div class="outline-text-4" id="text-1-4-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1070,8 +1070,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-org6c19df3" class="outline-4"> <div id="outline-container-orgadcce53" class="outline-4">
<h4 id="org6c19df3"><span class="section-number-4">1.4.9</span> Indices of the primitives</h4> <h4 id="orgadcce53"><span class="section-number-4">1.4.9</span> Indices of the primitives</h4>
<div class="outline-text-4" id="text-1-4-9"> <div class="outline-text-4" id="text-1-4-9">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1151,8 +1151,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orgc4cb54e" class="outline-4"> <div id="outline-container-org56acbd3" class="outline-4">
<h4 id="orgc4cb54e"><span class="section-number-4">1.4.10</span> Normalization of the shells</h4> <h4 id="org56acbd3"><span class="section-number-4">1.4.10</span> Normalization of the shells</h4>
<div class="outline-text-4" id="text-1-4-10"> <div class="outline-text-4" id="text-1-4-10">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1197,8 +1197,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orgab4c7c7" class="outline-4"> <div id="outline-container-orgf62c917" class="outline-4">
<h4 id="orgab4c7c7"><span class="section-number-4">1.4.11</span> Exponents</h4> <h4 id="orgf62c917"><span class="section-number-4">1.4.11</span> Exponents</h4>
<div class="outline-text-4" id="text-1-4-11"> <div class="outline-text-4" id="text-1-4-11">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1243,8 +1243,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orga3b1ae8" class="outline-4"> <div id="outline-container-org998ab04" class="outline-4">
<h4 id="orga3b1ae8"><span class="section-number-4">1.4.12</span> Coefficients</h4> <h4 id="org998ab04"><span class="section-number-4">1.4.12</span> Coefficients</h4>
<div class="outline-text-4" id="text-1-4-12"> <div class="outline-text-4" id="text-1-4-12">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1289,8 +1289,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-org4dfb6a1" class="outline-4"> <div id="outline-container-orgb5609b4" class="outline-4">
<h4 id="org4dfb6a1"><span class="section-number-4">1.4.13</span> Normalization of the primitivies</h4> <h4 id="orgb5609b4"><span class="section-number-4">1.4.13</span> Normalization of the primitivies</h4>
<div class="outline-text-4" id="text-1-4-13"> <div class="outline-text-4" id="text-1-4-13">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1335,8 +1335,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
<div id="outline-container-orgb22267a" class="outline-4"> <div id="outline-container-orgd5a219c" class="outline-4">
<h4 id="orgb22267a"><span class="section-number-4">1.4.14</span> AO Normalization</h4> <h4 id="orgd5a219c"><span class="section-number-4">1.4.14</span> AO Normalization</h4>
<div class="outline-text-4" id="text-1-4-14"> <div class="outline-text-4" id="text-1-4-14">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1391,8 +1391,8 @@ rc = qmckl_set_ao_basis_ao_num(context, ao_num);
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org43f9385" class="outline-3"> <div id="outline-container-org418ee56" class="outline-3">
<h3 id="org43f9385"><span class="section-number-3">1.5</span> Molecular orbitals</h3> <h3 id="org418ee56"><span class="section-number-3">1.5</span> Molecular orbitals</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<p> <p>
In this section we read the MO coefficients. In this section we read the MO coefficients.
@ -1418,8 +1418,8 @@ In this section we read the MO coefficients.
</div> </div>
</div> </div>
<div id="outline-container-orgb3d9b34" class="outline-4"> <div id="outline-container-org32e528f" class="outline-4">
<h4 id="orgb3d9b34"><span class="section-number-4">1.5.1</span> Number of MOs</h4> <h4 id="org32e528f"><span class="section-number-4">1.5.1</span> Number of MOs</h4>
<div class="outline-text-4" id="text-1-5-1"> <div class="outline-text-4" id="text-1-5-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">mo_num</span> = 0L; <pre class="src src-c"><span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">mo_num</span> = 0L;
@ -1442,8 +1442,8 @@ rc = qmckl_set_mo_basis_mo_num(context, mo_num);
</div> </div>
</div> </div>
<div id="outline-container-org4cb8f9f" class="outline-4"> <div id="outline-container-org61a456e" class="outline-4">
<h4 id="org4cb8f9f"><span class="section-number-4">1.5.2</span> MO coefficients</h4> <h4 id="org61a456e"><span class="section-number-4">1.5.2</span> MO coefficients</h4>
<div class="outline-text-4" id="text-1-5-2"> <div class="outline-text-4" id="text-1-5-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">{ <pre class="src src-c">{
@ -1492,12 +1492,12 @@ rc = qmckl_set_mo_basis_mo_num(context, mo_num);
</div> </div>
</div> </div>
<div id="outline-container-org1412f06" class="outline-3"> <div id="outline-container-orga32d6bb" class="outline-3">
<h3 id="org1412f06"><span class="section-number-3">1.6</span> <span class="todo TODO">TODO</span> ECP</h3> <h3 id="orga32d6bb"><span class="section-number-3">1.6</span> <span class="todo TODO">TODO</span> ECP</h3>
</div> </div>
</div> </div>
<div id="outline-container-orgda39af9" class="outline-2"> <div id="outline-container-org4ca0cde" class="outline-2">
<h2 id="orgda39af9"><span class="section-number-2">2</span> Read everything</h2> <h2 id="org4ca0cde"><span class="section-number-2">2</span> Read everything</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
@ -1572,8 +1572,8 @@ rc = qmckl_set_mo_basis_mo_num(context, mo_num);
</div> </div>
</div> </div>
<div id="outline-container-org21e5396" class="outline-2"> <div id="outline-container-orga8eb4cf" class="outline-2">
<h2 id="org21e5396"><span class="section-number-2">3</span> Test</h2> <h2 id="orga8eb4cf"><span class="section-number-2">3</span> Test</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_TREXIO <pre class="src src-c"><span style="color: #483d8b;">#ifdef</span> HAVE_TREXIO
@ -1597,8 +1597,8 @@ rc = qmckl_trexio_read(context, filename, 255);
</div> </div>
</div> </div>
<div id="outline-container-orga1b8cfc" class="outline-4"> <div id="outline-container-org7378838" class="outline-4">
<h4 id="orga1b8cfc"><span class="section-number-4">3.0.1</span> Electrons</h4> <h4 id="org7378838"><span class="section-number-4">3.0.1</span> Electrons</h4>
<div class="outline-text-4" id="text-3-0-1"> <div class="outline-text-4" id="text-3-0-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">printf(<span style="color: #8b2252;">"Electrons\n"</span>); <pre class="src src-c">printf(<span style="color: #8b2252;">"Electrons\n"</span>);
@ -1616,8 +1616,8 @@ rc = qmckl_get_electron_down_num(context, &amp;dn_num);
</div> </div>
</div> </div>
<div id="outline-container-orgcc30495" class="outline-4"> <div id="outline-container-org60c6401" class="outline-4">
<h4 id="orgcc30495"><span class="section-number-4">3.0.2</span> Nuclei</h4> <h4 id="org60c6401"><span class="section-number-4">3.0.2</span> Nuclei</h4>
<div class="outline-text-4" id="text-3-0-2"> <div class="outline-text-4" id="text-3-0-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">printf(<span style="color: #8b2252;">"Nuclei\n"</span>); <pre class="src src-c">printf(<span style="color: #8b2252;">"Nuclei\n"</span>);
@ -1657,8 +1657,8 @@ coord = <span style="color: #008b8b;">NULL</span>;
</div> </div>
</div> </div>
<div id="outline-container-orgd9a2f68" class="outline-4"> <div id="outline-container-org1505c1c" class="outline-4">
<h4 id="orgd9a2f68"><span class="section-number-4">3.0.3</span> Atomic basis</h4> <h4 id="org1505c1c"><span class="section-number-4">3.0.3</span> Atomic basis</h4>
<div class="outline-text-4" id="text-3-0-3"> <div class="outline-text-4" id="text-3-0-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">printf(<span style="color: #8b2252;">"Atomic basis\n"</span>); <pre class="src src-c">printf(<span style="color: #8b2252;">"Atomic basis\n"</span>);
@ -1766,8 +1766,8 @@ prim_factor = <span style="color: #008b8b;">NULL</span>;
</div> </div>
</div> </div>
<div id="outline-container-org3591e08" class="outline-4"> <div id="outline-container-orgdf10677" class="outline-4">
<h4 id="org3591e08"><span class="section-number-4">3.0.4</span> MO Basis</h4> <h4 id="orgdf10677"><span class="section-number-4">3.0.4</span> MO Basis</h4>
<div class="outline-text-4" id="text-3-0-4"> <div class="outline-text-4" id="text-3-0-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">printf(<span style="color: #8b2252;">"MOs\n"</span>); <pre class="src src-c">printf(<span style="color: #8b2252;">"MOs\n"</span>);
@ -1798,7 +1798,7 @@ charge = <span style="color: #008b8b;">NULL</span>;
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

46
qmckl_verificarlo.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2023-11-30 Thu 18:15 --> <!-- 2024-01-09 Tue 07:20 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Verificarlo CI</title> <title>Verificarlo CI</title>
@ -324,22 +324,22 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org060a77f">1. Verificarlo probes</a> <li><a href="#orgdc931d9">1. Verificarlo probes</a>
<ul> <ul>
<li><a href="#org909bdd6">1.1. Automatically initialize the <code>vfc_probe</code> object if <code>VFC_CI</code> is defined</a></li> <li><a href="#org41d8377">1.1. Automatically initialize the <code>vfc_probe</code> object if <code>VFC_CI</code> is defined</a></li>
<li><a href="#orge9a0d7d">1.2. Standard probe, without check</a></li> <li><a href="#org0067ee4">1.2. Standard probe, without check</a></li>
<li><a href="#orgcbfd8f6">1.3. Probe with absolute check</a></li> <li><a href="#org6eb6000">1.3. Probe with absolute check</a></li>
<li><a href="#org7cf4753">1.4. Probe with relative check</a></li> <li><a href="#org8b84e74">1.4. Probe with relative check</a></li>
<li><a href="#org4bcbf94">1.5. Automatically delete and dump the vfc<sub>probe</sub> object if <code>VFC_CI</code> is defined</a></li> <li><a href="#org8f5bc3d">1.5. Automatically delete and dump the vfc<sub>probe</sub> object if <code>VFC_CI</code> is defined</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org0ff6108">2. Fortran wrappers</a></li> <li><a href="#org63441df">2. Fortran wrappers</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org060a77f" class="outline-2"> <div id="outline-container-orgdc931d9" class="outline-2">
<h2 id="org060a77f"><span class="section-number-2">1</span> Verificarlo probes</h2> <h2 id="orgdc931d9"><span class="section-number-2">1</span> Verificarlo probes</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
This file contains utility functions to enable the Verificarlo This file contains utility functions to enable the Verificarlo
@ -390,8 +390,8 @@ To learn more about Verificarlo CI :
</div> </div>
<div id="outline-container-org909bdd6" class="outline-3"> <div id="outline-container-org41d8377" class="outline-3">
<h3 id="org909bdd6"><span class="section-number-3">1.1</span> Automatically initialize the <code>vfc_probe</code> object if <code>VFC_CI</code> is defined</h3> <h3 id="org41d8377"><span class="section-number-3">1.1</span> Automatically initialize the <code>vfc_probe</code> object if <code>VFC_CI</code> is defined</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">void</span> <span style="color: #0000ff;">qmckl_init_probes</span>(); <pre class="src src-c"><span style="color: #228b22;">void</span> <span style="color: #0000ff;">qmckl_init_probes</span>();
@ -409,8 +409,8 @@ To learn more about Verificarlo CI :
</div> </div>
</div> </div>
<div id="outline-container-orge9a0d7d" class="outline-3"> <div id="outline-container-org0067ee4" class="outline-3">
<h3 id="orge9a0d7d"><span class="section-number-3">1.2</span> Standard probe, without check</h3> <h3 id="org0067ee4"><span class="section-number-3">1.2</span> Standard probe, without check</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<ul class="org-ul"> <ul class="org-ul">
<li>if <code>VFC_CI</code> is defined, place a standard probe</li> <li>if <code>VFC_CI</code> is defined, place a standard probe</li>
@ -445,8 +445,8 @@ if <code>VFC_CI</code> is undefined, return <code>false</code> (no error)
</div> </div>
</div> </div>
<div id="outline-container-orgcbfd8f6" class="outline-3"> <div id="outline-container-org6eb6000" class="outline-3">
<h3 id="orgcbfd8f6"><span class="section-number-3">1.3</span> Probe with absolute check</h3> <h3 id="org6eb6000"><span class="section-number-3">1.3</span> Probe with absolute check</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<ul class="org-ul"> <ul class="org-ul">
<li>if <code>VFC_CI</code> is defined, place a probe with an absolute check</li> <li>if <code>VFC_CI</code> is defined, place a probe with an absolute check</li>
@ -486,8 +486,8 @@ and accuracy
</div> </div>
</div> </div>
<div id="outline-container-org7cf4753" class="outline-3"> <div id="outline-container-org8b84e74" class="outline-3">
<h3 id="org7cf4753"><span class="section-number-3">1.4</span> Probe with relative check</h3> <h3 id="org8b84e74"><span class="section-number-3">1.4</span> Probe with relative check</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<ul class="org-ul"> <ul class="org-ul">
<li>if <code>VFC_CI</code> is defined, place a probe with a relative check</li> <li>if <code>VFC_CI</code> is defined, place a probe with a relative check</li>
@ -527,8 +527,8 @@ and accuracy
</div> </div>
</div> </div>
<div id="outline-container-org4bcbf94" class="outline-3"> <div id="outline-container-org8f5bc3d" class="outline-3">
<h3 id="org4bcbf94"><span class="section-number-3">1.5</span> Automatically delete and dump the vfc<sub>probe</sub> object if <code>VFC_CI</code> is defined</h3> <h3 id="org8f5bc3d"><span class="section-number-3">1.5</span> Automatically delete and dump the vfc<sub>probe</sub> object if <code>VFC_CI</code> is defined</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">void</span> <span style="color: #0000ff;">qmckl_dump_probes</span>(); <pre class="src src-c"><span style="color: #228b22;">void</span> <span style="color: #0000ff;">qmckl_dump_probes</span>();
@ -547,8 +547,8 @@ and accuracy
</div> </div>
</div> </div>
<div id="outline-container-org0ff6108" class="outline-2"> <div id="outline-container-org63441df" class="outline-2">
<h2 id="org0ff6108"><span class="section-number-2">2</span> Fortran wrappers</h2> <h2 id="org63441df"><span class="section-number-2">2</span> Fortran wrappers</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">bool</span> <span style="color: #0000ff;">qmckl_probe_f</span>( <pre class="src src-c"><span style="color: #228b22;">bool</span> <span style="color: #0000ff;">qmckl_probe_f</span>(
@ -672,7 +672,7 @@ and accuracy
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2023-11-30 Thu 18:15</p> <p class="date">Created: 2024-01-09 Tue 07:20</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>