Skip to content

Commit

Permalink
Deploying to gh-pages from @ 2e3ed44 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
gha3mi committed Apr 22, 2024
1 parent f143456 commit d77ba75
Show file tree
Hide file tree
Showing 100 changed files with 354 additions and 354 deletions.
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h2>fpm dependency</h2>
</code></pre></div>

<h2>Usage</h2>
<h3>Measuring elapsed time</h3>
<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>
Expand All @@ -120,7 +120,7 @@ <h3>Measuring elapsed time (date_and_time)</h3>
<span class="k">call </span><span class="n">t</span><span class="p">%</span><span class="n">dtimer_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>

<h3>Measuring CPU time</h3>
<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>
Expand All @@ -132,7 +132,7 @@ <h3>Measuring CPU time</h3>
<span class="k">call </span><span class="n">t</span><span class="p">%</span><span class="n">ctimer_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>

<h3>Measuring OpenMP (OMP) time</h3>
<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>
Expand All @@ -145,7 +145,7 @@ <h3>Measuring OpenMP (OMP) time</h3>
</code></pre></div>

<p><strong>Note:</strong> Ensure you compile with the <code>-DUSE_OMP</code> option when using the OpenMP timer.</p>
<h3>Measuring MPI time</h3>
<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>
Expand Down Expand Up @@ -270,7 +270,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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/procedures.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/programs.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
12 changes: 6 additions & 6 deletions module/fortime.html
Original file line number Diff line number Diff line change
Expand Up @@ -1563,7 +1563,7 @@ <h4>Arguments</h4>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops"></span>
<span class="anchor" id="variable-nloops~20"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -1754,7 +1754,7 @@ <h4>Arguments</h4>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~2"></span>
<span class="anchor" id="variable-nloops~21"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -1945,7 +1945,7 @@ <h4>Arguments</h4>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~3"></span>
<span class="anchor" id="variable-nloops~22"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -2136,7 +2136,7 @@ <h4>Arguments</h4>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~4"></span>
<span class="anchor" id="variable-nloops~23"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -2327,7 +2327,7 @@ <h4>Arguments</h4>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~5"></span>
<span class="anchor" id="variable-nloops~24"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/ctimer_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions proc/ctimer_stop.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h3>Arguments</h3>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~2"></span>
<span class="anchor" id="variable-nloops~21"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/ctimer_write.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/dtimer_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions proc/dtimer_stop.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h3>Arguments</h3>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~5"></span>
<span class="anchor" id="variable-nloops~24"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/dtimer_write.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/mtimer_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions proc/mtimer_stop.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h3>Arguments</h3>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~4"></span>
<span class="anchor" id="variable-nloops~23"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/mtimer_write.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/otimer_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions proc/otimer_stop.html
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ <h3>Arguments</h3>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops~3"></span>
<span class="anchor" id="variable-nloops~22"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/otimer_write.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/print_time.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/timer_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions proc/timer_stop.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h3>Arguments</h3>
</tr>
<tr>
<td>
<span class="anchor" id="variable-nloops"></span>
<span class="anchor" id="variable-nloops~20"></span>
integer,
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/timer_write.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion proc/to_seconds.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion program/example1.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion program/example2.html
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions program/example3.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/example3.html#variable-t~7">t</a>
<a class="list-group-item" href="../program/example3.html#variable-t~3">t</a>
</div>
</div>
</div>
Expand Down Expand Up @@ -451,7 +451,7 @@ <h2>Variables</h2>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-t~7"></span>
<span class="anchor" id="variable-t~3"></span>
type(<a href='../type/timer.html'>timer</a>)
</td>
<td>
Expand Down Expand Up @@ -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:56:54.434744 </p>
on 2024-04-22T07:59:36.386628 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit d77ba75

Please sign in to comment.