Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • irmb/VirtualFluids
1 result
Show changes
Commits on Source (12)
image: irmb/virtualfluids-python-deps:latest
###############################################################################
## VirtualFluids CI Pipeline ##
###############################################################################
image: irmb/virtualfluids-python-deps-ubuntu20.04:latest
stages:
- build
......@@ -14,7 +17,7 @@ stages:
.gnu_build_template:
stage: build
image: irmb/virtualfluids-deps-ubuntu20.04
image: irmb/virtualfluids-deps-ubuntu20.04:latest
tags:
- gpu
......@@ -161,7 +164,7 @@ msvc_16_unit_tests:
clang_build_analyzer_clang_10:
stage: analyze
image: irmb/virtualfluids-deps-ubuntu20.04
image: irmb/virtualfluids-deps-ubuntu20.04:latest
only: ["schedules"]
......@@ -194,7 +197,7 @@ clang_build_analyzer_clang_10:
include_what_you_use_clang_10:
stage: analyze
image: irmb/virtualfluids-deps-ubuntu20.04
image: irmb/virtualfluids-deps-ubuntu20.04:latest
only: ["schedules"]
......@@ -225,11 +228,11 @@ include_what_you_use_clang_10:
cppcheck:
stage: analyze
image: irmb/virtualfluids-deps-ubuntu20.04:latest
only:
- open_source@irmb/VirtualFluids_dev
image: irmb/virtualfluids-deps-ubuntu20.04
needs: []
before_script:
......@@ -254,11 +257,11 @@ cppcheck:
lizard:
stage: analyze
image: irmb/virtualfluids-python-deps-ubuntu20.04:latest
only:
- open_source@irmb/VirtualFluids_dev
image: irmb/virtualfluids-python-deps-ubuntu20.04
needs: []
before_script:
......@@ -281,11 +284,11 @@ lizard:
gcov_gcc_9:
stage: analyze
image: irmb/virtualfluids-python-deps-ubuntu20.04:latest
only:
- open_source@irmb/VirtualFluids_dev
image: irmb/virtualfluids-python-deps-ubuntu20.04
needs: []
before_script:
......@@ -325,11 +328,11 @@ gcov_gcc_9:
clang-tidy:
stage: analyze
image: irmb/virtualfluids-python-deps-ubuntu20.04:latest
only:
- open_source@irmb/VirtualFluids_dev
image: irmb/virtualfluids-python-deps-ubuntu20.04
needs: []
before_script:
......@@ -349,6 +352,29 @@ clang-tidy:
- build/clangtidy.txt
- build/compile_commands.json
###############################################################################
# doxygen
pages:
stage: analyze
image: alpine
only:
- open_source@irmb/virtualfluids
needs: []
script:
- apk update && apk add doxygen
- doxygen docs/Doxyfile
- mv docs/build/html/ public/
artifacts:
expire_in: 1 week
paths:
- public
###############################################################################
## Deploy ##
###############################################################################
......
......@@ -58,11 +58,11 @@ A GPU computation generates a the time series of output files directly in the ou
## Documentation
The doxygen generated documentation can be found [here](https://git.irmb.bau.tu-bs.de/doku).
The doxygen generated documentation can be found [here](https://irmb.gitlab-pages.rz.tu-bs.de/virtualfluids).
## Known Issues
If you notice any problems on your platform, please report an issue.
If you notice any problems on your platform, please report an [issue](https://git.rz.tu-bs.de/irmb/virtualfluids/-/issues/new).
## Authors
......
//index page for doxygen
/*! \mainpage
*
* \section intro_sec Introduction
* <i>VirtualFluids</i> is an adaptive, parallel Lattice-Boltzmann flow solver
* which is comprised of various cores
* and use second order accurate compact interpolation at the interfaces,
* coupling grids of different resolutions.
* The software framework is based on object-oriented technology and uses tree-like data structures.
* These data structures are also suitable for hierarchical parallelization using a combination of PThreads and MPI and dynamic load balancing.
*
* \section install_sec Installation
*
* \subsection step1 Step 1: CMake
* Download and install <a href="http://www.cmake.org/">CMake</a>.
* If you have Windows OS oder X-Windows for Linux/Unix start <i>cmake-gui</i>.
* If you work in terminal start <i>ccmake</i>.
* \subsection step2 Step 2: project configuration
* You need set a path for <i>VirtualFluids</i> source code. It is allays <i>source</i> directory at the end of path.
* E.g. c:/vf/source. You need also set a path to build binaries. If you click <b>Configure</b> button start a project wizard and you can choose a compiler.
* Set <b>Grouped</b> and <b>Advanced</b> check boxes in CMake. In the group <i>USE</i> you have follow important options:
* \li USE_BOND - using an agent based communication framework for fault tolerance BOND
* \li USE_METIS - using a domain decomposition tool METIS
* \li USE_MPI - using MPI for distributed memory parallelization
* \li USE_YAML - using YAML
* \li USE_ZOLTAN - using domain decomposition tool ZOLTAN
* There are externals library and you need additionally compile them.
* \subsection step3 Step 4: project compilation
* Compile you project with suitable compiler.
*/
\ No newline at end of file
\section install_sec Installation
\subsection step1 Step 1: CMake
Download and install <a href="http://www.cmake.org/">CMake</a>.
If you have Windows OS oder X-Windows for Linux/Unix start <i>cmake-gui</i>.
If you work in terminal start <i>ccmake</i>.
\subsection step2 Step 2: project configuration
You need set a path for <i>VirtualFluids</i> source code. It is allays <i>source</i> directory at the end of path.
E.g. c:/vf/source. You need also set a path to build binaries. If you click <b>Configure</b> button start a project wizard and you can choose a compiler.
Set <b>Grouped</b> and <b>Advanced</b> check boxes in CMake. In the group <i>USE</i> you have follow important options:
\li USE_BOND - using an agent based communication framework for fault tolerance BOND
\li USE_METIS - using a domain decomposition tool METIS
\li USE_MPI - using MPI for distributed memory parallelization
\li USE_YAML - using YAML
\li USE_ZOLTAN - using domain decomposition tool ZOLTAN
There are externals library and you need additionally compile them.
\subsection step3 Step 4: project compilation
Compile you project with suitable compiler.
# Installation {#installation}
## Step 1: CMake
Download and install [CMake](http://www.cmake.org).
If you have Windows OS oder X-Windows for Linux/Unix start *cmake-gui*.
If you work in terminal start *ccmake*.
## Step 2: project configuration
You need set a path for *VirtualFluids* source code. It is allays *source* directory at the end of path.
E.g. *c:/vf/source*. You need also set a path to build binaries. E.g. *c:/vf/bin*. If you click **Configure** button start a project wizard and you can choose a compiler.
Set **Grouped** and **Advanced** check boxes in CMake. In the group *USE* you have follow important options:
* USE_BOND - using an agent based communication framework for fault tolerance BOND
* USE_METIS - using a domain decomposition tool METIS
* USE_MPI - using MPI for distributed memory parallelization
* USE_YAML - using YAML
* USE_ZOLTAN - using domain decomposition tool ZOLTAN
There are externals library and you need additionally compile them.
## Step 4: project compilation
Compile you project with suitable compiler
\ No newline at end of file
# Introduction {#mainpage}
## Introduction
*VirtualFluids* is an adaptive, parallel Lattice-Boltzmann flow solver
which is comprised of various cores
and use second order accurate compact interpolation at the interfaces,
coupling grids of different resolutions.
The software framework is based on object-oriented technology and uses tree-like data structures.
These data structures are also suitable for hierarchical parallelization using a combination of PThreads and MPI and dynamic load balancing.
[Installation](md__d_1__projects__virtual_fluids_source__documentation_doc_intstall.html)
docs/cpu/Documentation/doxygen/logo.png

3.03 KiB

<meta http-equiv="refresh" content="0; URL=html/index.html">
\ No newline at end of file