hyperplaneLattice3D.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2017 Adrian Kummerlaender
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public
 *  License along with this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/
 
#ifndef HYPERPLANE_LATTICE_3D_H
#define HYPERPLANE_LATTICE_3D_H
 
#include "core/vector.h"
#include "geometry/cuboidGeometry3D.h"
#include "hyperplane3D.h"
 
namespace olb {
 
 
template <typename T>
class HyperplaneLattice3D {
private:
  int computeMaxLatticeDistance(Cuboid3D<T>&& cuboid) const;
  void constructCuboid(CuboidGeometry3D<T>& geometry, int maxLatticeDistance);
  void setToResolution(int resolution);
 
protected:
  const Hyperplane3D<T> _hyperplane;
 
 
  Vector<T,3> _origin;
  Vector<T,3> _u;
  Vector<T,3> _v;
 
  T _h;
  int _nx;
  int _ny;
 
public:
 
  HyperplaneLattice3D(CuboidGeometry3D<T>& geometry,
                      Hyperplane3D<T>      hyperplane);
  HyperplaneLattice3D(CuboidGeometry3D<T>& geometry,
                      Hyperplane3D<T>      hyperplane,
                      int                  resolution);
  HyperplaneLattice3D(CuboidGeometry3D<T>& geometry,
                      Hyperplane3D<T>      hyperplane,
                      T                    h);
 
 
  HyperplaneLattice3D(Hyperplane3D<T> hyperplane,
                      T h, int nx, int ny);
 
  HyperplaneLattice3D(const HyperplaneLattice3D&) = default;
 
  const Hyperplane3D<T>& getHyperplane() const;
 
  Vector<T,3> getPhysR(const int& planeX, const int& planeY) const;
 
  int getNx() const;
  int getNy() const;
  T getPhysSpacing() const;
 
  Vector<T,3> getPhysOrigin() const;
  Vector<T,3> getVectorU() const;
  Vector<T,3> getVectorV() const;
 
};
 
}
 
#endif