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

fix readme

This commit is contained in:
Hamidreza Norouzi 2022-08-28 00:31:23 -07:00
parent 83d6d5888f
commit f07be43a91
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,15 +1,18 @@
# phasicFlow # phasicFlow
phasicFlow is a parallel C++ code for performing DEM simulations. It can run on shared-memory multi-core computational units such as multi-core CPUs or GPUs (for now it works on CUDA-enabled GPUs). The parallelization method now mainly relies on loop-level parallelization on a shared-memory computational unit. You can build and run phasic flow in serial mode on regualr PCs, build it for multi-core CPUs to be executed in parallel, or build it for a GPU device to off-load computations to GPU. phasicFlow is a parallel C++ code for performing DEM simulations. It can run on shared-memory multi-core computational units such as multi-core CPUs or GPUs (for now it works on CUDA-enabled GPUs). The parallelization method mainly relies on loop-level parallelization on a shared-memory computational unit. You can build and run phasicFlow in serial mode on regualr PCs, in parallel mode for multi-core CPUs, or build it for a GPU device to off-load computations to a GPU.
# Required packages
phasicFlow uses [Kokkos]( https://github.com/kokkos/kokkos) as the backend for parallelization. So, you need to also have the code in the local machine alongside phasicFlow. The make system is adjusted in a way so you do not need to compile Kokkos separately and the required code is compiled alongside the phasicFlow.
# Requirements # Requirements
## Compilers
phasicFlow should work with every gnu compiler that implements C++17 standards. For now, it is tested on Ubuntu distribution of linux operating systems. If the minimum requirements are met, there should not be any problem with compiling the code. However, there are always compiler bugs from one version to another that may need you extra attempts for upgrading to newer versions or downgrading to prior versions of the compiler. phasicFlow should work with every gnu compiler that implements C++17 standards. For now, it is tested on Ubuntu distribution of linux operating systems. If the minimum requirements are met, there should not be any problem with compiling the code. However, there are always compiler bugs from one version to another that may need you extra attempts for upgrading to newer versions or downgrading to prior versions of the compiler.
* CPU builds: It requires gcc-6.x or higher. * for CPU builds: It requires gcc-6.x or higher.
* GPU (CUDA-enabled): NVCC-10.x or higher. * for GPU (CUDA-enabled): NVCC-10.x or higher.
## Required packages
phasicFlow uses [Kokkos]( https://github.com/kokkos/kokkos) as the backend for parallelization. So, you need to have the code in the local machine alongside phasicFlow. The make system is adjusted in a way so you do not need to compile Kokkos separately and the required source code files from Kokkos are compiled alongside the phasicFlow.
## CMake
You also need to have CMake installed on your computer. At the moment CMake-3.22 or higher is needed. You also need to have CMake installed on your computer. At the moment CMake-3.22 or higher is needed.
# How to build? # How to build?