Compare commits
6 Commits
5fee39cdd8
...
c78ab398f6
Author | SHA1 | Date |
---|---|---|
|
c78ab398f6 | |
|
d1189c0b2c | |
|
ccb7a6dd41 | |
|
9e3bb1cfa1 | |
|
7bb0a0453a | |
|
577a94d07b |
26
README.md
26
README.md
|
@ -17,27 +17,36 @@ Ongoing development includes the integration of MPI-based parallelization with d
|
|||
5. **Hybrid Parallelism:** MPI + OpenMP.
|
||||
6. **Multi-GPU Parallelism:** MPI + CUDA.
|
||||
|
||||
# **Build and Installation**
|
||||
## **Build and Installation**
|
||||
|
||||
PhasicFlow can be compiled for both CPU and GPU execution.
|
||||
|
||||
* **Current Development (v-1.0):** Comprehensive build instructions are available [here](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-build-PhasicFlow%E2%80%90v%E2%80%901.0).
|
||||
* **Latest Release (v-0.1):** Detailed build instructions are available [here](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-Build-PhasicFlow).
|
||||
|
||||
# **Comprehensive Documentation**
|
||||
## **Comprehensive Documentation**
|
||||
|
||||
In-depth documentation, including code structure, features, and usage guidelines, is accessible via the [online documentation portal](https://phasicflow.github.io/phasicFlow/).
|
||||
|
||||
## **Tutorials and Examples**
|
||||
### **Tutorials and Examples**
|
||||
|
||||
Practical examples and simulation setups are provided in the [tutorials directory](./tutorials). For detailed explanations and step-by-step guides, please refer to the [tutorial section on the PhasicFlow Wiki](https://github.com/PhasicFlow/phasicFlow/wiki/Tutorials).
|
||||
|
||||
# **PhasicFlowPlus: Coupled CFD-DEM Simulations**
|
||||
## Contributing to PhasicFlow
|
||||
We welcome contributions to PhasicFlow! Whether you're a developer or a new user, there are many ways to get involved. Here's how you can help:
|
||||
1. Bug Reports
|
||||
2. Suggestions for better user experience
|
||||
3. Feature request and algorithm improvements
|
||||
4. Tutorials, Simulation Case Setups and documentation
|
||||
5. Direct Code Contributions
|
||||
|
||||
For more details on how you can contribute to PhasicFlow see [this page](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-contribute-to-PhasicFlow).
|
||||
|
||||
## **PhasicFlowPlus: Coupled CFD-DEM Simulations**
|
||||
|
||||
PhasicFlowPlus is an extension of PhasicFlow that facilitates the simulation of particle-fluid systems using resolved and unresolved CFD-DEM methods. The repository for PhasicFlowPlus can be found [here](https://github.com/PhasicFlow/PhasicFlowPlus).
|
||||
|
||||
|
||||
# How to cite PhasicFlow?
|
||||
## How to cite PhasicFlow?
|
||||
|
||||
If you are using PhasicFlow in your research or industrial work, cite the following [article](https://www.sciencedirect.com/science/article/pii/S0010465523001662):
|
||||
|
||||
|
@ -58,9 +67,10 @@ If you are using PhasicFlow in your research or industrial work, cite the follow
|
|||
}
|
||||
```
|
||||
|
||||
# **Dependencies**
|
||||
|
||||
## **Dependencies**
|
||||
|
||||
PhasicFlow relies on the following external libraries:
|
||||
|
||||
* **Kokkos:** A performance portability ecosystem developed by National Technology & Engineering Solutions of Sandia, LLC (NTESS). ([https://github.com/kokkos/kokkos](https://github.com/kokkos/kokkos))
|
||||
* **Kokkos:** A community-led performance portability ecosystem within the Linux Foundation's High-Performance Software Foundation (HPSF). ([https://github.com/kokkos/kokkos](https://github.com/kokkos/kokkos))
|
||||
* **CLI11 1.8:** A command-line interface parser developed by the University of Cincinnati. ([https://github.com/CLIUtils/CLI11](https://github.com/CLIUtils/CLI11))
|
||||
|
|
Loading…
Reference in New Issue