xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc styles changed

This commit is contained in:
Hamidreza Norouzi 2023-04-02 14:51:47 -07:00
parent 9105a503ce
commit 60ed8eb2b7
4 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/Doxyfile
View File

@ -822,8 +822,7 @@ WARN_LOGFILE =
INPUT = $(pFlow_PROJECT_DIR)/src \ INPUT = $(pFlow_PROJECT_DIR)/src \
$(pFlow_PROJECT_DIR)/utilities \ $(pFlow_PROJECT_DIR)/utilities \
$(pFlow_PROJECT_DIR)/solvers \ $(pFlow_PROJECT_DIR)/solvers \
mdDocs \ mdDocs
$(pFlow_PROJECT_DIR)/tutorials
# This tag can be used to specify the character encoding of the source files # 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 # 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. # Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES. # 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 # 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 # 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. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES. # 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 # 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 # shown in the various tree structured indices initially; the user can expand

4
doc/customdoxygen.css
View File

@ -21,14 +21,16 @@
font-size: 220%; font-size: 220%;
} }
#projectname a #projectname a
{ {
text-decoration: none;
color: rgba(0, 0, 0, 0.75); color: rgba(0, 0, 0, 0.75);
} }
#projectname a:hover, #projectbrief a:hover #projectname a:hover, #projectbrief a:hover
{ {
text-decoration: none; text-decoration: underline;
color: rgba(0, 0, 0, 1); color: rgba(0, 0, 0, 1);
} }

6
doc/header.html
View File

@ -28,10 +28,10 @@ $extrastylesheet
<!--END PROJECT_LOGO--> <!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME--> <!--BEGIN PROJECT_NAME-->
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">$projectname</a> <div id="projectname"><a href="www.github.com/PhasicFlow">$projectname</a>
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber"><a href="https://cemf.ir">$projectnumber</a></span><!--END PROJECT_NUMBER--> <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber"><a href="www.github.com/PhasicFlow">$projectnumber</a></span><!--END PROJECT_NUMBER-->
</div> </div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief"><a href="www.github.com/PhasicFlow">$projectbrief</a></div><!--END PROJECT_BRIEF--> <!--BEGIN PROJECT_BRIEF--><div id="projectbrief"><a href="https://cemf.ir">$projectbrief</a></div><!--END PROJECT_BRIEF-->
</td> </td>
<!--END PROJECT_NAME--> <!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--> <!--BEGIN !PROJECT_NAME-->

16
doc/mdDocs/howToUsePhasicFlow.md
View File

@ -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. 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. 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. 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)