Skip to content

Commit

Permalink
Deploying to gh-pages from @ 365eb0f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkuhn committed Oct 14, 2024
1 parent fa038c8 commit 074d744
Show file tree
Hide file tree
Showing 23 changed files with 2,015 additions and 1,918 deletions.
2 changes: 1 addition & 1 deletion _sources/doxygen/html/classincflo-members.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::4b77e79c1a5eb9136737cdf4bd05211c42289b3b7bd93695aabc1b0d3deff1ea9bd9016cac1092d0ae00daa6375d42c01bb69f0521f59e80281aef6a217e5e09
.. meta::d088e7f9b6bf863acdac97e53ba051454a3834dffa4961966a32acdd2efbe6e92deea9878a1d29b8177a0340e5832d07453ea9810ccedd6ac727fa07f76e77dc
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/classincflo.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::ab42652673869e7fe9af910cffaa120b508cb200cca70142f09a35f3efa62bb20fd60464eabe5450366d23c06f4ec57102533c8b431a65582a45e6a489ac9788
.. meta::1427878cdf9a0a573f0c7259597a40697d39b586392f01630d4b65df63474946b365bd6d22ed6adfdb038910d74f40478ec4c334341d43532494a9cd4f87cea6
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/functions_c.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::eb2d46ed7e5186a9c85a3d4ee791da4642805557a00d12dd0bc5ebfbb2db319f84ee63e18c365de6770233d6eafd0117750340fdc4f9fa2770f1b7bf09be6c7e
.. meta::a78b51b6728105b77dc728b91d8426285ecb77abdc8553ddea68987e1b0169b384bee02106eb63edd44fe59ad68d32dbdf293f7a9b4ed89dd42a7631fdafcabd
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/functions_func_c.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::ed56dcc95ea144b80e768dea42ac428515c5bcaeb944c608bacb6692c4a4be620b302b6bf58cc95dbbd9b762304b038e30a5391ef556e17a680e9d83736f6bad
.. meta::2779aaefd1545e2b325d00d40f1dc69ef3eb8af2d70aca92c1dc549fe0ff57904afb7db852c265a486e715ed4f57ec8fbd6b0d5a2a0cc3e57e8f146e820fafd4
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/functions_m.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::dbdf0d84be7a86c938b8df5c136c1a5748fb479c786a4601b675fff9e1ed35f07a688e88a228fde845659a3fe9960bb3e55fa44dc714ef48c22baf1a671103c7
.. meta::6ff14c4db5166b4173035b2c9bd990d4ca6b699c7b262feefb330fa8fbeec91c5a7a4832e4127198e5b06bcd67afc938e87e1e5146789ffd97512c4887da2bfb
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/functions_vars_m.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::3aae3eec220c7e5512cc2821a5d30fe08a8e5ef41b97abf8f2635a0809db99cf2b854f24a0cfce7fe9b706526f09166bb605a4b8128040bd93bbda63fd997619
.. meta::59d83d2347d734a268f1cfc6653f85e24f8ba09628a9067b858b3f23e37b23aaf2f528d187ba9936372b893d03279dc2e23b01f143bb109a7d4869fa04c483c2
:orphan:

Expand Down
2 changes: 1 addition & 1 deletion _sources/doxygen/html/incflo_8_h_source.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. meta::110c08cc186f7125dda75c7cceddf027bc514f1c82db3411c19b7099118b32ffb3a92ed47e2439748f55ac794e9415607cfb9fd46e1e30af038cf52cd2e9fda8
.. meta::b1349a360da9a4fd70d10dfe29f9d6fb91c3841f4f0d7a0607238735d1c5a2b205fa7dc09733e0632fcf7bd540a43e12eace4430f27d7cd79dd373682c4081ed
:orphan:

Expand Down
10 changes: 10 additions & 0 deletions _sources/user/inputs_incflo.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,16 @@ as initial conditions and discretization options.
Godunov the default approach and has many advantages over the method of lines (MOL): better accuracy,
stability at larger CFL numbers, and greater computational efficiency. Setting this argument to false is
not recommended, and active use or development relying on the method of lines (MOL) is very sparse.

.. input_param:: incflo.dry_run

**type** Boolean, optional, default = false

Setting this option to true enables a "dry run" of the code. This is intended for checking if an input
file is set up properly and for investigating the initial state of a simulation. A dry run will make sure
that initial iterations and the initial projection are skipped, and it will complete no time steps. This is
to minimize the computational demands of such a run. A plot file with the prefix ``dry_run`` will be output
regardless of whether the simulation restarts from a checkpoint file or from scratch.

.. _inputs_incflo_advection:

Expand Down
46 changes: 24 additions & 22 deletions doxygen/html/classincflo-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,28 +183,30 @@ <h1>Member List<a class="headerlink" href="#member-list" title="Link to this hea
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a0d96f05618e20831e69647d40ed58aab">ApplyPredictor</a>(const bool incremental_projection=false, const int fixed_point_iteration=0)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a13e8fe8a0248347460f295d86c1f89dd">ApplyPrescribeStep</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a1a35093301a8bb6b0aa177f5bb6e3cb9">ApplyProjection</a>(amrex::Vector&lt; amrex::MultiFab const * &gt; density, amrex::Real time, amrex::Real scaling_factor, bool incremental)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#aeb09e92c1c8d1a3f0ef0c504d5d0fdf0">CheckForNans</a>(int lev) const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a18d0dc085fcc4f94806726b8ddd639df">ClearLevel</a>(int lev) override</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#aede73bc339a2796caa043794f5f1d847">ComputeDt</a>(bool explicit_diffusion)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a24c9953c346c266e1e5be73f0ae34667">ComputePrescribeDt</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a13da9c1bd23ab0663ff2e646652503c0">density</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a519aedfea3e6c46ade3eb01eccbaca48">do_advance</a>(const int fixed_point_iteration)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#ab904c076552cbd11927a01cd8809a240">ErrorEst</a>(int lev, amrex::TagBoxArray &amp;tags, amrex::Real time, int ngrow) override</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a0141eeb4fa408c909bca038ec9de0ef5">Evolve</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#afa2cbd9f1e283d3b800fdfa4c38a8f90">Factory</a>(int lev) const noexcept</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a7534758d1108e8269e253807dbaa7b21">grad_p</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a7d76345e4008ce30ebc9a141e021f40d">icns</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#ae2a1f623e51246d406606acfd115aae5">icns</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a19eee8f0b64ec62e33d4f1a43b1d20d3">incflo</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a43cf33c0538fc17484a53d9b1ccc2a64">init_amr_wind_modules</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#aee7bc4ffefd8e4723c7f058dae3ccbc1">init_mesh</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#ac40fe751b2172ccd66d81423ed0ea6ac">init_physics_and_pde</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#ac5176769479be6d215a8a46fe11465a0">InitData</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a407eefb42cf4d26a962fb85a8d81f1e2">InitialIterations</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#ad6c4d735e4da2f63683dfca44d8e4304">InitialProjection</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a8e1646922d344d13318d3944fbeb845e">m_cell_count</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a78e482f65ce01e16c633a717c787a4c5">m_diff_type</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#abbd686bb0a0859d40cd688a04a057580">m_do_initial_proj</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a61079e45c3815c49ffae06eee92a25a4">CheckAndSetUpDryRun</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#aeb09e92c1c8d1a3f0ef0c504d5d0fdf0">CheckForNans</a>(int lev) const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a18d0dc085fcc4f94806726b8ddd639df">ClearLevel</a>(int lev) override</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#aede73bc339a2796caa043794f5f1d847">ComputeDt</a>(bool explicit_diffusion)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a24c9953c346c266e1e5be73f0ae34667">ComputePrescribeDt</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a13da9c1bd23ab0663ff2e646652503c0">density</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a519aedfea3e6c46ade3eb01eccbaca48">do_advance</a>(const int fixed_point_iteration)</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#ab904c076552cbd11927a01cd8809a240">ErrorEst</a>(int lev, amrex::TagBoxArray &amp;tags, amrex::Real time, int ngrow) override</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a0141eeb4fa408c909bca038ec9de0ef5">Evolve</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#afa2cbd9f1e283d3b800fdfa4c38a8f90">Factory</a>(int lev) const noexcept</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a7534758d1108e8269e253807dbaa7b21">grad_p</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a7d76345e4008ce30ebc9a141e021f40d">icns</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#ae2a1f623e51246d406606acfd115aae5">icns</a>() const</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a19eee8f0b64ec62e33d4f1a43b1d20d3">incflo</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a43cf33c0538fc17484a53d9b1ccc2a64">init_amr_wind_modules</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#aee7bc4ffefd8e4723c7f058dae3ccbc1">init_mesh</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#ac40fe751b2172ccd66d81423ed0ea6ac">init_physics_and_pde</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#ac5176769479be6d215a8a46fe11465a0">InitData</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a407eefb42cf4d26a962fb85a8d81f1e2">InitialIterations</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#ad6c4d735e4da2f63683dfca44d8e4304">InitialProjection</a>()</td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a8e1646922d344d13318d3944fbeb845e">m_cell_count</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a78e482f65ce01e16c633a717c787a4c5">m_diff_type</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#abbd686bb0a0859d40cd688a04a057580">m_do_initial_proj</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a28c1c4323d19f004a38be3c9b006d0a9">m_dry_run</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a66fed3317029eaef124d6fa5ef5e4535">m_fixed_point_iterations</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classincflo.html#a5f9b11262dd5dfc86a6debbfc3353e84">m_initial_iterations</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classincflo.html#a27b3801994fbbc6ffbbc3c12592673e1">m_mesh_refiner</a></td><td class="entry"><a class="el" href="classincflo.html">incflo</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
Expand Down
Loading

0 comments on commit 074d744

Please sign in to comment.