add citation information
[LbmBenchmarkKernelsPublic.git] / src / Lattice.h
CommitLineData
10988083
MW
1// --------------------------------------------------------------------------
2//
3// Copyright
4// Markus Wittmann, 2016-2017
5// RRZE, University of Erlangen-Nuremberg, Germany
6// markus.wittmann -at- fau.de or hpc -at- rrze.fau.de
7//
8// Viktor Haag, 2016
9// LSS, University of Erlangen-Nuremberg, Germany
10//
11// This file is part of the Lattice Boltzmann Benchmark Kernels (LbmBenchKernels).
12//
13// LbmBenchKernels is free software: you can redistribute it and/or modify
14// it under the terms of the GNU General Public License as published by
15// the Free Software Foundation, either version 3 of the License, or
16// (at your option) any later version.
17//
18// LbmBenchKernels is distributed in the hope that it will be useful,
19// but WITHOUT ANY WARRANTY; without even the implied warranty of
20// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21// GNU General Public License for more details.
22//
23// You should have received a copy of the GNU General Public License
24// along with LbmBenchKernels. If not, see <http://www.gnu.org/licenses/>.
25//
26// --------------------------------------------------------------------------
27#ifndef __LATTICE_H__
28#define __LATTICE_H__
29
30#include "Base.h"
31
32
33typedef int LatticeT;
34
35typedef enum LAT_CELL_TYPES_ {
36 LAT_CELL_OBSTACLE = 0,
37 LAT_CELL_FLUID = 1,
38 LAT_CELL_INLET = 2,
39 LAT_CELL_OUTLET = 4
40} LAT_CELL_TYPES;
41
42
43typedef struct LatticeDesc_ {
44 int Dims[3];
45 LatticeT * Lattice;
46 int nCells; // Total number of cells (Obstacles + Fluids).
47 int nFluid; // Total number of fluid cells. Fluid cells are fluid, inlet, and outlet.
48 int nObst; // Total number of obstacles in the lattice.
49 int nInlet; // Total number of inlets in the lattice.
50 int nOutlet; // Total number of outlets.
51 int PeriodicX; // Periodic in X direction.
52 int PeriodicY; // Periodic in Y direction.
53 int PeriodicZ; // Periodic in Z direction.
0fde6e45 54 const char * Name; // Geometry Name, points to statically allocated names, do not free!
10988083
MW
55} LatticeDesc;
56
57
58// #define L_INDEX_4(dims, x, y, z) ((z) * (dims[0]) * (dims[1]) + (y) * (dims[0]) + (x))
59
60static inline int L_INDEX_4(int dims[3], int x, int y, int z)
61{
62 Assert(dims != NULL);
63
64 Assert(dims[0] > 0);
65 Assert(dims[1] > 0);
66 Assert(dims[2] > 0);
67
68 Assert(x >= 0);
69 Assert(x < dims[0]);
70 Assert(y >= 0);
71 Assert(y < dims[1]);
72 Assert(z >= 0);
73 Assert(z < dims[2]);
74
75 return z * dims[0] * dims[1] + y * dims[0] + x;
76}
77
e3f82424 78void LatDumpAscii(LatticeDesc * ld, int zStart, int zStop);
10988083
MW
79
80#endif // __LATTICE_H__
This page took 0.118134 seconds and 5 git commands to generate.