Skip to content

Commit 96197a4

Browse files
SerhiiSerhii
Serhii
authored and
Serhii
committed
Fix doxygen OdeInt examples; Group OdeInt examples into one section
1 parent e30ec71 commit 96197a4

5 files changed

Lines changed: 57 additions & 50 deletions

File tree

‎example/Numerics/OdeInt/Advection-Diffusion/main.cpp‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* * We can use the Odeint library from boost with OpenFPM in two ways. The first example will cover a simple case where we control the time stepping ourselves (time loop of the simulation wriiten by us).
99
* The 2nd Example will cover a way of using odeint where the time is forwarded by odeint along with an observer.
1010
*
11-
* * In the example links below, we solve the follwing advection-diffusion PDE for two chemicals with concentration \f$\vec{C}(x,y,t)=(C_x(x,y,t),C_y(x,y,t))\f$ with a fixed velocity \f$\vec{V}(x,y)=(-ye^{-10(x^2+y^2)},xe^{-10(x^2+y^2)})\f$:
11+
* * In the example links below, we solve the follwing advection-diffusion PDE for two chemicals with concentration \f$(x_1,y_1)\f$ \f$\vec{C}(x,y,t)=(C_x(x,y,t),C_y(x,y,t))\f$ with a fixed velocity \f$\vec{V}(x,y)=(-ye^{-10(x^2+y^2)},xe^{-10(x^2+y^2)})\f$:
1212
*
1313
* @f[ \frac{\partial\vec{C}}{dt}=\vec{V}.\nabla_{\{x,y\}} \vec{C} + 0.1\Delta_{\{x,y\}} \vec{C} @f]
1414
* in 2d domain [-1,-1]*[1,1] with the boundary conditions on the walls as no-slip for velocity \f$\vec{V}=0\f$ and sink for the chemicals \f$\vec{C}=0\f$ for all time \f$t\f$.
@@ -22,6 +22,10 @@
2222
*
2323
* @subpage Odeint_single_step
2424
* @subpage Odeint_multiple_steps
25+
* @subpage Numerics_Odeint_SPH
26+
* @subpage Numerics_expression_SPH
27+
* @subpage Numerics_Odeint_SPH_GPU
28+
* @subpage Numerics_expression_SPH_GPU
2529
*
2630
*
2731
*/

‎example/Numerics/OdeInt/SPH_dlb/main.cpp‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
/*!
2-
* \page Numerics expression SPH Dam break simulation with Dynamic load balacing
2+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
33
*
44
*
55
* [TOC]
66
*
77
*
8-
* # Numerics expression SPH Dam break simulation with Dynamic load balacing # {#SPH_dlb}
98
*
109
*
1110
* This example show the classical SPH Dam break simulation with Load Balancing and Dynamic load balancing. With
@@ -69,7 +68,7 @@
6968
//! \cond [inclusion] \endcond
7069

7170
/*!
72-
* \page SPH_dlb Numerics expression SPH Dam break simulation with Dynamic load balacing
71+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
7372
*
7473
* ## SPH simulation {#sph_expression_parameters}
7574
*
@@ -256,7 +255,7 @@ struct ModelCustom
256255
/*! \cond [model custom] \endcond */
257256

258257
/*!
259-
* \page SPH_dlb Numerics expression SPH Dam break simulation with Dynamic load balacing
258+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
260259
*
261260
* ### Equation of state {#sph_expression_equation_state}
262261
*
@@ -290,7 +289,7 @@ inline void EqState(vector_dist_type & vectorDist)
290289
/*! \cond [eq_state_and_ker] \endcond */
291290

292291
/*!
293-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
292+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
294293
*
295294
* ### Cubic SPH kernel and derivatives {#sph_expression_kernel}
296295
*
@@ -322,7 +321,7 @@ inline double Wab(double r)
322321
/*! \cond [kernel_sph] \endcond */
323322

324323
/*!
325-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
324+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
326325
*
327326
* This function define the gradient of the Cubic kernel function \f$ W_{ab} \f$.
328327
*
@@ -365,7 +364,7 @@ inline void DWab(Point<3,double> & dx, Point<3,double> & DW, double r, bool prin
365364
/*! \cond [kernel_sph_der] \endcond */
366365

367366
/*!
368-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
367+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
369368
*
370369
* ### Tensile correction {#sph_expression_tensile}
371370
*
@@ -417,7 +416,7 @@ inline double Tensile(double r, double rhoa, double rhob, double prs1, double pr
417416

418417
/*!
419418
*
420-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
419+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
421420
*
422421
* ### Viscous term {#sph_expression_viscous}
423422
*
@@ -452,7 +451,7 @@ inline double Pi(const Point<3,double> & dr, double rr2, Point<3,double> & dv, d
452451

453452
/*!
454453
*
455-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
454+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
456455
*
457456
* ### Force calculation {#e7_force_calc}
458457
*
@@ -614,7 +613,7 @@ template<typename CellList> inline void calc_forces(vector_dist_type & vectorDis
614613

615614
/*!
616615
*
617-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
616+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
618617
*
619618
* ### Integration and dynamic time integration {#e7_delta_time_t}
620619
*
@@ -664,7 +663,7 @@ void max_acceleration_and_velocity(vector_dist_type & vectorDist, double & max_a
664663

665664
/*!
666665
*
667-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
666+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
668667
*
669668
* In this example we are using Dynamic time-stepping. The Dynamic time stepping is
670669
* calculated with the Courant-Friedrich-Lewy condition. See Monaghan 1992 "Smoothed Particle Hydrodynamic"
@@ -709,7 +708,7 @@ double calc_deltaT(vector_dist_type & vectorDist, double ViscDtMax)
709708

710709
/*!
711710
*
712-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
711+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
713712
*
714713
* This function perform verlet integration accordingly to the Verlet time stepping scheme
715714
*
@@ -899,7 +898,7 @@ void euler_int(vector_dist_type & vectorDist, double dt)
899898

900899
/*!
901900
*
902-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
901+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
903902
*
904903
* ### Probes/sensors {#sph_expression_prob_sens}
905904
*
@@ -1002,7 +1001,7 @@ int main(int argc, char* argv[])
10021001
{
10031002
/*!
10041003
*
1005-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1004+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
10061005
*
10071006
* ## Main function {#sph_expression_main}
10081007
*
@@ -1043,7 +1042,7 @@ int main(int argc, char* argv[])
10431042
//! \cond [Initialization and parameters] \endcond
10441043

10451044
/*!
1046-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1045+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
10471046
*
10481047
* ### Vector create {#sph_expression_vcreate}
10491048
*
@@ -1084,7 +1083,7 @@ int main(int argc, char* argv[])
10841083
//! \cond [vector inst] \endcond
10851084

10861085
/*!
1087-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1086+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
10881087
*
10891088
* ### Draw particles and initialization ## {#sph_expression_draw_part_init}
10901089
*
@@ -1172,7 +1171,7 @@ int main(int argc, char* argv[])
11721171
//! \cond [draw fluid] \endcond
11731172

11741173
/*!
1175-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1174+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
11761175
*
11771176
* ### Draw Recipient ###
11781177
*
@@ -1234,7 +1233,7 @@ int main(int argc, char* argv[])
12341233
//! \cond [draw recipient] \endcond
12351234

12361235
/*!
1237-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1236+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
12381237
*
12391238
* ### Draw Obstacle ###
12401239
*
@@ -1280,7 +1279,7 @@ int main(int argc, char* argv[])
12801279
//! \cond [draw obstacle] \endcond
12811280

12821281
/*!
1283-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1282+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
12841283
*
12851284
* ## Load balancing and Dynamic load balancing ##
12861285
*
@@ -1378,7 +1377,7 @@ int main(int argc, char* argv[])
13781377
// Evolve
13791378

13801379
/*!
1381-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1380+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
13821381
*
13831382
* ## Main Loop ##
13841383
*
@@ -1475,7 +1474,7 @@ int main(int argc, char* argv[])
14751474

14761475
/*!
14771476
*
1478-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1477+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
14791478
*
14801479
* ## Finalize ## {#finalize_e0_sim}
14811480
*
@@ -1493,7 +1492,7 @@ int main(int argc, char* argv[])
14931492
//! \cond [finalize] \endcond
14941493

14951494
/*!
1496-
* \page Numerics expression SPH Dam break simulation with Dynamic load balancing
1495+
* \page Numerics_expression_SPH Numerics expression SPH dam break simulation
14971496
*
14981497
* ## Full code ## {#code_sph_expression_dlb}
14991498
*

0 commit comments

Comments
 (0)