/*  Lattice Boltzmann sample, written in C++, using the OpenLB
 *  library
 *
 *  Copyright (C) 2007, 2012 Jonas Latt, Mathias J. Krause
 *  Vojtech Cvrcek, Peter Weisbrod
 *  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.
 */

#include "olb2D.h"
#include "olb2D.hh"

#include <vector>

using namespace olb;
using namespace olb::descriptors;

typedef double T;

#define DESCRIPTOR D2Q9Descriptor

const T lx  = 4.;             // length of the channel
const T ly  = 1.;             // height of the channel
const int N = 30;             // resolution of the model
const T Re  = 100.;           // Reynolds number
const T maxPhysT = 60.;       // max. simulation time in s, SI unit
const T physInterval = 0.25;  // interval for the convergence check in s
const T residuum = 1e-5;      // residuum for the convergence check


void prepareGeometry(UnitConverter<T,DESCRIPTOR> const& converter,
                     SuperGeometry2D<T>& superGeometry)
{

  OstreamManager clout(std::cout,"prepareGeometry");
  clout << "Prepare Geometry ..." << std::endl;

  superGeometry.rename(0,2);
  // Set material number for bounce back boundaries
  superGeometry.rename(2,1,0,1);

  T physSpacing = converter.getPhysDeltaX();
  Vector<T,2> extend{  physSpacing / 2, ly };
  Vector<T,2> origin{ -physSpacing / 4, 0  };

  // Set material number for inflow
  IndicatorCuboid2D<T> inflow(extend, origin);
  superGeometry.rename(1,3,1,inflow);

  // Set material number for outflow
  origin[0] = lx - physSpacing / 4;
  IndicatorCuboid2D<T> outflow(extend, origin);
  superGeometry.rename(1,4,1,outflow);

  IndicatorCuboid2D<T> obstacle(Vector<T,2> {0.2,0.1}, Vector<T,2> {1.25,0.45});
  superGeometry.rename(1,5,obstacle);

  // Removes all not needed boundary voxels outside the surface
  superGeometry.clean();
  // Removes all not needed boundary voxels inside the surface
  superGeometry.innerClean();
  superGeometry.checkForErrors();

  superGeometry.print();

  clout << "Prepare Geometry ... OK" << std::endl;
}

void prepareCoarseLattice(UnitConverter<T,DESCRIPTOR> const& converter,
                          SuperLattice2D<T, DESCRIPTOR>& sLattice,
                          Dynamics<T, DESCRIPTOR>& bulkDynamics,
                          sOnLatticeBoundaryCondition2D<T,DESCRIPTOR>& sBoundaryCondition,
                          SuperGeometry2D<T>& superGeometry)
{
  OstreamManager clout(std::cout,"prepareLattice");
  clout << "Prepare coarse lattice ..." << std::endl;

  const T omega = converter.getLatticeRelaxationFrequency();

  sLattice.defineDynamics(superGeometry, 0, &instances::getNoDynamics<T, DESCRIPTOR>());
  sLattice.defineDynamics(superGeometry, 1, &bulkDynamics); // bulk
  sLattice.defineDynamics(superGeometry, 2, &instances::getBounceBack<T, DESCRIPTOR>());
  sLattice.defineDynamics(superGeometry, 3, &bulkDynamics); // inflow
  sLattice.defineDynamics(superGeometry, 4, &bulkDynamics); // outflow

  sBoundaryCondition.addVelocityBoundary(superGeometry, 3, omega);
  sBoundaryCondition.addPressureBoundary(superGeometry, 4, omega);

  const T Lx = converter.getLatticeLength(lx);
  const T Ly = converter.getLatticeLength(ly);
  const T p0 = 8.*converter.getLatticeViscosity()*converter.getCharLatticeVelocity()*Lx/(Ly*Ly);
  AnalyticalLinear2D<T,T> rho(-p0/lx*DESCRIPTOR<T>::invCs2, 0, p0*DESCRIPTOR<T>::invCs2+1);

  const T maxVelocity = converter.getCharLatticeVelocity();
  const T radius = ly/2;
  std::vector<T> axisPoint{0, ly/2};
  std::vector<T> axisDirection{1, 0};
  Poiseuille2D<T> u(axisPoint, axisDirection, maxVelocity, radius);

  sLattice.defineRhoU(superGeometry, 1, rho, u);
  sLattice.iniEquilibrium(superGeometry, 1, rho, u);
  sLattice.defineRhoU(superGeometry, 2, rho, u);
  sLattice.iniEquilibrium(superGeometry, 2, rho, u);

  sLattice.defineRhoU(superGeometry, 3, rho, u);
  sLattice.iniEquilibrium(superGeometry, 3, rho, u);
  sLattice.defineRhoU(superGeometry, 4, rho, u);
  sLattice.iniEquilibrium(superGeometry, 4, rho, u);

  sLattice.initialize();

  clout << "Prepare coarse lattice ... OK" << std::endl;
}

void prepareFineLattice(UnitConverter<T,DESCRIPTOR> const& converter,
                        SuperLattice2D<T, DESCRIPTOR>& sLattice,
                        Dynamics<T, DESCRIPTOR>& bulkDynamics,
                        sOnLatticeBoundaryCondition2D<T,DESCRIPTOR>& sBoundaryCondition,
                        SuperGeometry2D<T>& superGeometry)
{
  OstreamManager clout(std::cout,"prepareLattice");
  clout << "Prepare fine lattice ..." << std::endl;

  const T omega = converter.getLatticeRelaxationFrequency();

  sLattice.defineDynamics(superGeometry, 0, &instances::getNoDynamics<T, DESCRIPTOR>());
  sLattice.defineDynamics(superGeometry, 1, &bulkDynamics); // bulk
  sLattice.defineDynamics(superGeometry, 2, &instances::getBounceBack<T, DESCRIPTOR>());

  const T Lx = converter.getLatticeLength(lx);
  const T Ly = converter.getLatticeLength(ly);
  const T p0 = 8.*converter.getLatticeViscosity()*converter.getCharLatticeVelocity()*Lx/(Ly*Ly);
  AnalyticalLinear2D<T,T> rho(-p0/lx*DESCRIPTOR<T>::invCs2, 0, p0*DESCRIPTOR<T>::invCs2+1);

  const T maxVelocity = converter.getCharLatticeVelocity();
  const T radius = ly/2;
  std::vector<T> axisPoint{0, ly/2};
  std::vector<T> axisDirection{1, 0};
  Poiseuille2D<T> u(axisPoint, axisDirection, maxVelocity, radius);

  sLattice.defineRhoU(superGeometry, 1, rho, u);
  sLattice.iniEquilibrium(superGeometry, 1, rho, u);
  sLattice.defineRhoU(superGeometry, 2, rho, u);
  sLattice.iniEquilibrium(superGeometry, 2, rho, u);

  sLattice.initialize();

  clout << "Prepare fine lattice ... OK" << std::endl;
}

void getResults(const std::string& prefix,
                SuperLattice2D<T,DESCRIPTOR>& sLattice,
                UnitConverter<T,DESCRIPTOR> const& converter, int iT,
                SuperGeometry2D<T>& superGeometry, Timer<T>& timer, bool hasConverged)
{
  OstreamManager clout(std::cout,"getResults");

  SuperVTMwriter2D<T> vtmWriter(prefix + "poiseuille2d");
  SuperLatticePhysVelocity2D<T, DESCRIPTOR> velocity(sLattice, converter);
  SuperLatticePhysPressure2D<T, DESCRIPTOR> pressure(sLattice, converter);
  SuperLatticeGeometry2D<T, DESCRIPTOR> geometry( sLattice, superGeometry );
  vtmWriter.addFunctor(geometry);
  vtmWriter.addFunctor(velocity);
  vtmWriter.addFunctor(pressure);

  const int statIter = converter.getLatticeTime(maxPhysT/10.);

  if (iT==0) {
    vtmWriter.createMasterFile();
  }

  if (iT%100==0) {
    vtmWriter.write(iT);
  }

  if (iT%statIter==0 || hasConverged) {
    timer.update(iT);
    timer.printStep();

    sLattice.getStatistics().print(iT,converter.getPhysTime(iT));
  }
}

int main(int argc, char* argv[])
{
  olbInit(&argc, &argv);
  singleton::directories().setOutputDir("./tmp/");
  OstreamManager clout(std::cout,"main");

  Vector<T,2> coarseOrigin { 0.0, 0.0 };
  Vector<T,2> coarseExtend { lx, ly  };
  IndicatorCuboid2D<T> coarseCuboid(coarseExtend, coarseOrigin);

  Vector<T,2> fineOrigin   { 0.25 * lx, 0.2 };
  Vector<T,2> fineExtend   { 0.6  * lx, 0.6 };

  auto coarseGrid = Grid2D<T,DESCRIPTOR>::make(coarseCuboid, N, 0.8, Re);
  auto fineGrid   = &coarseGrid->refine(fineOrigin, fineExtend);

  prepareGeometry(coarseGrid->getConverter(), coarseGrid->getSuperGeometry());
  prepareGeometry(fineGrid->getConverter(), fineGrid->getSuperGeometry());

  const T coarseDeltaX = coarseGrid->getConverter().getPhysDeltaX();

  fineGrid->getSuperGeometry().rename(2,1);
  fineGrid->getSuperGeometry().rename(5,2);
  IndicatorCuboid2D<T> overlapCuboid(fineExtend - 4*coarseDeltaX, fineOrigin + 2*coarseDeltaX);
  coarseGrid->getSuperGeometry().rename(1,0,overlapCuboid);
  coarseGrid->getSuperGeometry().rename(2,0,overlapCuboid);
  coarseGrid->getSuperGeometry().rename(5,0,overlapCuboid);

  Dynamics<T, DESCRIPTOR>* coarseBulkDynamics;
  coarseBulkDynamics = new BGKdynamics<T, DESCRIPTOR>(
    coarseGrid->getConverter().getLatticeRelaxationFrequency(),
    instances::getBulkMomenta<T, DESCRIPTOR>());

  sOnLatticeBoundaryCondition2D<T, DESCRIPTOR> coarseSBoundaryCondition(coarseGrid->getSuperLattice());
  createLocalBoundaryCondition2D<T, DESCRIPTOR>(coarseSBoundaryCondition);

  prepareCoarseLattice(
    coarseGrid->getConverter(),
    coarseGrid->getSuperLattice(),
    *coarseBulkDynamics,
    coarseSBoundaryCondition,
    coarseGrid->getSuperGeometry());

  Dynamics<T, DESCRIPTOR>* fineBulkDynamics;
  fineBulkDynamics = new BGKdynamics<T, DESCRIPTOR>(
    fineGrid->getConverter().getLatticeRelaxationFrequency(),
    instances::getBulkMomenta<T, DESCRIPTOR>());

  sOnLatticeBoundaryCondition2D<T, DESCRIPTOR> fineSBoundaryCondition(fineGrid->getSuperLattice());
  createLocalBoundaryCondition2D<T, DESCRIPTOR>(fineSBoundaryCondition);

  prepareFineLattice(
    fineGrid->getConverter(),
    fineGrid->getSuperLattice(),
    *fineBulkDynamics,
    fineSBoundaryCondition,
    fineGrid->getSuperGeometry());

  clout << "starting simulation..." << endl;
  Timer<T> timer(
    coarseGrid->getConverter().getLatticeTime(maxPhysT),
    coarseGrid->getSuperGeometry().getStatistics().getNvoxel());
  util::ValueTracer<T> converge(
    fineGrid->getConverter().getLatticeTime(physInterval),
    residuum);
  timer.start();

  for (int iT = 0; iT < coarseGrid->getConverter().getLatticeTime(maxPhysT); ++iT) {
    if (converge.hasConverged()) {
      clout << "Simulation converged." << endl;
      break;
    }

    coarseGrid->collideAndStream();

    getResults(
      "coarse_",
      coarseGrid->getSuperLattice(),
      coarseGrid->getConverter(),
      iT,
      coarseGrid->getSuperGeometry(),
      timer,
      converge.hasConverged());
    getResults(
      "fine_",
      fineGrid->getSuperLattice(),
      fineGrid->getConverter(),
      iT,
      fineGrid->getSuperGeometry(),
      timer,
      converge.hasConverged());

    converge.takeValue(fineGrid->getSuperLattice().getStatistics().getAverageEnergy(), true);
  }

  timer.stop();
  timer.printSummary();
}