From 6aa527bf035448efe2f803d0649e1fabf8b07d04 Mon Sep 17 00:00:00 2001 From: Aircraft Guy <8074474+gurkanctn@users.noreply.github.com> Date: Sun, 4 Aug 2024 16:41:26 +0300 Subject: [PATCH] Update DOCUMENTATION.md small typo added some development suggestions for Arm based Linux computers (Raspberry Pi, Orange Pi, etc.) to be able to successfully build the FluidX3D. --- DOCUMENTATION.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 013edda..66684ba 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,6 +1,6 @@ # FluidX3D Documentation - How to get started? -## 0. Intstall GPU Drivers and OpenCL Runtime +## 0. Install GPU Drivers and OpenCL Runtime
(click to expand section) @@ -142,6 +142,8 @@ - To select a specific GPU, enter `./make.sh 0` to compile+run, or `bin/FluidX3D 0` to run on device `0`. You can also select multiple GPUs with `bin/FluidX3D 0 1 3 6` if the setup is [configured as multi-GPU](#the-lbm-class). - Operating system (Linux/macOS/Android) and X11 support (required for [`INTERACTIVE_GRAPHICS`](src/defines.hpp)) are detected automatically. In case problems arise, you can still manually select [`target=...`](make.sh#L13) in [`make.sh`](make.sh#L13). - On macOS and Android, [`INTERACTIVE_GRAPHICS`](src/defines.hpp) mode is not supported, as no X11 is available. You can still use [`INTERACTIVE_GRAPHICS_ASCII`](src/defines.hpp) though, or [render video](#video-rendering) to the hard drive with regular [`GRAPHICS`](src/defines.hpp) mode. +- On ARM based Linux systems (e.g. Raspberry Pi, Orange Pi, etc.) you may need to install OpenCL development tools to install the libOpenCL.so and headers for your system. You can use `sudo apt install opencl-headers ocl-icd-opencl-dev -y` command to install the libOpenCL dev tools. Then you may need to copy your libOpenCL.so file into the `FluidX3D/src/OpenCL/lib/` folder. +
@@ -454,4 +456,4 @@ By now you're already familiar with the [additional boundary types](#initial-and - too low kinematic shear viscosity `nu` (ideally close to `1/6`, becomes unstable when it's very very close to `0` (then enable the [`SUBGRID`](src/defines.hpp) extension), and should not exceed `3`) - too high force per volume (`fx`|`fy`|`fz`) (should not exceed `0.001` in magnitude) - too high surface tension coefficient `sigma` (should not exceed `0.1`) -- The best parametrization for LBM simulations is an art in itself and needs some practice. \ No newline at end of file +- The best parametrization for LBM simulations is an art in itself and needs some practice.