diff --git a/doc/Doxyfile b/doc/Doxyfile index b3f44e72..7f10e4b7 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -822,8 +822,7 @@ WARN_LOGFILE = INPUT = $(pFlow_PROJECT_DIR)/src \ $(pFlow_PROJECT_DIR)/utilities \ $(pFlow_PROJECT_DIR)/solvers \ - mdDocs \ - $(pFlow_PROJECT_DIR)/tutorials + mdDocs # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1217,7 +1216,7 @@ HTML_EXTRA_FILES = # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_HUE = 134 +HTML_COLORSTYLE_HUE = 200 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A @@ -1264,7 +1263,7 @@ HTML_DYNAMIC_MENUS = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_DYNAMIC_SECTIONS = NO +HTML_DYNAMIC_SECTIONS = YES # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand diff --git a/doc/customdoxygen.css b/doc/customdoxygen.css index 5fb8b70b..cb6360d7 100644 --- a/doc/customdoxygen.css +++ b/doc/customdoxygen.css @@ -21,14 +21,16 @@ font-size: 220%; } + #projectname a { + text-decoration: none; color: rgba(0, 0, 0, 0.75); } #projectname a:hover, #projectbrief a:hover { - text-decoration: none; + text-decoration: underline; color: rgba(0, 0, 0, 1); } diff --git a/doc/header.html b/doc/header.html index 8b5679d8..99e9f949 100644 --- a/doc/header.html +++ b/doc/header.html @@ -28,10 +28,10 @@ $extrastylesheet -
$projectname -  $projectnumber +
$projectname +  $projectnumber
-
$projectbrief
+
$projectbrief
diff --git a/doc/mdDocs/howToUsePhasicFlow.md b/doc/mdDocs/howToUsePhasicFlow.md index ca8e69db..e33e9c94 100644 --- a/doc/mdDocs/howToUsePhasicFlow.md +++ b/doc/mdDocs/howToUsePhasicFlow.md @@ -2,4 +2,18 @@ Here you will learn how to use PhasicFlow to setup a granular flow simulation. The inputs for simulation are supplied through some text-based files, called file dictionary, located in two folders: `settings` and `caseSetup`. These folders are located under the root case directory. All the commands are performed through terminal in which the current working directory is root case directory (you see `settings` and `caseSetup` folders when `ls` command is entered). The states of geometry and particles are stored in time folders with names that represent the time. When simulation is finished, one case use post-processing tool pFlowToVTK to convert the stored results in the time folder into VTK file format. The VTK file format can be read by Paraview. A set of tutorials with detailed descriptions are provided to show you how to use PhasicFlow for various granular flow problems. Here is a list of them. -* [Small rotating drum] (@ref rotatingDrumSmall) +* Tutorials based on sphereGranFlow solver + * Small rotating drum [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/rotatingDrumSmall) + * Rotating drum with baffles [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/RotatingDrumWithBaffles) + * Layered silo filling [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/layeredSiloFilling) + * Simulation of a V-blender [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/V-blender) + * Granular flow of particles with two particlce sizes[(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/binarySystemOfParticles) + * Simulation of a tote-blender [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/sphereGranFlow/toteblender) + +* Tutorials based on iterateGeometry solver + * Defining an inclined screw conveyor [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/iterateGeometry/inclinedScrewConveyor) + +* Tutorials based on postprocessPhasicFlow + * Particle number fraction in a binray system [(see on github.com)](https://github.com/PhasicFlow/phasicFlow/tree/main/tutorials/postprocessPhasicFlow/segregation) + +