Docs @ 17eb3de

Author: MFC Action

documentation/md_getting-started.html

@@ -212,8 +212,11 @@ <h1><a class="anchor" id="autotoc_md82"></a>
 <summary >
 MacOS</summary>
 <p></p>
-<p>Using <a href="https://brew.sh/">Homebrew</a> you can install the necessary dependencies:</p>
-<div class="fragment"><div class="line">brew install coreutils python cmake fftw hdf5 gcc open-mpi</div>
+<p>Using <a href="https://brew.sh/">Homebrew</a> you can install the necessary dependencies before configuring your environment:</p>
+<div class="fragment"><div class="line">brew install coreutils python cmake fftw hdf5 gcc boost open-mpi</div>
+<div class="line">echo -e &#39;export BOOST_INCLUDE=/opt/homebrew/&#39; | tee -a ~/.bash_profile ~/.zshrc</div>
+<div class="line">. ~/.bash_profile 2&gt;/dev/null || . ~/.zshrc 2&gt;/dev/null</div>
+<div class="line">! [ -z &quot;${BOOST_INCLUDE+x}&quot; ] &amp;&amp; echo &#39;Environment is ready!&#39; || echo &#39;Error: $BOOST_INCLUDE is unset. Please adjust the previous commands to fit with your environment.&#39;</div>
 </div><!-- fragment --><p>They will download the dependencies MFC requires to build itself.</p>
 <p></p>
 </details>

post_process/annotated.html

@@ -141,27 +141,29 @@
 <tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structacoustic__parameters.html" target="_self">acoustic_parameters</a></td><td class="desc">Acoustic source parameters </td></tr>
 <tr id="row_2_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbounds__info.html" target="_self">bounds_info</a></td><td class="desc">Derived type adding beginning (beg) and end bounds info as attributes </td></tr>
 <tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbub__bounds__info.html" target="_self">bub_bounds_info</a></td><td class="desc">Bounds for the bubble dynamic variables </td></tr>
-<tr id="row_4_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfield__position.html" target="_self">field_position</a></td><td class="desc">Derived type adding the field position (fp) as an attribute </td></tr>
-<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structghost__point.html" target="_self">ghost_point</a></td><td class="desc">Ghost Point for Immersed Boundaries </td></tr>
-<tr id="row_6_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structib__patch__parameters.html" target="_self">ib_patch_parameters</a></td><td class="desc"></td></tr>
-<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structic__model__parameters.html" target="_self">ic_model_parameters</a></td><td class="desc">Defines parameters for a Model Patch </td></tr>
-<tr id="row_8_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structic__patch__parameters.html" target="_self">ic_patch_parameters</a></td><td class="desc">Derived type adding initial condition (ic) patch parameters as attributes NOTE: The requirements for the specification of the above parameters are strongly dependent on both the choice of the multicomponent flow model as well as the choice of the patch geometry </td></tr>
-<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structint__bounds__info.html" target="_self">int_bounds_info</a></td><td class="desc">Integer bounds for variables </td></tr>
-<tr id="row_10_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structinteger__field.html" target="_self">integer_field</a></td><td class="desc">Derived type annexing an integer scalar field (SF) </td></tr>
-<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structintegral__parameters.html" target="_self">integral_parameters</a></td><td class="desc">Derived type annexing integral regions </td></tr>
-<tr id="row_12_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__airfoil__ib__var.html" target="_self">mpi_io_airfoil_ib_var</a></td><td class="desc"></td></tr>
-<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__ib__var.html" target="_self">mpi_io_ib_var</a></td><td class="desc"></td></tr>
-<tr id="row_14_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__var.html" target="_self">mpi_io_var</a></td><td class="desc"></td></tr>
-<tr id="row_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structphysical__parameters.html" target="_self">physical_parameters</a></td><td class="desc">Derived type annexing the physical parameters (PP) of the fluids. These include the specific heat ratio function and liquid stiffness function </td></tr>
-<tr id="row_16_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpres__field.html" target="_self">pres_field</a></td><td class="desc">Derived type for bubble variables pb and mv at quadrature nodes (qbmm) </td></tr>
-<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structprobe__parameters.html" target="_self">probe_parameters</a></td><td class="desc">Derived type annexing the flow probe location </td></tr>
-<tr id="row_18_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscalar__field.html" target="_self">scalar_field</a></td><td class="desc">Derived type annexing a scalar field (SF) </td></tr>
-<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsource__spatial__type.html" target="_self">source_spatial_type</a></td><td class="desc">Acoustic source source_spatial pre-calculated values </td></tr>
-<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__bbox.html" target="_self">t_bbox</a></td><td class="desc"></td></tr>
-<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__model.html" target="_self">t_model</a></td><td class="desc"></td></tr>
-<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__ray.html" target="_self">t_ray</a></td><td class="desc"></td></tr>
-<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__triangle.html" target="_self">t_triangle</a></td><td class="desc"></td></tr>
-<tr id="row_24_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvector__field.html" target="_self">vector_field</a></td><td class="desc">Derived type annexing a vector field (VF) </td></tr>
+<tr id="row_4_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structchemistry__parameters.html" target="_self">chemistry_parameters</a></td><td class="desc">Chemistry parameters </td></tr>
+<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfield__position.html" target="_self">field_position</a></td><td class="desc">Derived type adding the field position (fp) as an attribute </td></tr>
+<tr id="row_6_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structghost__point.html" target="_self">ghost_point</a></td><td class="desc">Ghost Point for Immersed Boundaries </td></tr>
+<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structib__patch__parameters.html" target="_self">ib_patch_parameters</a></td><td class="desc"></td></tr>
+<tr id="row_8_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structic__model__parameters.html" target="_self">ic_model_parameters</a></td><td class="desc">Defines parameters for a Model Patch </td></tr>
+<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structic__patch__parameters.html" target="_self">ic_patch_parameters</a></td><td class="desc">Derived type adding initial condition (ic) patch parameters as attributes NOTE: The requirements for the specification of the above parameters are strongly dependent on both the choice of the multicomponent flow model as well as the choice of the patch geometry </td></tr>
+<tr id="row_10_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structint__bounds__info.html" target="_self">int_bounds_info</a></td><td class="desc">Integer bounds for variables </td></tr>
+<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structinteger__field.html" target="_self">integer_field</a></td><td class="desc">Derived type annexing an integer scalar field (SF) </td></tr>
+<tr id="row_12_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structintegral__parameters.html" target="_self">integral_parameters</a></td><td class="desc">Derived type annexing integral regions </td></tr>
+<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__airfoil__ib__var.html" target="_self">mpi_io_airfoil_ib_var</a></td><td class="desc"></td></tr>
+<tr id="row_14_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__ib__var.html" target="_self">mpi_io_ib_var</a></td><td class="desc"></td></tr>
+<tr id="row_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpi__io__var.html" target="_self">mpi_io_var</a></td><td class="desc"></td></tr>
+<tr id="row_16_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structphysical__parameters.html" target="_self">physical_parameters</a></td><td class="desc">Derived type annexing the physical parameters (PP) of the fluids. These include the specific heat ratio function and liquid stiffness function </td></tr>
+<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpres__field.html" target="_self">pres_field</a></td><td class="desc">Derived type for bubble variables pb and mv at quadrature nodes (qbmm) </td></tr>
+<tr id="row_18_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structprobe__parameters.html" target="_self">probe_parameters</a></td><td class="desc">Derived type annexing the flow probe location </td></tr>
+<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscalar__field.html" target="_self">scalar_field</a></td><td class="desc">Derived type annexing a scalar field (SF) </td></tr>
+<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsource__spatial__type.html" target="_self">source_spatial_type</a></td><td class="desc">Acoustic source source_spatial pre-calculated values </td></tr>
+<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspecies__parameters.html" target="_self">species_parameters</a></td><td class="desc">Species parameters </td></tr>
+<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__bbox.html" target="_self">t_bbox</a></td><td class="desc"></td></tr>
+<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__model.html" target="_self">t_model</a></td><td class="desc"></td></tr>
+<tr id="row_24_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__ray.html" target="_self">t_ray</a></td><td class="desc"></td></tr>
+<tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__triangle.html" target="_self">t_triangle</a></td><td class="desc"></td></tr>
+<tr id="row_26_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvector__field.html" target="_self">vector_field</a></td><td class="desc">Derived type annexing a vector field (VF) </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

post_process/annotated_dup.js

@@ -6,6 +6,7 @@ var annotated_dup =
     [ "acoustic_parameters", "structacoustic__parameters.html", "structacoustic__parameters" ],
     [ "bounds_info", "structbounds__info.html", "structbounds__info" ],
     [ "bub_bounds_info", "structbub__bounds__info.html", "structbub__bounds__info" ],
+    [ "chemistry_parameters", "structchemistry__parameters.html", "structchemistry__parameters" ],
     [ "field_position", "structfield__position.html", "structfield__position" ],
     [ "ghost_point", "structghost__point.html", "structghost__point" ],
     [ "ib_patch_parameters", "structib__patch__parameters.html", "structib__patch__parameters" ],
@@ -22,6 +23,7 @@ var annotated_dup =
     [ "probe_parameters", "structprobe__parameters.html", "structprobe__parameters" ],
     [ "scalar_field", "structscalar__field.html", "structscalar__field" ],
     [ "source_spatial_type", "structsource__spatial__type.html", "structsource__spatial__type" ],
+    [ "species_parameters", "structspecies__parameters.html", "structspecies__parameters" ],
     [ "t_bbox", "structt__bbox.html", null ],
     [ "t_model", "structt__model.html", "structt__model" ],
     [ "t_ray", "structt__ray.html", null ],