Deploying to gh-pages from @ 2db5dde 🚀

gha3mi · Apr 22, 2024 · 2161f58 · 2161f58
1 parent d77ba75
commit 2161f58
Show file tree

Hide file tree

Showing 100 changed files with 356 additions and 361 deletions.
diff --git a/index.html b/index.html
@@ -97,7 +97,6 @@ <h2>fpm dependency</h2>
 
 <h2>Usage</h2>
 <h3>Measuring elapsed time (system_clock)</h3>
-<p>To measure the elapsed wall-clock time, use the following:</p>
 <div class="codehilite"><pre><span></span><code><span class="k">use </span><span class="n">fortime</span>
 <span class="k">type</span><span class="p">(</span><span class="n">timer</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">t</span>
 
@@ -109,7 +108,6 @@ <h3>Measuring elapsed time (system_clock)</h3>
 </code></pre></div>
 
 <h3>Measuring elapsed time (date_and_time)</h3>
-<p>To measure the elapsed wall-clock time, use the following:</p>
 <div class="codehilite"><pre><span></span><code><span class="k">use </span><span class="n">fortime</span>
 <span class="k">type</span><span class="p">(</span><span class="n">timer</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">t</span>
 
@@ -121,7 +119,6 @@ <h3>Measuring elapsed time (date_and_time)</h3>
 </code></pre></div>
 
 <h3>Measuring CPU time (cpu_time)</h3>
-<p>To measure the CPU time consumed by your code, use these functions:</p>
 <div class="codehilite"><pre><span></span><code><span class="k">use </span><span class="n">fortime</span>
 <span class="k">type</span><span class="p">(</span><span class="n">timer</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">t</span>
 
@@ -133,7 +130,6 @@ <h3>Measuring CPU time (cpu_time)</h3>
 </code></pre></div>
 
 <h3>Measuring OpenMP time (omp_get_wtime)</h3>
-<p>If your code includes OpenMP parallelization, you can measure the time taken by the parallel regions using:</p>
 <div class="codehilite"><pre><span></span><code><span class="k">use </span><span class="n">fortime</span>
 <span class="k">type</span><span class="p">(</span><span class="n">timer</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">t</span>
 
@@ -144,9 +140,8 @@ <h3>Measuring OpenMP time (omp_get_wtime)</h3>
 <span class="k">call </span><span class="n">t</span><span class="p">%</span><span class="n">otimer_write</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span><span class="w"> </span><span class="c">! Optionally, write the result to a file</span>
 </code></pre></div>
 
-<p><strong>Note:</strong> Ensure you compile with the <code>-DUSE_OMP</code> option when using the OpenMP timer.</p>
+<p><strong>Note:</strong> Compile with the <code>-DUSE_OMP</code> option when using the OpenMP timer.</p>
 <h3>Measuring MPI time (mpi_wtime)</h3>
-<p>When using MPI (Message Passing Interface), you can measure the time taken by your MPI processes using:</p>
 <div class="codehilite"><pre><span></span><code><span class="k">use </span><span class="n">fortime</span>
 <span class="k">type</span><span class="p">(</span><span class="n">timer</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">t</span>
 
@@ -157,7 +152,7 @@ <h3>Measuring MPI time (mpi_wtime)</h3>
 <span class="k">call </span><span class="n">t</span><span class="p">%</span><span class="n">mtimer_write</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span><span class="w"> </span><span class="c">! Optionally, write the result to a file</span>
 </code></pre></div>
 
-<p><strong>Note:</strong> Don't forget to compile with the <code>-DUSE_MPI</code> option when using the MPI timer.</p>
+<p><strong>Note:</strong> Compile with the <code>-DUSE_MPI</code> option when using the MPI timer.</p>
 <h2>Running Examples and Tests</h2>
 <h3>Clone the Repository</h3>
 <p>First, clone the <code>ForTime</code> repository from GitHub and navigate to the project directory:</p>
@@ -270,7 +265,7 @@ <h3>Derived Types</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/lists/files.html b/lists/files.html
@@ -847,7 +847,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/lists/modules.html b/lists/modules.html
@@ -1102,7 +1102,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/lists/procedures.html b/lists/procedures.html
@@ -1628,7 +1628,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/lists/programs.html b/lists/programs.html
@@ -269,7 +269,7 @@ <h1>Programs</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/lists/types.html b/lists/types.html
@@ -97,7 +97,7 @@ <h1>Derived Types</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/module/fortime.html b/module/fortime.html
@@ -1563,7 +1563,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~20"></span>
+              <span class="anchor" id="variable-nloops~8"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -1754,7 +1754,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~21"></span>
+              <span class="anchor" id="variable-nloops~9"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -1945,7 +1945,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~22"></span>
+              <span class="anchor" id="variable-nloops~10"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -2136,7 +2136,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~23"></span>
+              <span class="anchor" id="variable-nloops~11"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -2327,7 +2327,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~24"></span>
+              <span class="anchor" id="variable-nloops~12"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -2516,7 +2516,7 @@ <h4>Arguments</h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/ctimer_start.html b/proc/ctimer_start.html
@@ -451,7 +451,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/ctimer_stop.html b/proc/ctimer_stop.html
@@ -180,7 +180,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~21"></span>
+              <span class="anchor" id="variable-nloops~9"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -643,7 +643,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/ctimer_write.html b/proc/ctimer_write.html
@@ -436,7 +436,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/dtimer_start.html b/proc/dtimer_start.html
@@ -451,7 +451,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/dtimer_stop.html b/proc/dtimer_stop.html
@@ -180,7 +180,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~24"></span>
+              <span class="anchor" id="variable-nloops~12"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -661,7 +661,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/dtimer_write.html b/proc/dtimer_write.html
@@ -436,7 +436,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/mtimer_start.html b/proc/mtimer_start.html
@@ -429,7 +429,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/mtimer_stop.html b/proc/mtimer_stop.html
@@ -180,7 +180,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~23"></span>
+              <span class="anchor" id="variable-nloops~11"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -621,7 +621,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/mtimer_write.html b/proc/mtimer_write.html
@@ -421,7 +421,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/otimer_start.html b/proc/otimer_start.html
@@ -659,7 +659,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/otimer_stop.html b/proc/otimer_stop.html
@@ -300,7 +300,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~22"></span>
+              <span class="anchor" id="variable-nloops~10"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -746,7 +746,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/otimer_write.html b/proc/otimer_write.html
@@ -542,7 +542,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/print_time.html b/proc/print_time.html
@@ -956,7 +956,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/timer_start.html b/proc/timer_start.html
@@ -454,7 +454,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/timer_stop.html b/proc/timer_stop.html
@@ -180,7 +180,7 @@ <h3>Arguments</h3>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-nloops~20"></span>
+              <span class="anchor" id="variable-nloops~8"></span>
               integer,
             </td>
 <td>intent(in),</td>
@@ -645,7 +645,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/timer_write.html b/proc/timer_write.html
@@ -436,7 +436,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/proc/to_seconds.html b/proc/to_seconds.html
@@ -473,7 +473,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>

diff --git a/program/example1.html b/program/example1.html
@@ -114,7 +114,7 @@ <h4 class="card-header bg-primary text-white">Variables</h4>
       </a>
       <div id="vars-0" class="collapse">
         <div class="list-group list-group-flush">
-            <a class="list-group-item" href="../program/example1.html#variable-t~22">t</a>
+            <a class="list-group-item" href="../program/example1.html#variable-t~31">t</a>
         </div>
       </div>
     </div>
@@ -451,7 +451,7 @@ <h2>Variables</h2>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-t~22"></span>
+              <span class="anchor" id="variable-t~31"></span>
               type(<a href='../type/timer.html'>timer</a>)
             </td>
             <td>
@@ -516,7 +516,7 @@ <h2 id="src">Source Code</h2>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-04-22T07:59:36.386628             </p>
+ on 2024-04-22T08:06:45.443687             </p>
           </div>
         </div>
         <br>