mirror of
https://github.com/TREX-CoE/qmckl.git
synced 2025-01-08 04:19:15 +01:00
Deploying to gh-pages from @ TREX-CoE/qmckl@b1f1843e01 🚀
This commit is contained in:
scemama
parent
14255465df
commit
eb00a8d0b1
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:14 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>QMCkl source code documentation</title>
|
||||
@ -348,7 +348,7 @@ and bug reports should be submitted at
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:14</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:14 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>QMCkl source code documentation</title>
|
||||
@ -348,7 +348,7 @@ and bug reports should be submitted at
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:14</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
102
qmckl.html
102
qmckl.html
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:14 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Introduction</title>
|
||||
@ -333,30 +333,30 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org4df9add">1. Using QMCkl</a></li>
|
||||
<li><a href="#org57d6295">2. Developing in QMCkl</a>
|
||||
<li><a href="#org8660a55">1. Using QMCkl</a></li>
|
||||
<li><a href="#orga097599">2. Developing in QMCkl</a>
|
||||
<ul>
|
||||
<li><a href="#org1791eec">2.1. Literate programming</a></li>
|
||||
<li><a href="#orge1cfdf4">2.2. Source code editing</a></li>
|
||||
<li><a href="#org10c77b1">2.3. Choice of the programming language</a></li>
|
||||
<li><a href="#org278cf8d">2.4. Coding rules</a></li>
|
||||
<li><a href="#org2dbf1dd">2.5. Design of the library</a></li>
|
||||
<li><a href="#orge204c95">2.6. Naming conventions</a></li>
|
||||
<li><a href="#org8f5bcae">2.7. Application programming interface</a></li>
|
||||
<li><a href="#org0bb1953">2.8. Global state</a></li>
|
||||
<li><a href="#org0db0c55">2.9. Low-level functions</a></li>
|
||||
<li><a href="#org5c64869">2.10. High-level functions</a></li>
|
||||
<li><a href="#org8cb3e49">2.11. Numerical precision</a></li>
|
||||
<li><a href="#org3d61e43">2.12. Algorithms</a></li>
|
||||
<li><a href="#orgc978652">2.13. Rules for the API</a></li>
|
||||
<li><a href="#org9084632">2.1. Literate programming</a></li>
|
||||
<li><a href="#orgf9b7b6f">2.2. Source code editing</a></li>
|
||||
<li><a href="#org557081d">2.3. Choice of the programming language</a></li>
|
||||
<li><a href="#org2649e44">2.4. Coding rules</a></li>
|
||||
<li><a href="#orga59eb42">2.5. Design of the library</a></li>
|
||||
<li><a href="#org5a20fdd">2.6. Naming conventions</a></li>
|
||||
<li><a href="#orgb1012e1">2.7. Application programming interface</a></li>
|
||||
<li><a href="#org423dff9">2.8. Global state</a></li>
|
||||
<li><a href="#org184d96b">2.9. Low-level functions</a></li>
|
||||
<li><a href="#org0c02484">2.10. High-level functions</a></li>
|
||||
<li><a href="#orge9bd639">2.11. Numerical precision</a></li>
|
||||
<li><a href="#org5cd9ae3">2.12. Algorithms</a></li>
|
||||
<li><a href="#org1df7057">2.13. Rules for the API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4df9add" class="outline-2">
|
||||
<h2 id="org4df9add"><span class="section-number-2">1</span> Using QMCkl</h2>
|
||||
<div id="outline-container-org8660a55" class="outline-2">
|
||||
<h2 id="org8660a55"><span class="section-number-2">1</span> Using QMCkl</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The <code>qmckl.h</code> header file has to be included in C codes when
|
||||
@ -385,12 +385,12 @@ Both files are located in the <code>include/</code> directory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org57d6295" class="outline-2">
|
||||
<h2 id="org57d6295"><span class="section-number-2">2</span> Developing in QMCkl</h2>
|
||||
<div id="outline-container-orga097599" class="outline-2">
|
||||
<h2 id="orga097599"><span class="section-number-2">2</span> Developing in QMCkl</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
</div>
|
||||
<div id="outline-container-org1791eec" class="outline-3">
|
||||
<h3 id="org1791eec"><span class="section-number-3">2.1</span> Literate programming</h3>
|
||||
<div id="outline-container-org9084632" class="outline-3">
|
||||
<h3 id="org9084632"><span class="section-number-3">2.1</span> Literate programming</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<p>
|
||||
In a traditional source code, most of the lines of source files of a program
|
||||
@ -436,8 +436,8 @@ interactively, in the same spirit as Jupyter notebooks.
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-orge1cfdf4" class="outline-3">
|
||||
<h3 id="orge1cfdf4"><span class="section-number-3">2.2</span> Source code editing</h3>
|
||||
<div id="outline-container-orgf9b7b6f" class="outline-3">
|
||||
<h3 id="orgf9b7b6f"><span class="section-number-3">2.2</span> Source code editing</h3>
|
||||
<div class="outline-text-3" id="text-2-2">
|
||||
<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>.
|
||||
@ -469,8 +469,8 @@ org-mode.
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-org10c77b1" class="outline-3">
|
||||
<h3 id="org10c77b1"><span class="section-number-3">2.3</span> Choice of the programming language</h3>
|
||||
<div id="outline-container-org557081d" class="outline-3">
|
||||
<h3 id="org557081d"><span class="section-number-3">2.3</span> Choice of the programming language</h3>
|
||||
<div class="outline-text-3" id="text-2-3">
|
||||
<p>
|
||||
Most of the codes of the <a href="https://trex-coe.eu">TREX CoE</a> are written in Fortran with some scripts in
|
||||
@ -518,8 +518,8 @@ For more guidelines on using Fortran to generate a C interface, see
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org278cf8d" class="outline-3">
|
||||
<h3 id="org278cf8d"><span class="section-number-3">2.4</span> Coding rules</h3>
|
||||
<div id="outline-container-org2649e44" class="outline-3">
|
||||
<h3 id="org2649e44"><span class="section-number-3">2.4</span> Coding rules</h3>
|
||||
<div class="outline-text-3" id="text-2-4">
|
||||
<p>
|
||||
The authors should follow the recommendations of the
|
||||
@ -535,8 +535,8 @@ freed</li>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-org2dbf1dd" class="outline-3">
|
||||
<h3 id="org2dbf1dd"><span class="section-number-3">2.5</span> Design of the library</h3>
|
||||
<div id="outline-container-orga59eb42" class="outline-3">
|
||||
<h3 id="orga59eb42"><span class="section-number-3">2.5</span> Design of the library</h3>
|
||||
<div class="outline-text-3" id="text-2-5">
|
||||
<p>
|
||||
The proposed API should allow the library to: deal with memory transfers
|
||||
@ -547,8 +547,8 @@ functions (see below).
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge204c95" class="outline-3">
|
||||
<h3 id="orge204c95"><span class="section-number-3">2.6</span> Naming conventions</h3>
|
||||
<div id="outline-container-org5a20fdd" class="outline-3">
|
||||
<h3 id="org5a20fdd"><span class="section-number-3">2.6</span> Naming conventions</h3>
|
||||
<div class="outline-text-3" id="text-2-6">
|
||||
<p>
|
||||
To avoid namespace collisions, we use <code>qmckl_</code> as a prefix for all exported
|
||||
@ -573,8 +573,8 @@ form is allowed.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8f5bcae" class="outline-3">
|
||||
<h3 id="org8f5bcae"><span class="section-number-3">2.7</span> Application programming interface</h3>
|
||||
<div id="outline-container-orgb1012e1" class="outline-3">
|
||||
<h3 id="orgb1012e1"><span class="section-number-3">2.7</span> Application programming interface</h3>
|
||||
<div class="outline-text-3" id="text-2-7">
|
||||
<p>
|
||||
In the C language, the number of bits used by the integer types can change
|
||||
@ -607,15 +607,15 @@ bindings in other languages in other repositories.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org0bb1953" class="outline-3">
|
||||
<h3 id="org0bb1953"><span class="section-number-3">2.8</span> Global state</h3>
|
||||
<div id="outline-container-org423dff9" class="outline-3">
|
||||
<h3 id="org423dff9"><span class="section-number-3">2.8</span> Global state</h3>
|
||||
<div class="outline-text-3" id="text-2-8">
|
||||
<p>
|
||||
Global variables should be avoided in the library, because it is
|
||||
possible that one single program needs to use multiple instances
|
||||
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
|
||||
<code>qmckl_context_create</code> function. The <a id="org1a4f648">=context=</a> contains the global
|
||||
<code>qmckl_context_create</code> function. The <a id="orgdafbafb">=context=</a> contains the global
|
||||
state of the library, and is used as the first argument of many
|
||||
QMCkl functions.
|
||||
</p>
|
||||
@ -635,8 +635,8 @@ versions can be destroyed with <code>qmckl_context_destroy</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org0db0c55" class="outline-3">
|
||||
<h3 id="org0db0c55"><span class="section-number-3">2.9</span> Low-level functions</h3>
|
||||
<div id="outline-container-org184d96b" class="outline-3">
|
||||
<h3 id="org184d96b"><span class="section-number-3">2.9</span> Low-level functions</h3>
|
||||
<div class="outline-text-3" id="text-2-9">
|
||||
<p>
|
||||
Low-level functions are very simple functions which are leaves of
|
||||
@ -645,14 +645,14 @@ the function call tree (they don't call any other QMCkl function).
|
||||
|
||||
<p>
|
||||
These functions are <i>pure</i>, and unaware of the QMCkl
|
||||
<a href="#org1a4f648"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
|
||||
<a href="#orgdafbafb"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
|
||||
if they need temporary memory it should be provided in input.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org5c64869" class="outline-3">
|
||||
<h3 id="org5c64869"><span class="section-number-3">2.10</span> High-level functions</h3>
|
||||
<div id="outline-container-org0c02484" class="outline-3">
|
||||
<h3 id="org0c02484"><span class="section-number-3">2.10</span> High-level functions</h3>
|
||||
<div class="outline-text-3" id="text-2-10">
|
||||
<p>
|
||||
High-level functions are at the top of the function call tree.
|
||||
@ -665,27 +665,27 @@ temporary storage, to simplify the use of accelerators.
|
||||
<p>
|
||||
The high-level functions should be pure, unless the introduction
|
||||
of non-purity is justified. All the side effects should be made in
|
||||
the <a href="#org1a4f648"><code>context</code></a> variable.
|
||||
the <a href="#orgdafbafb"><code>context</code></a> variable.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8cb3e49" class="outline-3">
|
||||
<h3 id="org8cb3e49"><span class="section-number-3">2.11</span> Numerical precision</h3>
|
||||
<div id="outline-container-orge9bd639" class="outline-3">
|
||||
<h3 id="orge9bd639"><span class="section-number-3">2.11</span> Numerical precision</h3>
|
||||
<div class="outline-text-3" id="text-2-11">
|
||||
<p>
|
||||
The number of bits of precision required for a function should be
|
||||
given as an input of low-level computational functions. This input
|
||||
will be used to define the values of the different thresholds that
|
||||
might be used to avoid computing unnecessary noise. High-level
|
||||
functions will use the precision specified in the <a href="#org1a4f648"><code>context</code></a>
|
||||
functions will use the precision specified in the <a href="#orgdafbafb"><code>context</code></a>
|
||||
variable.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3d61e43" class="outline-3">
|
||||
<h3 id="org3d61e43"><span class="section-number-3">2.12</span> Algorithms</h3>
|
||||
<div id="outline-container-org5cd9ae3" class="outline-3">
|
||||
<h3 id="org5cd9ae3"><span class="section-number-3">2.12</span> Algorithms</h3>
|
||||
<div class="outline-text-3" id="text-2-12">
|
||||
<p>
|
||||
Reducing the scaling of an algorithm usually implies also reducing
|
||||
@ -698,8 +698,8 @@ implemented adapted to different problem sizes.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgc978652" class="outline-3">
|
||||
<h3 id="orgc978652"><span class="section-number-3">2.13</span> Rules for the API</h3>
|
||||
<div id="outline-container-org1df7057" class="outline-3">
|
||||
<h3 id="org1df7057"><span class="section-number-3">2.13</span> Rules for the API</h3>
|
||||
<div class="outline-text-3" id="text-2-13">
|
||||
<ul class="org-ul">
|
||||
<li><code>stdint</code> should be used for integers (<code>int32_t</code>, <code>int64_t</code>)</li>
|
||||
@ -713,7 +713,7 @@ implemented adapted to different problem sizes.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:14</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:14 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Atomic Orbitals</title>
|
||||
@ -333,14 +333,14 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orgf1cad8d">1. Polynomial part</a>
|
||||
<li><a href="#org31a9a5e">1. Polynomial part</a>
|
||||
<ul>
|
||||
<li><a href="#org7e5edc1">1.1. Powers of \(x-X_i\)</a></li>
|
||||
<li><a href="#org8d828f1">1.2. Value, Gradient and Laplacian of a polynomial</a></li>
|
||||
<li><a href="#org44015c3">1.1. Powers of \(x-X_i\)</a></li>
|
||||
<li><a href="#org4798ffb">1.2. Value, Gradient and Laplacian of a polynomial</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org6f3397c">2. Gaussian basis functions</a></li>
|
||||
<li><a href="#orged13bf2">3. <span class="todo TODO">TODO</span> Slater basis functions</a></li>
|
||||
<li><a href="#org2caedcc">2. Gaussian basis functions</a></li>
|
||||
<li><a href="#org1f77090">3. <span class="todo TODO">TODO</span> Slater basis functions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
@ -389,12 +389,12 @@ In this section we describe the kernels used to compute the values,
|
||||
gradients and Laplacian of the atomic basis functions.
|
||||
</p>
|
||||
|
||||
<div id="outline-container-orgf1cad8d" class="outline-2">
|
||||
<h2 id="orgf1cad8d"><span class="section-number-2">1</span> Polynomial part</h2>
|
||||
<div id="outline-container-org31a9a5e" class="outline-2">
|
||||
<h2 id="org31a9a5e"><span class="section-number-2">1</span> Polynomial part</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div>
|
||||
<div id="outline-container-org7e5edc1" class="outline-3">
|
||||
<h3 id="org7e5edc1"><span class="section-number-3">1.1</span> Powers of \(x-X_i\)</h3>
|
||||
<div id="outline-container-org44015c3" class="outline-3">
|
||||
<h3 id="org44015c3"><span class="section-number-3">1.1</span> Powers of \(x-X_i\)</h3>
|
||||
<div class="outline-text-3" id="text-1-1">
|
||||
<p>
|
||||
The <code>qmckl_ao_power</code> function computes all the powers of the <code>n</code>
|
||||
@ -574,8 +574,8 @@ Requirements:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8d828f1" class="outline-3">
|
||||
<h3 id="org8d828f1"><span class="section-number-3">1.2</span> Value, Gradient and Laplacian of a polynomial</h3>
|
||||
<div id="outline-container-org4798ffb" class="outline-3">
|
||||
<h3 id="org4798ffb"><span class="section-number-3">1.2</span> Value, Gradient and Laplacian of a polynomial</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
A polynomial is centered on a nucleus \(\mathbf{R}_i\)
|
||||
@ -755,7 +755,7 @@ For example, with a=0, b=2 and c=1 the string is "yyz"</li>
|
||||
<span style="color: #a020f0;">return</span>
|
||||
<span style="color: #a020f0;">endif</span>
|
||||
|
||||
<span style="color: #a020f0;">if</span> (lmax <= 0) <span style="color: #a020f0;">then</span>
|
||||
<span style="color: #a020f0;">if</span> (lmax < 0) <span style="color: #a020f0;">then</span>
|
||||
info = QMCKL_INVALID_ARG_4
|
||||
<span style="color: #a020f0;">return</span>
|
||||
<span style="color: #a020f0;">endif</span>
|
||||
@ -960,8 +960,8 @@ munit_assert_int(0, ==, test_qmckl_ao_polynomial_vgl(context));
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6f3397c" class="outline-2">
|
||||
<h2 id="org6f3397c"><span class="section-number-2">2</span> Gaussian basis functions</h2>
|
||||
<div id="outline-container-org2caedcc" class="outline-2">
|
||||
<h2 id="org2caedcc"><span class="section-number-2">2</span> Gaussian basis functions</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
<code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and
|
||||
@ -1193,13 +1193,13 @@ Requirements :
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orged13bf2" class="outline-2">
|
||||
<h2 id="orged13bf2"><span class="section-number-2">3</span> <span class="todo TODO">TODO</span> Slater basis functions</h2>
|
||||
<div id="outline-container-org1f77090" class="outline-2">
|
||||
<h2 id="org1f77090"><span class="section-number-2">3</span> <span class="todo TODO">TODO</span> Slater basis functions</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:14</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:15 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Context</title>
|
||||
@ -333,51 +333,51 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org0f9f181">1. Context handling</a>
|
||||
<li><a href="#orgccdccea">1. Context handling</a>
|
||||
<ul>
|
||||
<li><a href="#orga63e589">1.1. Data structure</a></li>
|
||||
<li><a href="#org6fd4b32">1.2. Creation</a></li>
|
||||
<li><a href="#orgc8f45ba">1.3. Access to the previous context</a></li>
|
||||
<li><a href="#orgeff095c">1.4. Locking</a></li>
|
||||
<li><a href="#org30a73d0">1.5. Copy</a></li>
|
||||
<li><a href="#org0e93e66">1.6. Destroy</a></li>
|
||||
<li><a href="#org0d73df0">1.1. Data structure</a></li>
|
||||
<li><a href="#org0b2eea0">1.2. Creation</a></li>
|
||||
<li><a href="#org440962a">1.3. Access to the previous context</a></li>
|
||||
<li><a href="#org30d6c41">1.4. Locking</a></li>
|
||||
<li><a href="#org51c5f1e">1.5. Copy</a></li>
|
||||
<li><a href="#orgf60140a">1.6. Destroy</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgd2909d2">2. Memory allocation handling</a>
|
||||
<li><a href="#orge9ab598">2. Memory allocation handling</a>
|
||||
<ul>
|
||||
<li><a href="#org0c4ddbb">2.1. Data structure</a></li>
|
||||
<li><a href="#org27fe85d">2.2. Append memory</a></li>
|
||||
<li><a href="#org071f19c">2.3. Remove memory</a></li>
|
||||
<li><a href="#org8cf241d">2.1. Data structure</a></li>
|
||||
<li><a href="#orgd59bc4a">2.2. Append memory</a></li>
|
||||
<li><a href="#org5268018">2.3. Remove memory</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org3694b70">3. Error handling</a>
|
||||
<li><a href="#orgc22f772">3. Error handling</a>
|
||||
<ul>
|
||||
<li><a href="#orgc2f4ca1">3.1. Data structure</a></li>
|
||||
<li><a href="#orgb5bf3c0">3.2. Updating errors</a></li>
|
||||
<li><a href="#org219d91e">3.1. Data structure</a></li>
|
||||
<li><a href="#orgf857a9a">3.2. Updating errors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org62a6316">4. Control of the numerical precision</a>
|
||||
<li><a href="#org5dabf81">4. Control of the numerical precision</a>
|
||||
<ul>
|
||||
<li><a href="#orgfd77a57">4.1. Precision</a></li>
|
||||
<li><a href="#org817ceb2">4.2. Range</a></li>
|
||||
<li><a href="#org1ab7580">4.3. Helper functions</a></li>
|
||||
<li><a href="#orgc541d48">4.1. Precision</a></li>
|
||||
<li><a href="#org5e30b08">4.2. Range</a></li>
|
||||
<li><a href="#org1c4965c">4.3. Helper functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org7b26308">5. <span class="todo TODO">TODO</span> Basis set</a>
|
||||
<li><a href="#orgca8ff2f">5. <span class="todo TODO">TODO</span> Basis set</a>
|
||||
<ul>
|
||||
<li><a href="#org851df7d">5.1. Data structure</a></li>
|
||||
<li><a href="#orgdbfa251">5.2. <code>qmckl_context_update_ao_basis</code></a>
|
||||
<li><a href="#orgbc20d14">5.1. Data structure</a></li>
|
||||
<li><a href="#org5006e98">5.2. <code>qmckl_context_update_ao_basis</code></a>
|
||||
<ul>
|
||||
<li><a href="#org747f996">5.2.1. Source</a></li>
|
||||
<li><a href="#orgb14334d">5.2.2. Fortran interface</a></li>
|
||||
<li><a href="#org81f49da">5.2.3. <span class="todo TODO">TODO</span> Test</a></li>
|
||||
<li><a href="#orgf64b06b">5.2.1. Source</a></li>
|
||||
<li><a href="#org7ecb195">5.2.2. Fortran interface</a></li>
|
||||
<li><a href="#orgddf86ca">5.2.3. <span class="todo TODO">TODO</span> Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org9d3a1bc">5.3. <code>qmckl_context_set_ao_basis</code></a>
|
||||
<li><a href="#org7f16977">5.3. <code>qmckl_context_set_ao_basis</code></a>
|
||||
<ul>
|
||||
<li><a href="#org787a06c">5.3.1. Source</a></li>
|
||||
<li><a href="#orga1dbf46">5.3.2. Fortran interface</a></li>
|
||||
<li><a href="#org91351d0">5.3.3. <span class="todo TODO">TODO</span> Test</a></li>
|
||||
<li><a href="#org59d46d5">5.3.1. Source</a></li>
|
||||
<li><a href="#org455ffb5">5.3.2. Fortran interface</a></li>
|
||||
<li><a href="#org1184c14">5.3.3. <span class="todo TODO">TODO</span> Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -401,8 +401,8 @@ A value of <code>QMCKL_NULL_CONTEXT</code> for the context is equivalent to a
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org0f9f181" class="outline-2">
|
||||
<h2 id="org0f9f181"><span class="section-number-2">1</span> Context handling</h2>
|
||||
<div id="outline-container-orgccdccea" class="outline-2">
|
||||
<h2 id="orgccdccea"><span class="section-number-2">1</span> Context handling</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The context appears as an immutable data structure: modifying a
|
||||
@ -419,8 +419,8 @@ and <code>ctx</code> is a <code>qmckl_context_struct*</code> pointer.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga63e589" class="outline-3">
|
||||
<h3 id="orga63e589"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div id="outline-container-org0d73df0" class="outline-3">
|
||||
<h3 id="org0d73df0"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div class="outline-text-3" id="text-1-1">
|
||||
<p>
|
||||
The main data structure contains pointers to other data structures,
|
||||
@ -430,7 +430,7 @@ pointers.
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="org7bd1cc2"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_context_struct</span> {
|
||||
<pre class="src src-c" id="org8577cca"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_context_struct</span> {
|
||||
|
||||
/* <span style="color: #b22222;">Pointer to the previous context, before modification </span>*/
|
||||
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_context_struct</span> * <span style="color: #a0522d;">prev</span>;
|
||||
@ -510,8 +510,8 @@ if the context is valid, <code>QMCKL_NULL_CONTEXT</code> otherwise.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6fd4b32" class="outline-3">
|
||||
<h3 id="org6fd4b32"><span class="section-number-3">1.2</span> Creation</h3>
|
||||
<div id="outline-container-org0b2eea0" class="outline-3">
|
||||
<h3 id="org0b2eea0"><span class="section-number-3">1.2</span> Creation</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
To create a new context, <code>qmckl_context_create()</code> should be used.
|
||||
@ -563,8 +563,8 @@ To create a new context, <code>qmckl_context_create()</code> should be used.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgc8f45ba" class="outline-3">
|
||||
<h3 id="orgc8f45ba"><span class="section-number-3">1.3</span> Access to the previous context</h3>
|
||||
<div id="outline-container-org440962a" class="outline-3">
|
||||
<h3 id="org440962a"><span class="section-number-3">1.3</span> Access to the previous context</h3>
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>
|
||||
<code>qmckl_context_previous</code> returns the previous context. It returns
|
||||
@ -586,8 +586,8 @@ To create a new context, <code>qmckl_context_create()</code> should be used.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgeff095c" class="outline-3">
|
||||
<h3 id="orgeff095c"><span class="section-number-3">1.4</span> Locking</h3>
|
||||
<div id="outline-container-org30d6c41" class="outline-3">
|
||||
<h3 id="org30d6c41"><span class="section-number-3">1.4</span> Locking</h3>
|
||||
<div class="outline-text-3" id="text-1-4">
|
||||
<p>
|
||||
For thread safety, the context may be locked/unlocked. The lock is
|
||||
@ -647,8 +647,8 @@ number of times the thread has locked it is saved in the
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org30a73d0" class="outline-3">
|
||||
<h3 id="org30a73d0"><span class="section-number-3">1.5</span> Copy</h3>
|
||||
<div id="outline-container-org51c5f1e" class="outline-3">
|
||||
<h3 id="org51c5f1e"><span class="section-number-3">1.5</span> Copy</h3>
|
||||
<div class="outline-text-3" id="text-1-5">
|
||||
<p>
|
||||
<code>qmckl_context_copy</code> makes a shallow copy of a context. It returns
|
||||
@ -694,8 +694,8 @@ number of times the thread has locked it is saved in the
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org0e93e66" class="outline-3">
|
||||
<h3 id="org0e93e66"><span class="section-number-3">1.6</span> Destroy</h3>
|
||||
<div id="outline-container-orgf60140a" class="outline-3">
|
||||
<h3 id="orgf60140a"><span class="section-number-3">1.6</span> Destroy</h3>
|
||||
<div class="outline-text-3" id="text-1-6">
|
||||
<p>
|
||||
The context is destroyed with <code>qmckl_context_destroy</code>, leaving the ancestors untouched.
|
||||
@ -755,12 +755,12 @@ It frees the context, and returns the previous context.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgd2909d2" class="outline-2">
|
||||
<h2 id="orgd2909d2"><span class="section-number-2">2</span> Memory allocation handling</h2>
|
||||
<div id="outline-container-orge9ab598" class="outline-2">
|
||||
<h2 id="orge9ab598"><span class="section-number-2">2</span> Memory allocation handling</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
</div>
|
||||
<div id="outline-container-org0c4ddbb" class="outline-3">
|
||||
<h3 id="org0c4ddbb"><span class="section-number-3">2.1</span> Data structure</h3>
|
||||
<div id="outline-container-org8cf241d" class="outline-3">
|
||||
<h3 id="org8cf241d"><span class="section-number-3">2.1</span> Data structure</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<p>
|
||||
Pointers to all allocated memory domains are stored in the context,
|
||||
@ -769,7 +769,7 @@ computation of the amount of currently used memory by the library.
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="org71434c6"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_memory_struct</span> {
|
||||
<pre class="src src-c" id="orgc6e88ce"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_memory_struct</span> {
|
||||
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_memory_struct</span> * <span style="color: #a0522d;">next</span> ;
|
||||
<span style="color: #228b22;">void</span> * <span style="color: #a0522d;">pointer</span> ;
|
||||
<span style="color: #228b22;">size_t</span> <span style="color: #a0522d;">size</span> ;
|
||||
@ -779,8 +779,8 @@ computation of the amount of currently used memory by the library.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org27fe85d" class="outline-3">
|
||||
<h3 id="org27fe85d"><span class="section-number-3">2.2</span> Append memory</h3>
|
||||
<div id="outline-container-orgd59bc4a" class="outline-3">
|
||||
<h3 id="orgd59bc4a"><span class="section-number-3">2.2</span> Append memory</h3>
|
||||
<div class="outline-text-3" id="text-2-2">
|
||||
<p>
|
||||
The following function, called in <a href="./qmckl_memory.html"><code>qmckl_memory.c</code></a>, appends a new
|
||||
@ -838,8 +838,8 @@ immediately with <code>QMCKL_SUCCESS</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org071f19c" class="outline-3">
|
||||
<h3 id="org071f19c"><span class="section-number-3">2.3</span> Remove memory</h3>
|
||||
<div id="outline-container-org5268018" class="outline-3">
|
||||
<h3 id="org5268018"><span class="section-number-3">2.3</span> Remove memory</h3>
|
||||
<div class="outline-text-3" id="text-2-3">
|
||||
<p>
|
||||
The following function, called in <a href="./qmckl_memory.html"><code>qmckl_memory.c</code></a>, removes a
|
||||
@ -890,15 +890,15 @@ immediately with <code>QMCKL_SUCCESS</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3694b70" class="outline-2">
|
||||
<h2 id="org3694b70"><span class="section-number-2">3</span> Error handling</h2>
|
||||
<div id="outline-container-orgc22f772" class="outline-2">
|
||||
<h2 id="orgc22f772"><span class="section-number-2">3</span> Error handling</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
</div>
|
||||
<div id="outline-container-orgc2f4ca1" class="outline-3">
|
||||
<h3 id="orgc2f4ca1"><span class="section-number-3">3.1</span> Data structure</h3>
|
||||
<div id="outline-container-org219d91e" class="outline-3">
|
||||
<h3 id="org219d91e"><span class="section-number-3">3.1</span> Data structure</h3>
|
||||
<div class="outline-text-3" id="text-3-1">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="org4f49fd8"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_MAX_FUN_LEN</span> 256
|
||||
<pre class="src src-c" id="org6c55fba"><span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_MAX_FUN_LEN</span> 256
|
||||
<span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_MAX_MSG_LEN</span> 1024
|
||||
|
||||
<span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_error_struct</span> {
|
||||
@ -913,8 +913,8 @@ immediately with <code>QMCKL_SUCCESS</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb5bf3c0" class="outline-3">
|
||||
<h3 id="orgb5bf3c0"><span class="section-number-3">3.2</span> Updating errors</h3>
|
||||
<div id="outline-container-orgf857a9a" class="outline-3">
|
||||
<h3 id="orgf857a9a"><span class="section-number-3">3.2</span> Updating errors</h3>
|
||||
<div class="outline-text-3" id="text-3-2">
|
||||
<p>
|
||||
The error is updated in the context using
|
||||
@ -1063,8 +1063,8 @@ For example, this function can be used as
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org62a6316" class="outline-2">
|
||||
<h2 id="org62a6316"><span class="section-number-2">4</span> Control of the numerical precision</h2>
|
||||
<div id="outline-container-org5dabf81" class="outline-2">
|
||||
<h2 id="org5dabf81"><span class="section-number-2">4</span> Control of the numerical precision</h2>
|
||||
<div class="outline-text-2" id="text-4">
|
||||
<p>
|
||||
Controlling numerical precision enables optimizations. Here, the
|
||||
@ -1072,7 +1072,7 @@ default parameters determining the target numerical precision and
|
||||
range are defined.
|
||||
</p>
|
||||
|
||||
<table id="org13bd5fd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="org1071224" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -1118,7 +1118,7 @@ range are defined.
|
||||
</div>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="orgcf1a6e7"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_precision_struct</span> {
|
||||
<pre class="src src-c" id="org4547f9c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_precision_struct</span> {
|
||||
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">precision</span>;
|
||||
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">range</span>;
|
||||
} <span style="color: #228b22;">qmckl_precision_struct</span>;
|
||||
@ -1139,8 +1139,8 @@ integer. The update functions return <code>QMCKL_SUCCESS</code> or
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgfd77a57" class="outline-3">
|
||||
<h3 id="orgfd77a57"><span class="section-number-3">4.1</span> Precision</h3>
|
||||
<div id="outline-container-orgc541d48" class="outline-3">
|
||||
<h3 id="orgc541d48"><span class="section-number-3">4.1</span> Precision</h3>
|
||||
<div class="outline-text-3" id="text-4-1">
|
||||
<p>
|
||||
<code>qmckl_context_update_precision</code> modifies the parameter for the
|
||||
@ -1262,8 +1262,8 @@ different precision parameter.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org817ceb2" class="outline-3">
|
||||
<h3 id="org817ceb2"><span class="section-number-3">4.2</span> Range</h3>
|
||||
<div id="outline-container-org5e30b08" class="outline-3">
|
||||
<h3 id="org5e30b08"><span class="section-number-3">4.2</span> Range</h3>
|
||||
<div class="outline-text-3" id="text-4-2">
|
||||
<p>
|
||||
<code>qmckl_context_update_range</code> modifies the parameter for the numerical range in a given context.
|
||||
@ -1371,8 +1371,8 @@ different precision parameter.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org1ab7580" class="outline-3">
|
||||
<h3 id="org1ab7580"><span class="section-number-3">4.3</span> Helper functions</h3>
|
||||
<div id="outline-container-org1c4965c" class="outline-3">
|
||||
<h3 id="org1c4965c"><span class="section-number-3">4.3</span> Helper functions</h3>
|
||||
<div class="outline-text-3" id="text-4-3">
|
||||
<p>
|
||||
<code>qmckl_context_get_epsilon</code> returns \(\epsilon = 2^{1-n}\) where <code>n</code> is the precision.
|
||||
@ -1388,8 +1388,8 @@ different precision parameter.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org7b26308" class="outline-2">
|
||||
<h2 id="org7b26308"><span class="section-number-2">5</span> <span class="todo TODO">TODO</span> Basis set</h2>
|
||||
<div id="outline-container-orgca8ff2f" class="outline-2">
|
||||
<h2 id="orgca8ff2f"><span class="section-number-2">5</span> <span class="todo TODO">TODO</span> Basis set</h2>
|
||||
<div class="outline-text-2" id="text-5">
|
||||
<p>
|
||||
For H<sub>2</sub> with the following basis set,
|
||||
@ -1436,11 +1436,11 @@ COEFFICIENT = [ 0.006068, 0.045308, 0.202822, 0.503903, 0.383421,
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org851df7d" class="outline-3">
|
||||
<h3 id="org851df7d"><span class="section-number-3">5.1</span> Data structure</h3>
|
||||
<div id="outline-container-orgbc20d14" class="outline-3">
|
||||
<h3 id="orgbc20d14"><span class="section-number-3">5.1</span> Data structure</h3>
|
||||
<div class="outline-text-3" id="text-5-1">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="org1e82de4"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_ao_basis_struct</span> {
|
||||
<pre class="src src-c" id="orgc8e92f0"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">qmckl_ao_basis_struct</span> {
|
||||
|
||||
<span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">shell_num</span>;
|
||||
<span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">prim_num</span>;
|
||||
@ -1458,8 +1458,8 @@ COEFFICIENT = [ 0.006068, 0.045308, 0.202822, 0.503903, 0.383421,
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgdbfa251" class="outline-3">
|
||||
<h3 id="orgdbfa251"><span class="section-number-3">5.2</span> <code>qmckl_context_update_ao_basis</code></h3>
|
||||
<div id="outline-container-org5006e98" class="outline-3">
|
||||
<h3 id="org5006e98"><span class="section-number-3">5.2</span> <code>qmckl_context_update_ao_basis</code></h3>
|
||||
<div class="outline-text-3" id="text-5-2">
|
||||
<p>
|
||||
Updates the data describing the AO basis set into the context.
|
||||
@ -1543,8 +1543,8 @@ Updates the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org747f996" class="outline-4">
|
||||
<h4 id="org747f996"><span class="section-number-4">5.2.1</span> Source</h4>
|
||||
<div id="outline-container-orgf64b06b" class="outline-4">
|
||||
<h4 id="orgf64b06b"><span class="section-number-4">5.2.1</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-5-2-1">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span>
|
||||
@ -1685,8 +1685,8 @@ Updates the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb14334d" class="outline-4">
|
||||
<h4 id="orgb14334d"><span class="section-number-4">5.2.2</span> Fortran interface</h4>
|
||||
<div id="outline-container-org7ecb195" class="outline-4">
|
||||
<h4 id="org7ecb195"><span class="section-number-4">5.2.2</span> Fortran interface</h4>
|
||||
<div class="outline-text-4" id="text-5-2-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||
@ -1712,13 +1712,13 @@ Updates the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org81f49da" class="outline-4">
|
||||
<h4 id="org81f49da"><span class="section-number-4">5.2.3</span> <span class="todo TODO">TODO</span> Test</h4>
|
||||
<div id="outline-container-orgddf86ca" class="outline-4">
|
||||
<h4 id="orgddf86ca"><span class="section-number-4">5.2.3</span> <span class="todo TODO">TODO</span> Test</h4>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9d3a1bc" class="outline-3">
|
||||
<h3 id="org9d3a1bc"><span class="section-number-3">5.3</span> <code>qmckl_context_set_ao_basis</code></h3>
|
||||
<div id="outline-container-org7f16977" class="outline-3">
|
||||
<h3 id="org7f16977"><span class="section-number-3">5.3</span> <code>qmckl_context_set_ao_basis</code></h3>
|
||||
<div class="outline-text-3" id="text-5-3">
|
||||
<p>
|
||||
Sets the data describing the AO basis set into the context.
|
||||
@ -1797,8 +1797,8 @@ Sets the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org787a06c" class="outline-4">
|
||||
<h4 id="org787a06c"><span class="section-number-4">5.3.1</span> Source</h4>
|
||||
<div id="outline-container-org59d46d5" class="outline-4">
|
||||
<h4 id="org59d46d5"><span class="section-number-4">5.3.1</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-5-3-1">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_context</span>
|
||||
@ -1827,8 +1827,8 @@ Sets the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga1dbf46" class="outline-4">
|
||||
<h4 id="orga1dbf46"><span class="section-number-4">5.3.2</span> Fortran interface</h4>
|
||||
<div id="outline-container-org455ffb5" class="outline-4">
|
||||
<h4 id="org455ffb5"><span class="section-number-4">5.3.2</span> Fortran interface</h4>
|
||||
<div class="outline-text-4" id="text-5-3-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||
@ -1854,15 +1854,15 @@ Sets the data describing the AO basis set into the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org91351d0" class="outline-4">
|
||||
<h4 id="org91351d0"><span class="section-number-4">5.3.3</span> <span class="todo TODO">TODO</span> Test</h4>
|
||||
<div id="outline-container-org1184c14" class="outline-4">
|
||||
<h4 id="org1184c14"><span class="section-number-4">5.3.3</span> <span class="todo TODO">TODO</span> Test</h4>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:15</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:15 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Distances</title>
|
||||
@ -333,13 +333,13 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org501dade">1. Squared distance</a>
|
||||
<li><a href="#org2a91916">1. Squared distance</a>
|
||||
<ul>
|
||||
<li>
|
||||
<ul>
|
||||
<li><a href="#orgca5ba63">1.0.1. Requirements</a></li>
|
||||
<li><a href="#org58e501a">1.0.2. Performance</a></li>
|
||||
<li><a href="#org1b40e06">1.0.3. Source</a></li>
|
||||
<li><a href="#org26eaba0">1.0.1. Requirements</a></li>
|
||||
<li><a href="#org8abe185">1.0.2. Performance</a></li>
|
||||
<li><a href="#org4b6414f">1.0.3. Source</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -351,8 +351,8 @@ for the JavaScript code in this tag.
|
||||
Functions for the computation of distances between particles.
|
||||
</p>
|
||||
|
||||
<div id="outline-container-org501dade" class="outline-2">
|
||||
<h2 id="org501dade"><span class="section-number-2">1</span> Squared distance</h2>
|
||||
<div id="outline-container-org2a91916" class="outline-2">
|
||||
<h2 id="org2a91916"><span class="section-number-2">1</span> Squared distance</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
<code>qmckl_distance_sq</code> computes the matrix of the squared distances
|
||||
@ -445,8 +445,8 @@ Functions for the computation of distances between particles.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgca5ba63" class="outline-4">
|
||||
<h4 id="orgca5ba63"><span class="section-number-4">1.0.1</span> Requirements</h4>
|
||||
<div id="outline-container-org26eaba0" class="outline-4">
|
||||
<h4 id="org26eaba0"><span class="section-number-4">1.0.1</span> Requirements</h4>
|
||||
<div class="outline-text-4" id="text-1-0-1">
|
||||
<ul class="org-ul">
|
||||
<li><code>context</code> is not 0</li>
|
||||
@ -464,8 +464,8 @@ Functions for the computation of distances between particles.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org58e501a" class="outline-4">
|
||||
<h4 id="org58e501a"><span class="section-number-4">1.0.2</span> Performance</h4>
|
||||
<div id="outline-container-org8abe185" class="outline-4">
|
||||
<h4 id="org8abe185"><span class="section-number-4">1.0.2</span> Performance</h4>
|
||||
<div class="outline-text-4" id="text-1-0-2">
|
||||
<p>
|
||||
This function might be more efficient when <code>A</code> and <code>B</code> are
|
||||
@ -484,8 +484,8 @@ transposed.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org1b40e06" class="outline-4">
|
||||
<h4 id="org1b40e06"><span class="section-number-4">1.0.3</span> Source</h4>
|
||||
<div id="outline-container-org4b6414f" class="outline-4">
|
||||
<h4 id="org4b6414f"><span class="section-number-4">1.0.3</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-1-0-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">qmckl_distance_sq_f</span><span style="color: #000000; background-color: #ffffff;">(context, transa, transb, m, n, A, LDA, B, LDB, C, LDC) result(info)</span>
|
||||
@ -621,7 +621,7 @@ transposed.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:15</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:15 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Error handling</title>
|
||||
@ -311,14 +311,14 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orgc923690"></a></li>
|
||||
<li><a href="#org2c84765"></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgc923690" class="outline-2">
|
||||
<h2 id="orgc923690"></h2>
|
||||
<div class="outline-text-2" id="text-orgc923690">
|
||||
<div id="outline-container-org2c84765" class="outline-2">
|
||||
<h2 id="org2c84765"></h2>
|
||||
<div class="outline-text-2" id="text-org2c84765">
|
||||
<p>
|
||||
The library should never make the calling programs abort, nor
|
||||
perform any input/output operations. This decision has to be taken
|
||||
@ -329,7 +329,7 @@ by the developer of the code calling the library.
|
||||
All the functions return with an exit code, defined as
|
||||
</p>
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="org59e0293"><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="org9692c69"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>;
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
@ -345,7 +345,7 @@ error code is returned to the program.
|
||||
Here is the complete list of exit codes.
|
||||
</p>
|
||||
|
||||
<table id="orge75d273" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="org896c96e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -558,7 +558,7 @@ The text strings are extracted from the previous table.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:15</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:15 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Memory management</title>
|
||||
@ -311,7 +311,7 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orge0b7c90"></a></li>
|
||||
<li><a href="#org3f541c9"></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
@ -321,9 +321,9 @@ optimized libraries to fine-tune the memory allocation.
|
||||
</p>
|
||||
|
||||
|
||||
<div id="outline-container-orge0b7c90" class="outline-2">
|
||||
<h2 id="orge0b7c90"></h2>
|
||||
<div class="outline-text-2" id="text-orge0b7c90">
|
||||
<div id="outline-container-org3f541c9" class="outline-2">
|
||||
<h2 id="org3f541c9"></h2>
|
||||
<div class="outline-text-2" id="text-org3f541c9">
|
||||
<p>
|
||||
Memory allocation inside the library should be done with
|
||||
<code>qmckl_malloc</code>. It lets the library choose how the memory will be
|
||||
@ -429,7 +429,7 @@ allocation and needs to be updated.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:15</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-03-19 Fri 22:15 -->
|
||||
<!-- 2021-03-19 Fri 22:17 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Testing</title>
|
||||
@ -311,7 +311,7 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:15</p>
|
||||
<p class="date">Created: 2021-03-19 Fri 22:17</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user