AmrInterpolater.h

Go to the documentation of this file.

//
// Class AmrInterpolater
//   Abstract base class for all coarse to fine cell interpolaters.
//
// Copyright (c) 2017 - 2020, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
//
// This file is part of OPAL.
//
// OPAL 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.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef AMR_INTERPOLATER_H
#define AMR_INTERPOLATER_H
 
#include "Amr/AmrDefs.h"
 
template <class Level>
class AmrInterpolater {
 
public:
    typedef typename Level::go_t        go_t;
    typedef typename Level::lo_t        lo_t;
    typedef typename Level::scalar_t    scalar_t;
    typedef typename Level::umap_t      umap_t;
    typedef typename Level::basefab_t   basefab_t;
    typedef amr::AmrIntVect_t           AmrIntVect_t;
    
public:
    
    virtual ~AmrInterpolater() = default;
 
    AmrInterpolater(lo_t nPoints) : nPoints_m(nPoints) { }
    
    const lo_t& getNumberOfPoints() const {
        return nPoints_m;
    }
    
    virtual void stencil(const AmrIntVect_t& iv,
                         const basefab_t& fab,
                         umap_t& map,
                         const scalar_t& scale,
                         Level* mglevel) = 0;
    
    virtual void coarse(const AmrIntVect_t& iv,
                        umap_t& map,
                        const scalar_t& scale,
                        lo_t dir, lo_t shift, const basefab_t& rfab,
                        const AmrIntVect_t& riv,
                        Level* mglevel) = 0;
    
    virtual void fine(const AmrIntVect_t& /*iv*/,
                      umap_t& /*map*/,
                      const scalar_t& /*scale*/,
                      lo_t /*dir*/, lo_t /*shift*/, const basefab_t& /*fab*/,
                      Level* /*mglevel*/)
    { };
 
    virtual void fine(const AmrIntVect_t& /*iv*/,
                      umap_t& /*map*/,
                      const scalar_t& /*scale*/,
                      lo_t /*dir*/, lo_t /*shift*/,
                      Level* /*mglevel*/)
    { };
    
protected:
    const lo_t nPoints_m;    
};
 
#endif