blockSurface3D.h

00001 /* This file is part of the Palabos library.
00002  *
00003  * Copyright (C) 2011 FlowKit Sarl
00004  * Avenue de Chailly 23
00005  * 1012 Lausanne, Switzerland
00006  * E-mail contact: contact@flowkit.com
00007  *
00008  * The most recent release of Palabos can be downloaded at 
00009  * <http://www.palabos.org/>
00010  *
00011  * The library Palabos is free software: you can redistribute it and/or
00012  * modify it under the terms of the GNU Affero General Public License as
00013  * published by the Free Software Foundation, either version 3 of the
00014  * License, or (at your option) any later version.
00015  *
00016  * The library is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Affero General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Affero General Public License
00022  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00023 */
00024 
00028 #ifndef BLOCK_SURFACE_3D_H
00029 #define BLOCK_SURFACE_3D_H
00030 
00031 #include "core/globalDefs.h"
00032 #include "core/plbDebug.h"
00033 #include "core/geometry3D.h"
00034 
00035 namespace plb {
00036 
00038 class BlockSurface3D {
00039 public:
00040     BlockSurface3D(Box3D const& domain_, plint boundaryWidth);
00041     Box3D bulk() const;
00042     Box3D surface0N() const;
00043     Box3D surface0P() const;
00044     Box3D surface1N() const;
00045     Box3D surface1P() const;
00046     Box3D surface2N() const;
00047     Box3D surface2P() const;
00048     Box3D edge0NN() const;
00049     Box3D edge0NP() const;
00050     Box3D edge0PN() const;
00051     Box3D edge0PP() const;
00052     Box3D edge1NN() const;
00053     Box3D edge1NP() const;
00054     Box3D edge1PN() const;
00055     Box3D edge1PP() const;
00056     Box3D edge2NN() const;
00057     Box3D edge2NP() const;
00058     Box3D edge2PN() const;
00059     Box3D edge2PP() const;
00060     Box3D cornerNNN() const;
00061     Box3D cornerNNP() const;
00062     Box3D cornerNPN() const;
00063     Box3D cornerNPP() const;
00064     Box3D cornerPNN() const;
00065     Box3D cornerPNP() const;
00066     Box3D cornerPPN() const;
00067     Box3D cornerPPP() const;
00068 private:
00069     Box3D domain;
00070     plint bw;
00071 };
00072 
00073 }  // namespace plb
00074 
00075 #endif //  BLOCK_SURFACE_3D_H