CFD-DEM Pneumatic Conveying Example (chaos-polymtl#1178)

Description
This example is a small case of dense pneumatic conveying using CFD-DEM unresolved.
The insertion uses the plane insertion, solid objects and the adaptive sparse contacts method.
The pneumatic conveying is simulated using the CFD and DEM periodic boundary conditions and a flow controller.


Co-authored-by: Amishga Alphonius <107414376+AmishgaAlphonius@users.noreply.github.com>
Co-authored-by: Bruno Blais <blais.bruno@gmail.com>
Former-commit-id: b5fdce1

.github/PULL_REQUEST_TEMPLATE/pull_request_template_example.md

@@ -21,7 +21,8 @@ Code related list:
 - [ ] Lethe documentation is up to date
 - [ ] The branch is rebased onto master
 - [ ] Code is indented with indent-all and .prm files (examples and tests) with prm-indent
-- [ ] Links are added to parent .rst files.
+- [ ] Links are added to parent .rst files
+- [ ] The example is following the [standard format](https://chaos-polymtl.github.io/lethe/documentation/contributing.html#general-rules-and-format)
 
 Pull request related list:
 - [ ] Labels are applied

contrib/utilities/check_parameter_files_in_examples.sh

@@ -45,8 +45,9 @@ lethe_fluid_particles=("examples/unresolved-cfd-dem")
 for folder in ${lethe_fluid_particles[@]}; do
   for file in $(find "$folder" -type f -name "*.prm"); do
     echo $file
-    # If generator is in the file name this is a lethe-particles file
-    if [[ "$file" == *"generator"* ]];then
+    # If "particles" is in the filename this is a
+    # lethe-particles file
+    if [[ "$file" == *"particles"* ]];then
         lethe-parameter-check $file lethe-particles
     #else we assume it's a CFD-DEM file
     else

doc/source/examples/unresolved-cfd-dem/boycott-effect/boycott-effect.rst

@@ -20,8 +20,8 @@ Files Used in This Example
 
 Both files mentioned below are located in the example's folder (``examples/unresolved-cfd-dem/boycott-effect``).
 
+- Parameter file for initial particles generation: ``initial-particles.prm``
 - Parameter file for CFD-DEM simulation of the Boycott effect: ``boycott-effect.prm``
-- Parameter file for particle generation and packing: ``particle_generator.prm``
 
 
 -----------------------
@@ -37,7 +37,7 @@ DEM Parameter File
 
 The syntax of this parameter file is flexible. Parameters do not need to be specified in a specific order, but only within the subsection in which they belong. All parameter subsections are described in the `parameter section <../../../parameters/parameters.html>`_ of the documentation.
 
-We introduce the different sections of the parameter file ``dem-packing-in-fluidized-bed.prm`` needed to run this simulation. Most subsections are explained in detail in other CFD-DEM examples such as:  `Gas-solid spouted bed <../../../examples/unresolved-cfd-dem/gas-solid-spouted-bed/gas-solid-spouted-bed.html>`_. Therefore, we will not go over them in detail.
+We introduce the different sections of the parameter file ``boycott-effect.prm`` needed to run this simulation. Most subsections are explained in detail in other CFD-DEM examples such as:  `Gas-solid spouted bed <../../../examples/unresolved-cfd-dem/gas-solid-spouted-bed/gas-solid-spouted-bed.html>`_. Therefore, we will not go over them in detail.
 
 Mesh
 ~~~~~
@@ -157,16 +157,16 @@ Launching the simulation is as simple as specifying the executable name and the
 .. code-block:: text
   :class: copy-button
 
-  lethe-particles particle-generator.prm
+  lethe-particles initial-particles.prm
 
 or in parallel (where 8 represents the number of processors)
 
 .. code-block:: text
   :class: copy-button
 
-  mpirun -np 8 lethe-particles particle-generator.prm
+  mpirun -np 8 lethe-particles initial-particles.prm
 
-The figure below shoes the particles inserted at the top of the channel at the end of the DEM simulation.
+The figure below shows the particles inserted at the top of the channel at the end of the DEM simulation.
 
 .. image:: images/packing.png
     :alt: inserted particles at the top of the channel

doc/source/examples/unresolved-cfd-dem/cylindrical-packed-bed/cylindrical-packed-bed.rst

@@ -11,6 +11,7 @@ Features
 
 - Solvers: ``lethe-particles`` and ``lethe-fluid-vans``
 - Three-dimensional problem
+- Uses the VANS solver without the coupling with DEM
 - Displays the selection of models and physical properties
 
 
@@ -20,8 +21,8 @@ Files Used in This Example
 
 Both files mentioned below are located in the example's folder (``examples/unresolved-cfd-dem/cylindrical-packed-bed``).
 
-- Parameter file for CFD-DEM simulation of the packed bed: ``cylindrical-packed-bed/flow-in-bed.prm``
-- Parameter file for particle generation and packing: ``packing-in-cylinder.prm``
+- Parameter file for particle generation and packing: ``packing-particles.prm``
+- Parameter file for CFD-DEM simulation of the packed bed: ``flow-in-bed.prm``
 
 
 -----------------------
@@ -35,7 +36,8 @@ This example simulates air flow through a packing of particles. First, we use ``
 DEM Parameter File
 -------------------
 
-All parameter subsections are described in the `parameter section <../../../parameters.html>`_ of the documentation. To set-up the cylindrical packed bed case, we first fill the bed with particles. We introduce the different sections of the parameter file (``packing-in-cylinder.prm)`` needed to run this simulation. 
+All parameter subsections are described in the `parameter section <../../../parameters.html>`_ of the documentation. To set-up the cylindrical packed bed case, we first fill the bed with particles. We introduce the different sections of the parameter file (``packing-particles.prm``) needed to run this simulation.
+
 
 Mesh
 ~~~~~
@@ -181,14 +183,14 @@ Launching the simulation is as simple as specifying the executable name and the
 .. code-block:: text
   :class: copy-button
 
-  lethe-particles packing-in-circle.prm
+  lethe-particles packing-particles.prm
 
 or in parallel (where 8 represents the number of processors)
 
 .. code-block:: text
   :class: copy-button
 
-  mpirun -np 8 lethe-particles packing-in-circle.prm
+  mpirun -np 8 lethe-particles packing-particles.prm
 
 Lethe will generate a number of files. The most important one bears the extension ``.pvd``. It can be read by popular visualization programs such as `Paraview <https://www.paraview.org/>`_.