Deploying to main from @ AMReX-Codes/amrex@dea2432 🚀

Author: WeiqunZhang

amrex/docs_html/RuntimeParameters.html

@@ -1334,6 +1334,39 @@ <h2>Tiny Profiler<a class="headerlink" href="#tiny-profiler" title="Permalink to
 performance.</p>
 </dd></dl>
 
+<dl class="py data">
+<dt class="sig sig-object py" id="tiny_profiler.enabled">
+<span class="sig-prename descclassname"><span class="pre">tiny_profiler.</span></span><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">true</span></em><a class="headerlink" href="#tiny_profiler.enabled" title="Permalink to this definition"></a></dt>
+<dd><div class="versionadded">
+<p><span class="versionmodified added">New in version 24.09: </span>Runtime parameter <cite>tiny_profiler.enabled`</cite>.</p>
+</div>
+<p>This parameter can be used to disable tiny profiling including
+<code class="code highlight cpp c++ docutils literal highlight-c++"><span class="n">CArena</span><span class="w"></span></code> memory profiling at run time.</p>
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="tiny_profiler.memprof_enabled">
+<span class="sig-prename descclassname"><span class="pre">tiny_profiler.</span></span><span class="sig-name descname"><span class="pre">memprof_enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">true</span></em><a class="headerlink" href="#tiny_profiler.memprof_enabled" title="Permalink to this definition"></a></dt>
+<dd><div class="versionadded">
+<p><span class="versionmodified added">New in version 24.09: </span>Runtime parameter <code class="docutils literal notranslate"><span class="pre">tiny_profiler.memprof_enabled</span></code>.</p>
+</div>
+<p>This parameter can be used to disable <code class="code highlight cpp c++ docutils literal highlight-c++"><span class="n">CArena</span><span class="w"></span></code> memory profiling at
+run time. If <code class="docutils literal notranslate"><span class="pre">tiny_profiler.enabled</span></code> is false, this parameter has no
+effects.</p>
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="tiny_profiler.output_file">
+<span class="sig-prename descclassname"><span class="pre">tiny_profiler.</span></span><span class="sig-name descname"><span class="pre">output_file</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">string</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[empty]</span></em><a class="headerlink" href="#tiny_profiler.output_file" title="Permalink to this definition"></a></dt>
+<dd><div class="versionadded">
+<p><span class="versionmodified added">New in version 24.09: </span>Runtime parameter <code class="docutils literal notranslate"><span class="pre">tiny_profiler.output_file</span></code>.</p>
+</div>
+<p>If this parameter is empty, the output of tiny profiling is dumped on the
+default out stream of AMReX. If it’s not empty, it specifies the file
+name for the output. Note that <code class="docutils literal notranslate"><span class="pre">/dev/null</span></code> is a special name that mean
+a null file.</p>
+</dd></dl>
+
 </section>
 </section>
 

amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf

@@ -1204,3 +1204,35 @@ enabled.
   which are unnecessary for correctness, could potentially degrade the
   performance.
 
+.. py:data:: tiny_profiler.enabled
+   :type: bool
+   :value: true
+
+   .. versionadded:: 24.09
+      Runtime parameter `tiny_profiler.enabled``.
+
+   This parameter can be used to disable tiny profiling including
+   :cpp:`CArena` memory profiling at run time.
+
+.. py:data:: tiny_profiler.memprof_enabled
+   :type: bool
+   :value: true
+
+   .. versionadded:: 24.09
+      Runtime parameter ``tiny_profiler.memprof_enabled``.
+
+   This parameter can be used to disable :cpp:`CArena` memory profiling at
+   run time. If ``tiny_profiler.enabled`` is false, this parameter has no
+   effects.
+
+.. py:data:: tiny_profiler.output_file
+   :type: string
+   :value: [empty]
+
+   .. versionadded:: 24.09
+      Runtime parameter ``tiny_profiler.output_file``.
+
+   If this parameter is empty, the output of tiny profiling is dumped on the
+   default out stream of AMReX. If it's not empty, it specifies the file
+   name for the output. Note that ``/dev/null`` is a special name that mean
+   a null file.