setZeroDistributionBoundary3D.hh

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2020 Alexander Schulz
 *  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.
*/
 
//This file contains the Zero Distribution Boundary.
//This is a new version of the Boundary, which only contains free floating functions
//This boundary is an Advection Diffusion Boundary
//All functions, which are contained in this file are transferred and modified from:
//superBoundaryCondition3D.h/hh
//advectionDiffusionBoundaries.h/hh
//advectionDiffusionBoundaryInstantiator3D.h/hh
#ifndef SET_ZERO_DISTRIBUTION_BOUNDARY_3D_HH
#define SET_ZERO_DISTRIBUTION_BOUNDARY_3D_HH
 
#include "setZeroDistributionBoundary3D.h"
 
namespace olb {
 
 
//setZeroDistributionBoundary function on the superLattice domain
template<typename T, typename DESCRIPTOR>
void setZeroDistributionBoundary(SuperLattice<T, DESCRIPTOR>& sLattice,SuperGeometry<T,3>& superGeometry, int material)
{
  setZeroDistributionBoundary<T,DESCRIPTOR>(sLattice, superGeometry.getMaterialIndicator(material));
}
 
//setZeroDistributionBoundary function on the superLattice domain
//depending on the application, the first function can be skipped and this function can be called directly in the app
// more information of this boundary can be found here (https://doi.org/10.1016/j.jocs.2016.03.013)
template<typename T, typename DESCRIPTOR>
void setZeroDistributionBoundary(SuperLattice<T, DESCRIPTOR>& sLattice, FunctorPtr<SuperIndicatorF3D<T>>&& indicator)
{
  int _overlap = 1;
  OstreamManager clout(std::cout, "setZeroDistributionBoundary");
  for (int iCloc = 0; iCloc < sLattice.getLoadBalancer().size(); ++iCloc) {
    //sets ZeroDistributionBoundary on the block level
    setZeroDistributionBoundary<T,DESCRIPTOR>(sLattice.getBlock(iCloc),
        indicator->getBlockIndicatorF(iCloc));
  }
  addPoints2CommBC(sLattice,std::forward<decltype(indicator)>(indicator), _overlap);
}
 
//sets the ZeroDistributionBoundary on the block level
template<typename T, typename DESCRIPTOR>
void setZeroDistributionBoundary(BlockLattice<T,DESCRIPTOR>& _block, BlockIndicatorF3D<T>& indicator)
{
  OstreamManager clout(std::cout, "setZeroDistributionBoundary");
  const auto& blockGeometryStructure = indicator.getBlockGeometry();
  const int margin = 1;
  std::vector<int> discreteNormal(4, 0);
  blockGeometryStructure.forSpatialLocations([&](auto iX, auto iY, auto iZ) {
    if (blockGeometryStructure.getNeighborhoodRadius({iX, iY, iZ}) >= margin
        && indicator(iX, iY, iZ)) {
      discreteNormal = blockGeometryStructure.getStatistics().getType(iX, iY, iZ);
      if (discreteNormal[1]!=0 || discreteNormal[2]!=0 || discreteNormal[3]!=0) {
        auto postProcessor = std::unique_ptr<PostProcessorGenerator3D<T, DESCRIPTOR>>{
        new ZeroDistributionBoundaryProcessorGenerator3D<T, DESCRIPTOR>(iX, iX, iY, iY, iZ, iZ, -discreteNormal[1], -discreteNormal[2], -discreteNormal[3]) };
        if (postProcessor) {
          _block.addPostProcessor(*postProcessor);
        }
      }
      else {
        clout << "Warning: Could not setZeroDistributionBoundary (" << iX << ", " << iY << ", " << iZ << "), discreteNormal=(" << discreteNormal[0] <<","<< discreteNormal[1] <<","<< discreteNormal[2] << "," << discreteNormal[3] << ")" << std::endl;
      }
    }
  });
}
 
 
} //namespace olb
 
 
#endif