blockLatticeStructure3D.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2006-2018 Jonas Latt, 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 BLOCK_LATTICE_STRUCTURE_3D_H
#define BLOCK_LATTICE_STRUCTURE_3D_H
 
#include <vector>
#include "cell.h"
#include "blockData3D.h"
#include "blockStructure3D.h"
#include "postProcessing.h"
#include "serializer.h"
#include "spatiallyExtendedObject3D.h"
#include "geometry/blockGeometryStructure3D.h"
#include "latticeStatistics.h"
#include "functors/analytical/analyticalF.h"
#include "functors/analytical/indicator/indicatorBaseF3D.h"
 
 
namespace olb {
 
template<typename T, typename DESCRIPTOR> struct Dynamics;
template<typename T, typename DESCRIPTOR> struct WriteCellFunctional;
template<typename T> class BlockIndicatorF3D;
template<typename T> class IndicatorSphere3D;
 
 
template<typename T, typename DESCRIPTOR>
class BlockLatticeStructure3D : public BlockStructure3D, public SpatiallyExtendedObject3D {
public:
  BlockLatticeStructure3D(int nx, int ny, int nz) : BlockStructure3D(nx,ny,nz) {};
  ~BlockLatticeStructure3D() override { }
public:
  /*
     * Vectors out of Boundary instantiator privates
     */
  std::vector<Momenta<T,DESCRIPTOR>*>  momentaVector;
  std::vector<Dynamics<T,DESCRIPTOR>*> dynamicsVector;
 
  virtual void defineRho(BlockIndicatorF3D<T>& indicator,
                         AnalyticalF<3,T,T>& rho);
  virtual void defineRho(BlockGeometryStructure3D<T>& blockGeometry, int material,
                         AnalyticalF<3,T,T>& rho);
 
 
  virtual void defineU(BlockIndicatorF3D<T>& indicator,
                       AnalyticalF<3,T,T>& u);
  virtual void defineU(BlockGeometryStructure3D<T>& blockGeometry, int material,
                       AnalyticalF<3,T,T>& u);
 
 
  virtual void defineRhoU(BlockIndicatorF3D<T>& indicator,
                          AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u);
  virtual void defineRhoU(BlockGeometryStructure3D<T>& blockGeometry, int material,
                          AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u);
 
 
  virtual void definePopulations(BlockIndicatorF3D<T>& indicator,
                                 AnalyticalF<3,T,T>& Pop);
  virtual void definePopulations(BlockGeometryStructure3D<T>& blockGeometry, int material,
                                 AnalyticalF<3,T,T>& Pop);
  virtual void definePopulations(BlockIndicatorF3D<T>& indicator,
                                 BlockF3D<T>& Pop);
  virtual void definePopulations(BlockGeometryStructure3D<T>& blockGeometry, int material,
                                 BlockF3D<T>& Pop);
 
 
  template <typename FIELD>
  void defineField(BlockIndicatorF3D<T>& indicator,
                   AnalyticalF<3,T,T>& field);
  template <typename FIELD>
  void defineField(BlockGeometryStructure3D<T>& blockGeometry, int material,
                   AnalyticalF<3,T,T>& field);
 
  template <typename FIELD>
  void defineField(BlockGeometryStructure3D<T>& blockGeometry,
                   IndicatorF3D<T>& indicatorF,
                   AnalyticalF<3,T,T>& field);
 
 
  virtual void iniEquilibrium(BlockIndicatorF3D<T>& indicator,
                              AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u);
  virtual void iniEquilibrium(BlockGeometryStructure3D<T>& blockGeometry, int material,
                              AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u);
 
 
  virtual void iniRegularized(BlockIndicatorF3D<T>& indicator,
                              AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u, AnalyticalF<3,T,T>& pi);
  virtual void iniRegularized(BlockGeometryStructure3D<T>& blockGeometry, int material,
                              AnalyticalF<3,T,T>& rho, AnalyticalF<3,T,T>& u, AnalyticalF<3,T,T>& pi);
 
  // pure virtual member functions
  virtual Cell<T,DESCRIPTOR> get(int iX, int iY, int iZ) =0;
  virtual Cell<T,DESCRIPTOR> get(const int latticeR[]) =0;
  virtual ConstCell<T,DESCRIPTOR> get(int iX, int iY, int iZ) const =0;
 
  virtual T& getPop(std::size_t iCell, unsigned iPop) =0;
  virtual T& getPop(int iX, int iY, int iZ, unsigned iPop) =0;
 
  virtual void initialize() =0;
 
  virtual void defineDynamics(int iX, int iY, int iZ, Dynamics<T,DESCRIPTOR>* dynamics) = 0;
  virtual void defineDynamics(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
                              Dynamics<T,DESCRIPTOR>* dynamics) = 0;
  virtual void defineDynamics(BlockIndicatorF3D<T>& indicator,
                              Dynamics<T,DESCRIPTOR>* dynamics) = 0;
  virtual void defineDynamics(BlockGeometryStructure3D<T>& blockGeometry, int material,
                              Dynamics<T,DESCRIPTOR>* dynamics) = 0;
 
  virtual Dynamics<T,DESCRIPTOR>* getDynamics(int iX, int iY, int iZ) = 0;
 
  virtual void collide(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
  virtual void collide() =0;
 
  virtual void stripeOffDensityOffset(int x0_, int x1_, int y0_, int y1_, int z0_,
                                      int z1_, T offset) =0;
  virtual void stripeOffDensityOffset(T offset) =0;
 
  virtual void addPostProcessor(PostProcessorGenerator3D<T,DESCRIPTOR> const& ppGen) =0;
  virtual void resetPostProcessors() =0;
  virtual void postProcess(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
  virtual void postProcess() =0;
 
  virtual void addLatticeCoupling(LatticeCouplingGenerator3D<T,DESCRIPTOR> const& lcGen,
                                  std::vector<SpatiallyExtendedObject3D*> partners ) =0;
  virtual void executeCoupling(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
  virtual void executeCoupling() =0;
 
  virtual LatticeStatistics<T>& getStatistics() =0;
  virtual LatticeStatistics<T> const& getStatistics() const =0;
 
  virtual void freeSurfacePostProcess(size_t i, int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
  virtual void freeSurfacePostProcess(size_t i) =0;
 
  virtual void freeSurfaceInitialize() = 0;
};
 
 
template <typename T>
bool getRangeBlockGeometrySmoothIndicatorIntersection3D(BlockGeometryStructure3D<T>& blockGeometry,
    SmoothIndicatorF3D<T,T,true>& sIndicator,
    T invDeltaX, std::vector<int>& start, std::vector<int>& end);
 
template <typename T, typename DESCRIPTOR>
void setBlockExternalParticleField( BlockGeometryStructure3D<T>& blockGeometry, AnalyticalF<3,T,T>& velocity,
                                    SmoothIndicatorF3D<T,T,true>& sIndicator,
                                    BlockLattice3D<T,DESCRIPTOR>& extendedBlockLattice);
 
template <typename T, typename DESCRIPTOR>
void setBlockExternalParticleField( BlockGeometryStructure3D<T>& blockGeometry, AnalyticalF<3,T,T>& velocity,
                                    SmoothIndicatorF3D<T,T,true>& sIndicator,
                                    BlockLattice3D<T,DESCRIPTOR>& extendedBlockLattice,
                                    Vector<T,3> cellMin, Vector<T,3> cellMax,
                                    Vector<bool,3> periodic);
 
}  // namespace olb
 
#endif