summaryrefslogtreecommitdiff
path: root/src/Coxeter_triangulation/doc
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-11-17 11:45:32 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-11-17 11:45:32 +0100
commitf16921c170dee7a7f987afcfa5de923ac8d37dd5 (patch)
tree788299daa5068cac75019c91f33151b26add2d15 /src/Coxeter_triangulation/doc
parent1d7c18e91a73a539e807d323a47d32bbba18dac7 (diff)
Some doxygen improvements with a cell complex construction basic example
Diffstat (limited to 'src/Coxeter_triangulation/doc')
-rw-r--r--src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h15
1 files changed, 13 insertions, 2 deletions
diff --git a/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h b/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
index 5eb0cb22..3316bd81 100644
--- a/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
+++ b/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
@@ -196,20 +196,31 @@ the vertex cells in the cell complex to their Cartesian coordinates.
\section example Examples
+\subsection examplewithoutboundaries Basic example without boundaries
+\include Coxeter_triangulation/cell_complex_from_basic_circle_manifold.cpp
+
+The program output is:
+
+\include Coxeter_triangulation/cell_complex_from_basic_circle_manifold_for_doc.txt
+
+\subsection exampleswithboundaries Example with boundaries
+
Here is an example of constructing a piecewise-linear approximation of a flat torus embedded in \f$\mathbb{R}^4\f$,
rotated by a random rotation in \f$\mathbb{R}^4\f$ and cut by a hyperplane.
\include Coxeter_triangulation/manifold_tracing_flat_torus_with_boundary.cpp
-The output in medit is:
+The output in <a target="_blank" href="https://www.ljll.math.upmc.fr/frey/software.html">medit</a> is:
\image html "flat_torus_with_boundary.png" "Output from the example of a flat torus with boundary"
+\subsection exampleswithcustomfunction Example with a custom function
+
In the following more complex example, we define a custom function for the implicit manifold.
\include Coxeter_triangulation/manifold_tracing_custom_function.cpp
-The output in medit looks as follows:
+The output in <a target="_blank" href="https://www.ljll.math.upmc.fr/frey/software.html">medit</a> looks as follows:
\image html "custom_function.png" "Output from the example with a custom function"