Skip to content

Commit

Permalink
clean whitespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
SAutum committed Oct 5, 2023
1 parent d060bf7 commit 02644f4
Showing 1 changed file with 12 additions and 67 deletions.
79 changes: 12 additions & 67 deletions doc/examples.dox
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
* As a result, the output VTK file displays the phrase 'Hello World' by the
* mesh refinement.
*
<<<<<<< HEAD
* Usage may be one of:
*
* > `p4est_step1`
Expand All @@ -59,21 +58,9 @@
* * Maximum refinement level: 6
*
* \image html HW.png
=======
* Usage:
* > `p4est_step1`
* * No. of trees: 1
* * Maximum no. of level: 6
* \htmlonly
* <div class="div">
* <img class="image" src="HW.png" alt="Hello World">
* </div>
* \endhtmlonly
>>>>>>> 5202ecfc (enrich documentations of example page)
*
* ### The historic simple example
*
<<<<<<< HEAD
* Another illustrative example can be found in \ref simple/simple2.c.
* The refinement pattern is generated by some hardcoded prescriptions based
* on a quadrant's tree number, refinement level and coordinates.
Expand All @@ -83,11 +70,6 @@
* of several available geometries specified on the command line.
* As a result, the output VTK files document all
* the steps of the mesh manipulation process.
=======
* This program creates/refines & coarsen/balances/partitions a internally
* predefined geometry. As a result, the output VTK files display all
* the steps of the mesh manipulation process. Here are some typical examples
* that might be interesting.
*
* * Example: periodic
*
Expand All @@ -96,28 +78,13 @@
*
* Usage:
* > `p4est_simple periodic 5`
* or with mpi:
* or with MPI:
* > `mpirun -np 4 p4est_simple periodic 5`
*
* * No. of trees: 1
* * Maximum no. of level: 5
* \htmlonly
* <style>
* .div{
* align-items: flex-start;
* display: flex;
* justify-content: center;
* }
* .image{
* width:20%;
* margin: 4em;
* }
* </style>
* <div class="div">
* <img class="image" src="periodic_nodes.png" alt="periodic: nodes">
* <img class="image" src="periodic_balanced_lv5.png" alt="periodic: levels">
* </div>
* \endhtmlonly
>>>>>>> 5202ecfc (enrich documentations of example page)
* * Maximum refinement level: chosen on the command line as 5
*
* \image html periodic_balanced_lv5.png
*
* * Example: circle
*
Expand All @@ -133,19 +100,9 @@
* > `mpirun -np 4 p4est_simple circle 5`
*
* * No. of trees: 6
<<<<<<< HEAD
* * Maximum refinement level: chosen on the command line as 5
*
* \image html circle_balanced_lv5.png
=======
* * Maximum no. of level: 5
* \htmlonly
* <div class="div">
* <img class="image" src="circle_nodes.png" alt="circle: nodes">
* <img class="image" src="circle_balanced_lv5.png" alt="circle: levels">
* </div>
* \endhtmlonly
>>>>>>> 5202ecfc (enrich documentations of example page)
*
* * Example: drop
*
Expand All @@ -158,34 +115,22 @@
* > `mpirun -np 7 p4est_simple drop 5`
*
* * No. of trees: 5
<<<<<<< HEAD
* * Maximum no. of level: chosen on the command line as 5
=======
* * Maximum no. of level: 5
* \htmlonly
* <div class="div">
* <img class="image" src="drop_nodes.png" alt="drop: nodes">
* <img class="image" src="drop_balanced_lv5.png" alt="drop: levels">
* </div>
* \endhtmlonly
* * Maximum refinement level: chosen on the command line as 5
* \image html drop_balanced_lv5.png
*
* * Example: moebius
>>>>>>> 5202ecfc (enrich documentations of example page)
*
* Create a connectivity structure for a five-tree moebius band.
*
* Usage:
* > `p4est_simple moebius 5`
* or with mpi:
* or with MPI:
* > `mpirun -np 4 p4est_simple moebius 5`
*
* * No. of trees: 5
* * Maximum no. of level: 5
* \htmlonly
* <div class="div">
* <img class="image" src="moebius_balanced_lvs.png" alt="moebius: trees">
* <img class="image" src="moebius_balanced_lv5.png" alt="moebius: levels">
* </div>
* \endhtmlonly
* * Maximum refinement level: chosen on the command line as 5
*
* \image html moebius_balanced_lv5.png
*/

/** \example steps/p4est_step1.c
Expand Down

0 comments on commit 02644f4

Please sign in to comment.