xfygogo/phasicFlow
1
0
Fork 0
mirror of https://github.com/PhasicFlow/phasicFlow.git synced 2025-06-12 16:26:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

CLI::Timer renamed to remove compiler errors

Browse Source
This commit is contained in:
Hamidreza Norouzi
2023-03-30 15:07:45 -07:00
parent 58954fcb23
commit e8e093dbfc
5 changed files with 20 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/mdDocs/howToUsePhasicFlow.md Normal file
View File

@ -0,0 +1,5 @@
# How to use PhasicFlow {#howToUsePhasicFlow}
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)