mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-12 16:26:23 +00:00
documentation added, sample in property.hpp
This commit is contained in:
hamidrezanorouzi
2729
doc/Doxyfile
Normal file
2729
doc/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
61
doc/customdoxygen.css
Normal file
61
doc/customdoxygen.css
Normal file
@ -0,0 +1,61 @@
|
||||
#titlearea
|
||||
{
|
||||
background-color: rgb(243, 243, 243);
|
||||
height: 120px;
|
||||
padding-top: 8px;
|
||||
}
|
||||
|
||||
#projectlogo
|
||||
{
|
||||
padding-left: 15px;
|
||||
padding-right: 10px;
|
||||
}
|
||||
|
||||
#titlearea, #projectname, #projectbrief, #projectnumber
|
||||
{
|
||||
font-family: Lato, "Helvetica Neue", Helvetica, sans-serif;
|
||||
}
|
||||
|
||||
#projectname
|
||||
{
|
||||
font-size: 220%;
|
||||
}
|
||||
|
||||
#projectname a
|
||||
{
|
||||
color: rgba(0, 0, 0, 0.75);
|
||||
}
|
||||
|
||||
#projectname a:hover, #projectbrief a:hover
|
||||
{
|
||||
text-decoration: none;
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
|
||||
#projectbrief
|
||||
{
|
||||
font-size: 150%;
|
||||
}
|
||||
|
||||
#projectbrief a
|
||||
{
|
||||
color: rgba(0, 0, 0, 0.65);
|
||||
}
|
||||
|
||||
#projectnumber a
|
||||
{
|
||||
font-size: 160%;
|
||||
}
|
||||
|
||||
#titlearea::before
|
||||
{
|
||||
padding-left: 300px;
|
||||
position: absolute;
|
||||
left: 18%;
|
||||
top: 40px;
|
||||
transform: translateY(-50%);
|
||||
-webkit-transform: translateY(-50%);
|
||||
-ms-transform: translateY(-50%);
|
||||
content: "C++ Source Code Documentation";
|
||||
font-size: 180%;
|
||||
}
|
||||
18
doc/footer.html
Normal file
18
doc/footer.html
Normal file
@ -0,0 +1,18 @@
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
|
||||
</a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
</body>
|
||||
</html>
|
||||
54
doc/header.html
Normal file
54
doc/header.html
Normal file
@ -0,0 +1,54 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname"><a href="https://cemf.ir">$projectname</a>
|
||||
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber"><a href="https://cemf.ir">$projectnumber</a></span><!--END PROJECT_NUMBER-->
|
||||
</div>
|
||||
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief"><a href="www.github.com/PhasicFlow">$projectbrief</a></div><!--END PROJECT_BRIEF-->
|
||||
</td>
|
||||
<!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_BRIEF-->
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<td>$searchbox</td>
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
@ -1,53 +0,0 @@
|
||||
# How to build PhasicFlow?
|
||||
PhasicFlow uses CMake as the build system. you need to have CMake-3.22 or higher installed on your machine. you can either use the command line for setting-up the build system, or use `cmake-gui` to setup your build system through the GUI.
|
||||
### Step 1:
|
||||
Make sure you have installed all the required packages on your computer (tbb and CMake and compilers).
|
||||
### Step 2: Cloning Kokkos
|
||||
It is assumed that Kokkos source is located in the home folder of your OS. Clone the current version of Kokkos into your home folder:
|
||||
|
||||
```
|
||||
cd ~
|
||||
mkdir Kokkos
|
||||
cd Kokkos
|
||||
git clone https://github.com/kokkos/kokkos.git
|
||||
```
|
||||
|
||||
or simply download and extract the source code of Kokkos in `~/Kokkos` folder. In the end, the top level CMakeLists.txt file should be located in `~/Kokkos/kokkos` folder.
|
||||
|
||||
### Step 3: Cloning PhasicFlow
|
||||
Create the PhasicFlow folder in your home folder and then clone the source code into that folder:
|
||||
|
||||
```
|
||||
cd ~
|
||||
mkdir PhasicFlow
|
||||
cd PhasicFlow
|
||||
git clone https://github.com/hamidrezanorouzi/phasicFlow.git
|
||||
```
|
||||
### Step 4: Environmental variables
|
||||
In the terminal enter the following command:
|
||||
|
||||
`gedit ~/.bashrc`
|
||||
|
||||
and add the following line to the end of file, save and close it.
|
||||
|
||||
source $HOME/PhasicFlow/phasicFlow/cmake/bashrc
|
||||
|
||||
close the terminal.
|
||||
|
||||
### Step 5: Building PhasicFlow
|
||||
Follow one of the followings to build PhasicFlow for one mode of execution.
|
||||
#### Serial build for CPU
|
||||
Open a new terminal and enter the following commands:
|
||||
```
|
||||
cd ~/PhasicFlow/phasicFlow/build
|
||||
cmake ../ -DpFlow_Build_Serial=On
|
||||
make install
|
||||
```
|
||||
For faster builds, use `make install -j`. This will use all the CPU cores on your computer for building.
|
||||
#### OpenMP build for CPU
|
||||
|
||||
#### GPU build for parallel execution on CUDA-enabled GPUs
|
||||
|
||||
|
||||
|
||||
After building, `bin`, `include`, and `lib` folders will be created in `~/PhasicFlow/phasicFlow/` folder. Now you are ready to use PhasicFlow.
|
||||
Reference in New Issue
Block a user