diff --git a/README.md b/README.md index 9897f38c..1bad11e2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ -# 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 mainly relies on loop-level parallelization on a shared-memory computational unit. You can build and run PhasicFlow in serial mode on regular PCs, in parallel mode for multi-core CPUs, or build it for a GPU device to off-load computations to a GPU. In its current statues you can simulate millions of particles (up to 32M particles tested) on a single desktop computer. You can see the [performance tests of PhasicFlow](https://github.com/PhasicFlow/phasicFlow/wiki/Performance-of-phasicFlow) in the wiki page. +
+ +
-# How to build? + +**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 regular PCs, in parallel mode for multi-core CPUs, or build it for a GPU device to off-load computations to a GPU. In its current statues you can simulate millions of particles (up to 32M particles tested) on a single desktop computer. You can see the [performance tests of PhasicFlow](https://github.com/PhasicFlow/phasicFlow/wiki/Performance-of-phasicFlow) in the wiki page. + +## How to build? You can build PhasicFlow for CPU and GPU executions. [Here is a complete step-by-step procedure](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-Build-PhasicFlow). -# Online code documentation +## Online code documentation You can find a full documentation of the code, its features, and other related materials on [online documentation of the code](https://phasicflow.github.io/phasicFlow/) -# How to use PhasicFlow? +## How to use PhasicFlow? You can navigate into [tutorials folder](./tutorials) in the phasicFlow folder to see some simulation case setups. If you need more detailed discription, visit our [wiki page tutorials](https://github.com/PhasicFlow/phasicFlow/wiki/Tutorials). -# Supporting packages +## [PhasicFlowPlus](https://github.com/PhasicFlow/PhasicFlowPlus) +PhasicFlowPlus is and extension to PhasicFlow for simulating particle-fluid systems using resolved and unresolved CFD-DEM. [See the repository of this package.](https://github.com/PhasicFlow/PhasicFlowPlus) + + +## Supporting packages * [Kokkos](https://github.com/kokkos/kokkos) from National Technology & Engineering Solutions of Sandia, LLC (NTESS) * [CLI11 1.8](https://github.com/CLIUtils/CLI11) from University of Cincinnati. -# Extensions in future -### parallelization -* Extending the code for using OpenMPTarget backend to include more GPUs for off-loading the computations. -* Extending high-level parallelization and implementing space partitioning and load balancing for muilti-GPU computations and running PhasicFlow on distributed memory super-computers - diff --git a/doc/Doxyfile b/doc/Doxyfile index 7f10e4b7..6225c07a 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = www.cemf.ir # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = /home/hrn/PhasicFlow/phasicFlow/doc/phasicFlow_logo.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/doc/customdoxygen.css b/doc/customdoxygen.css index cb6360d7..2d75c0fd 100644 --- a/doc/customdoxygen.css +++ b/doc/customdoxygen.css @@ -1,7 +1,6 @@ #titlearea { background-color: rgb(243, 243, 243); - height: 120px; padding-top: 8px; } @@ -37,6 +36,7 @@ #projectbrief { font-size: 150%; + padding-left: 15px; } #projectbrief a diff --git a/doc/footer.html b/doc/footer.html index ef260201..369341da 100644 --- a/doc/footer.html +++ b/doc/footer.html @@ -6,9 +6,12 @@ doxygen $doxygenversion + -
+
+
+ $generatedby   doxygen $doxygenversion diff --git a/doc/header.html b/doc/header.html index 99e9f949..a847be55 100644 --- a/doc/header.html +++ b/doc/header.html @@ -20,33 +20,21 @@ $extrastylesheet
- +
- + - + - - - - - - - - - - + + +
- - - -
$projectbrief
- 		$searchbox
+ www.cemf.ir +
diff --git a/doc/phasicFlow_logo.png b/doc/phasicFlow_logo.png new file mode 100644 index 00000000..8b3cd216 Binary files /dev/null and b/doc/phasicFlow_logo.png differ diff --git a/doc/phasicFlow_logo_github.png b/doc/phasicFlow_logo_github.png new file mode 100644 index 00000000..aae1e28d Binary files /dev/null and b/doc/phasicFlow_logo_github.png differ