PatchSolver.h

Go to the documentation of this file.

/***************************************************************************
 *  ThunderEgg, a library for solvers on adaptively refined block-structured
 *  Cartesian grids.
 *
 *  Copyright (c) 2019-2021 Scott Aiton
 *
 *  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 3 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, see <https://www.gnu.org/licenses/>.
 ***************************************************************************/
 
#ifndef THUNDEREGG_PATCHSOLVER_H
#define THUNDEREGG_PATCHSOLVER_H
 
#include <ThunderEgg/Domain.h>
#include <ThunderEgg/GMG/Smoother.h>
#include <ThunderEgg/GhostFiller.h>
#include <ThunderEgg/Operator.h>
#include <ThunderEgg/Vector.h>
 
namespace ThunderEgg {
template<int D>
class PatchSolver
  : public virtual Operator<D>
  , public virtual GMG::Smoother<D>
{
private:
  Domain<D> domain;
  std::shared_ptr<const GhostFiller<D>> ghost_filler;
 
public:
  PatchSolver(const Domain<D>& domain, const GhostFiller<D>& ghost_filler)
    : domain(domain)
    , ghost_filler(ghost_filler.clone())
  {}
  virtual ~PatchSolver() {}
  virtual PatchSolver<D>* clone() const override = 0;
  const Domain<D>& getDomain() const { return domain; }
  const GhostFiller<D>& getGhostFiller() const { return *ghost_filler; }
  virtual void solveSinglePatch(const PatchInfo<D>& pinfo,
                                const PatchView<const double, D>& f_view,
                                const PatchView<double, D>& u_view) const = 0;
  virtual void apply(const Vector<D>& f, Vector<D>& u) const override
  {
    if constexpr (ENABLE_DEBUG) {
      if (u.getNumLocalPatches() != this->domain.getNumLocalPatches()) {
        throw RuntimeError("u vector is incorrect length");
      }
      if (f.getNumLocalPatches() != this->domain.getNumLocalPatches()) {
        throw RuntimeError("f vector is incorrect length");
      }
    }
    u.setWithGhost(0);
    if (domain.hasTimer()) {
      domain.getTimer()->startDomainTiming(domain.getId(), "Total Patch Solve");
    }
    for (const PatchInfo<D>& pinfo : domain.getPatchInfoVector()) {
      if (domain.hasTimer()) {
        domain.getTimer()->start("Single Patch Solve");
      }
      PatchView<const double, D> f_view = f.getPatchView(pinfo.local_index);
      PatchView<double, D> u_view = u.getPatchView(pinfo.local_index);
      solveSinglePatch(pinfo, f_view, u_view);
      if (domain.hasTimer()) {
        domain.getTimer()->stop("Single Patch Solve");
      }
    }
    if (domain.hasTimer()) {
      domain.getTimer()->stopDomainTiming(domain.getId(), "Total Patch Solve");
    }
  }
  virtual void smooth(const Vector<D>& f, Vector<D>& u) const override
  {
    if constexpr (ENABLE_DEBUG) {
      if (u.getNumLocalPatches() != this->domain.getNumLocalPatches()) {
        throw RuntimeError("u vector is incorrect length");
      }
      if (f.getNumLocalPatches() != this->domain.getNumLocalPatches()) {
        throw RuntimeError("f vector is incorrect length");
      }
    }
    if (domain.hasTimer()) {
      domain.getTimer()->startDomainTiming(domain.getId(), "Total Patch Smooth");
    }
    ghost_filler->fillGhost(u);
    for (const PatchInfo<D>& pinfo : domain.getPatchInfoVector()) {
      if (domain.hasTimer()) {
        domain.getTimer()->startPatchTiming(pinfo.id, domain.getId(), "Single Patch Solve");
      }
      PatchView<const double, D> f_view = f.getPatchView(pinfo.local_index);
      PatchView<double, D> u_view = u.getPatchView(pinfo.local_index);
      solveSinglePatch(pinfo, f_view, u_view);
      if (domain.hasTimer()) {
        domain.getTimer()->stopPatchTiming(pinfo.id, domain.getId(), "Single Patch Solve");
      }
    }
    if (domain.hasTimer()) {
      domain.getTimer()->stopDomainTiming(domain.getId(), "Total Patch Smooth");
    }
  }
};
} // namespace ThunderEgg
#endif