Skip to content

Commit

Permalink
Deploying to gh-pages from @ e7bfe64 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
blaisb committed Jul 12, 2024
1 parent 51cf063 commit db49941
Show file tree
Hide file tree
Showing 713 changed files with 22,283 additions and 20,497 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Physical Properties
where :math:`F_B` denotes the buoyant force source term, :math:`\beta` is the thermal expansion coefficient, :math:`T` is temperature, and :math:`T_\text{ref}` is the reference temperature. This is only used when a constant thermal expansion model is used.

* The ``tracer diffusivity model`` specifies the model used to calculate the tracer diffusivity. At the moment, only a constant tracer diffusivity is supported.
* The ``tracer diffusivity model`` specifies the model used to calculate the tracer diffusivity. At the moment, a constant tracer diffusivity and level set based :math:`\tanh` model are supported. The ``immersed solid tanh`` model is intended to be used with immersed solids with the ``lethe-fluid-sharp`` executable as a way to set diffusivity inside solids as well (described more in `Immersed Solid Models`_).

* The ``tracer diffusivity`` parameter is the diffusivity coefficient of the tracer in units of :math:`\text{Length}^{2} \cdot \text{Time}^{-1}` . In SI, this is :math:`\text{m}^{2} \cdot \text{s}^{-1}`.

Expand Down Expand Up @@ -226,6 +226,42 @@ Conjugate heat transfer enables the addition of solid regions in which the fluid
end
end
.. _immersed solid models:

Immersed Solid Models
~~~~~~~~~~~~~~~~~~~~~~

Immersed solid models can be used to affect specific behavior to immersed solids when ``lethe-fluid-sharp`` is used. At the moment, such a model is only available for the ``tracer`` multiphysics, but additional physics will be included in the future.

The immersed solid properties models are based on the signed distance function of the immersed solids, and therefore depend on the depth inside the solid. The intent behind these models is to define physical properties in the fluid and solid phases as well as in the transition regions.

The ``tracer diffusivity model`` parameter sets which diffusivity model is used. The default model is ``constant``, which uses a constant ``tracer diffusivity``. The alternative is ``immersed solid tanh``, whose parameters are defined as such, with :math:`D` being the tracer diffusivity (outside and inside), :math:`\lambda` being signed distance and :math:`t` the thickness of the transition zone between both diffusivity values:

.. math::
D(\lambda) = D_\text{inside} + \left(D_\text{outside} - D_\text{inside}\right) \left( 0.5 + 0.5 \tanh \left(\frac{\lambda}{t}\right)\right)
.. code-block:: text
subsection physical properties
set number of fluids = 1
subsection fluid 0
set kinematic viscosity = 0.01
set tracer diffusivity model = immersed solid tanh
subsection immersed solid tanh
set tracer diffusivity inside = 1
set tracer diffusivity outside = 1
set thickness = 1
end
end
end
* The ``tracer diffusivity inside`` parameter represents the desired diffusivity inside of the solid.

* The ``tracer diffusivity outside`` parameter represents the desired diffusivity outside of the solid.

* The ``thickness`` parameter represents thickness of the applied :math:`\tanh` function.

.. _rheological_models:

Rheological Models
Expand Down
Binary file modified documentation/objects.inv
Binary file not shown.
54 changes: 42 additions & 12 deletions documentation/parameters/cfd/physical_properties.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion documentation/searchindex.js

Large diffs are not rendered by default.

152 changes: 77 additions & 75 deletions doxygen/annotated.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doxygen/auxiliary__physics_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@
<div class="ttc" id="aparameters_8h_html"><div class="ttname"><a href="parameters_8h.html">parameters.h</a></div></div>
<div class="ttc" id="aphysics__solver_8h_html"><div class="ttname"><a href="physics__solver_8h.html">physics_solver.h</a></div></div>
<div class="ttc" id="asimulation__parameters_8h_html"><div class="ttname"><a href="simulation__parameters_8h.html">simulation_parameters.h</a></div></div>
<div class="ttc" id="astructParameters_1_1MultipleAdaptationParameters_html"><div class="ttname"><a href="structParameters_1_1MultipleAdaptationParameters.html">Parameters::MultipleAdaptationParameters</a></div><div class="ttdoc">Mesh Adaptation Parameters that can differ for each refinement variable.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l01278">parameters.h:1279</a></div></div>
<div class="ttc" id="astructParameters_1_1NonLinearSolver_html"><div class="ttname"><a href="structParameters_1_1NonLinearSolver.html">Parameters::NonLinearSolver</a></div><div class="ttdoc">NonLinearSolver - Parameter that controls the solution of the non-linear problems.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l00985">parameters.h:986</a></div></div>
<div class="ttc" id="astructParameters_1_1MultipleAdaptationParameters_html"><div class="ttname"><a href="structParameters_1_1MultipleAdaptationParameters.html">Parameters::MultipleAdaptationParameters</a></div><div class="ttdoc">Mesh Adaptation Parameters that can differ for each refinement variable.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l01304">parameters.h:1305</a></div></div>
<div class="ttc" id="astructParameters_1_1NonLinearSolver_html"><div class="ttname"><a href="structParameters_1_1NonLinearSolver.html">Parameters::NonLinearSolver</a></div><div class="ttdoc">NonLinearSolver - Parameter that controls the solution of the non-linear problems.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l01011">parameters.h:1012</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/cahn__hilliard_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@
<div class="ttc" id="amultiphysics_8h_html_ae14bb720bc9a37edc36fb8d90df712c2adb9b8e35efba351d474020dd829e49dd"><div class="ttname"><a href="multiphysics_8h.html#ae14bb720bc9a37edc36fb8d90df712c2adb9b8e35efba351d474020dd829e49dd">cahn_hilliard</a></div><div class="ttdeci">@ cahn_hilliard</div><div class="ttdef"><b>Definition:</b> <a href="multiphysics_8h_source.html#l00031">multiphysics.h:30</a></div></div>
<div class="ttc" id="amultiphysics__interface_8h_html"><div class="ttname"><a href="multiphysics__interface_8h.html">multiphysics_interface.h</a></div></div>
<div class="ttc" id="asimulation__control_8h_html"><div class="ttname"><a href="simulation__control_8h.html">simulation_control.h</a></div></div>
<div class="ttc" id="astructParameters_1_1MultipleAdaptationParameters_html"><div class="ttname"><a href="structParameters_1_1MultipleAdaptationParameters.html">Parameters::MultipleAdaptationParameters</a></div><div class="ttdoc">Mesh Adaptation Parameters that can differ for each refinement variable.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l01278">parameters.h:1279</a></div></div>
<div class="ttc" id="astructParameters_1_1MultipleAdaptationParameters_html"><div class="ttname"><a href="structParameters_1_1MultipleAdaptationParameters.html">Parameters::MultipleAdaptationParameters</a></div><div class="ttdoc">Mesh Adaptation Parameters that can differ for each refinement variable.</div><div class="ttdef"><b>Definition:</b> <a href="parameters_8h_source.html#l01304">parameters.h:1305</a></div></div>
<div class="ttc" id="astructParameters_1_1Timer_html_ae1d96ff22b9dbb46d965a0df44142f42a334c4a4c42fdb79d7ebc3e73b517e6f8"><div class="ttname"><a href="structParameters_1_1Timer.html#ae1d96ff22b9dbb46d965a0df44142f42a334c4a4c42fdb79d7ebc3e73b517e6f8">Parameters::Timer::Type::none</a></div><div class="ttdeci">@ none</div></div>
<div class="ttc" id="avector_8h_html"><div class="ttname"><a href="vector_8h.html">vector.h</a></div></div>
<div class="ttc" id="avector_8h_html_a4ea4005d75c88e60bee47d4e79a13a39"><div class="ttname"><a href="vector_8h.html#a4ea4005d75c88e60bee47d4e79a13a39">GlobalVectorType</a></div><div class="ttdeci">dealii::TrilinosWrappers::MPI::Vector GlobalVectorType</div><div class="ttdef"><b>Definition:</b> <a href="vector_8h_source.html#l00031">vector.h:31</a></div></div>
Expand Down
4 changes: 2 additions & 2 deletions doxygen/cahn__hilliard__scratch__data_8cc_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,9 @@
<div class="ttc" id="aclassCahnHilliardScratchData_html_ac916ff90a35a98aaf860fea8a8679100"><div class="ttname"><a href="classCahnHilliardScratchData.html#ac916ff90a35a98aaf860fea8a8679100">CahnHilliardScratchData::calculate_physical_properties</a></div><div class="ttdeci">void calculate_physical_properties()</div><div class="ttdoc">Calculates the physical properties that may be required by the Cahn-Hilliard problem....</div><div class="ttdef"><b>Definition:</b> <a href="cahn__hilliard__scratch__data_8cc_source.html#l00100">cahn_hilliard_scratch_data.cc:100</a></div></div>
<div class="ttc" id="aphysical__properties__manager_8h_html_a3374dca42581d32444eb366feb9f3189afca154035ca3d8f1e45a9b648a2d6ef6"><div class="ttname"><a href="physical__properties__manager_8h.html#a3374dca42581d32444eb366feb9f3189afca154035ca3d8f1e45a9b648a2d6ef6">fluid_fluid</a></div><div class="ttdeci">@ fluid_fluid</div><div class="ttdef"><b>Definition:</b> <a href="physical__properties__manager_8h_source.html#l00053">physical_properties_manager.h:53</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a0b2c854385812ebfac83689a5c3ead58"><div class="ttname"><a href="physical__property__model_8h.html#a0b2c854385812ebfac83689a5c3ead58">field</a></div><div class="ttdeci">field</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00050">physical_property_model.h:51</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a0b2c854385812ebfac83689a5c3ead58a2d397f452fbf87274e898b191306e373"><div class="ttname"><a href="physical__property__model_8h.html#a0b2c854385812ebfac83689a5c3ead58a2d397f452fbf87274e898b191306e373">phase_order_cahn_hilliard_filtered</a></div><div class="ttdeci">@ phase_order_cahn_hilliard_filtered</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00059">physical_property_model.h:58</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a0b2c854385812ebfac83689a5c3ead58a2d397f452fbf87274e898b191306e373"><div class="ttname"><a href="physical__property__model_8h.html#a0b2c854385812ebfac83689a5c3ead58a2d397f452fbf87274e898b191306e373">phase_order_cahn_hilliard_filtered</a></div><div class="ttdeci">@ phase_order_cahn_hilliard_filtered</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00058">physical_property_model.h:58</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a0b2c854385812ebfac83689a5c3ead58a744f7cf7a054452bef69c506e47b4464"><div class="ttname"><a href="physical__property__model_8h.html#a0b2c854385812ebfac83689a5c3ead58a744f7cf7a054452bef69c506e47b4464">phase_order_cahn_hilliard</a></div><div class="ttdeci">@ phase_order_cahn_hilliard</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00057">physical_property_model.h:57</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a545ac73a2b70d10beade7a2ffe30a970"><div class="ttname"><a href="physical__property__model_8h.html#a545ac73a2b70d10beade7a2ffe30a970">set_field_vector</a></div><div class="ttdeci">void set_field_vector(const field &amp;id, const std::vector&lt; double &gt; &amp;data, std::map&lt; field, std::vector&lt; double &gt;&gt; &amp;fields)</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00062">physical_property_model.h:62</a></div></div>
<div class="ttc" id="aphysical__property__model_8h_html_a545ac73a2b70d10beade7a2ffe30a970"><div class="ttname"><a href="physical__property__model_8h.html#a545ac73a2b70d10beade7a2ffe30a970">set_field_vector</a></div><div class="ttdeci">void set_field_vector(const field &amp;id, const std::vector&lt; double &gt; &amp;data, std::map&lt; field, std::vector&lt; double &gt;&gt; &amp;fields)</div><div class="ttdef"><b>Definition:</b> <a href="physical__property__model_8h_source.html#l00063">physical_property_model.h:63</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/classAverageVelocities.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab3721c4ebf1ee463dbad8cdb

<p class="definition">Definition at line <a class="el" href="postprocessing__velocities_8cc_source.html#l00019">19</a> of file <a class="el" href="postprocessing__velocities_8cc_source.html">postprocessing_velocities.cc</a>.</p>

<p class="reference">References <a class="el" href="parameters_8h_source.html#l00847">Parameters::PostProcessing::initial_time</a>.</p>
<p class="reference">References <a class="el" href="parameters_8h_source.html#l00873">Parameters::PostProcessing::initial_time</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/classCahnHilliardScratchData.html
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac916ff90a35a98aaf860fea8

<p class="definition">Definition at line <a class="el" href="cahn__hilliard__scratch__data_8cc_source.html#l00100">100</a> of file <a class="el" href="cahn__hilliard__scratch__data_8cc_source.html">cahn_hilliard_scratch_data.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__properties__manager_8h_source.html#l00053">fluid_fluid</a>, <a class="el" href="physical__property__model_8h_source.html#l00057">phase_order_cahn_hilliard</a>, and <a class="el" href="physical__property__model_8h_source.html#l00062">set_field_vector()</a>.</p>
<p class="reference">References <a class="el" href="physical__properties__manager_8h_source.html#l00053">fluid_fluid</a>, <a class="el" href="physical__property__model_8h_source.html#l00057">phase_order_cahn_hilliard</a>, and <a class="el" href="physical__property__model_8h_source.html#l00063">set_field_vector()</a>.</p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions doxygen/classCarreau.html
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6e4acbd2792c49253a073886

<p class="definition">Definition at line <a class="el" href="rheological__model_8cc_source.html#l00120">120</a> of file <a class="el" href="rheological__model_8cc_source.html">rheological_model.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00176">PhysicalPropertyModel::numerical_jacobian()</a>, and <a class="el" href="physical__property__model_8h_source.html#l00052">shear_rate</a>.</p>
<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00178">PhysicalPropertyModel::numerical_jacobian()</a>, and <a class="el" href="physical__property__model_8h_source.html#l00052">shear_rate</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -700,7 +700,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0be7e200ba43a0e802ccc88d

<p class="definition">Definition at line <a class="el" href="rheological__model_8cc_source.html#l00134">134</a> of file <a class="el" href="rheological__model_8cc_source.html">rheological_model.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00052">shear_rate</a>, and <a class="el" href="physical__property__model_8h_source.html#l00197">PhysicalPropertyModel::vector_numerical_jacobian()</a>.</p>
<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00052">shear_rate</a>, and <a class="el" href="physical__property__model_8h_source.html#l00199">PhysicalPropertyModel::vector_numerical_jacobian()</a>.</p>

</div>
</div>
Expand Down
10 changes: 10 additions & 0 deletions doxygen/classCompositeShape.html
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9c6b28d207300106cacdcf81

<p class="definition">Definition at line <a class="el" href="shape_8cc_source.html#l01545">1545</a> of file <a class="el" href="shape_8cc_source.html">shape.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00059">levelset</a>.</p>

</div>
</div>
<a id="af327cc8d535aa0d552e6435e2e4041a9"></a>
Expand Down Expand Up @@ -521,6 +523,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a51eba9508c6e25da9f27a454

<p class="definition">Definition at line <a class="el" href="shape_8cc_source.html#l01384">1384</a> of file <a class="el" href="shape_8cc_source.html">shape.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00059">levelset</a>.</p>

</div>
</div>
<a id="a5161e87e452ee36b152cb9ed4fd20015"></a>
Expand Down Expand Up @@ -579,6 +583,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5161e87e452ee36b152cb9ed

<p class="definition">Definition at line <a class="el" href="shape_8cc_source.html#l01433">1433</a> of file <a class="el" href="shape_8cc_source.html">shape.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00059">levelset</a>.</p>

</div>
</div>
<a id="ada9e3015addff5c0c2030d66f932d33a"></a>
Expand Down Expand Up @@ -798,6 +804,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab209717d0f58422c5147707c

<p class="definition">Definition at line <a class="el" href="shape_8cc_source.html#l01304">1304</a> of file <a class="el" href="shape_8cc_source.html">shape.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00059">levelset</a>.</p>

</div>
</div>
<a id="ab578847536073bc3aea67aec3e9b3044"></a>
Expand Down Expand Up @@ -856,6 +864,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab578847536073bc3aea67aec

<p class="definition">Definition at line <a class="el" href="shape_8cc_source.html#l01341">1341</a> of file <a class="el" href="shape_8cc_source.html">shape.cc</a>.</p>

<p class="reference">References <a class="el" href="physical__property__model_8h_source.html#l00059">levelset</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
Expand Down
Loading

0 comments on commit db49941

Please sign in to comment.