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/Doxyfile
View File

@ -822,7 +822,8 @@ WARN_LOGFILE =
INPUT = $(pFlow_PROJECT_DIR)/src \
$(pFlow_PROJECT_DIR)/utilities \
$(pFlow_PROJECT_DIR)/solvers \
mdDocs
mdDocs \
$(pFlow_PROJECT_DIR)/tutorials
# 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
@ -866,7 +867,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = $(pFlow_PROJECT_DIR)/src/phasicFlow/commandLine
EXCLUDE = $(pFlow_PROJECT_DIR)/src/phasicFlow/commandLine/CLI
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded

8
doc/mdDocs/howToBuild.md
View File

@ -123,17 +123,19 @@ After building, `bin`, `include`, and `lib` folders will be created in `~/Phasic
**note 1**: When compiling the code in parallel, you need to have enough RAM on your computer. As a rule, you need 1 GB free RAM per each processor in your computer for compiling in parallel.
You may want to use fewer number of cores on your computer by using the following command:
`$ make install -j 3`
the above command uses only 3 cores for compiling.
the above command only uses 3 cores for compiling.
**note 2**: By default PhasicFlow is compiled with **double** as floating point variable. You can compile it with **float**. Just in the command line of camke added `-DpFlow_Build_Double=Off` flag to compile it with float. For example if you are building for cuda, you can enter the following command:
`$ cmake ../ -DpFlow_Build_Cuda=On --DpFlow_Build_Double=Off`
`$ cmake ../ -DpFlow_Build_Cuda=On -DpFlow_Build_Double=Off`
### Step 6: Testing
In the current terminal or a new terminal enter the following command:
`$ ~checkPhasicFlow`
`$ checkPhasicFlow`
This command shows the host and device environments and software version. If PhasicFlow was build correctly, you would get the following output:
```

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)