FMGPoissonSolver.h

Go to the documentation of this file.

//
// Class FMGPoissonSolver
//   Interface to the Fortran based AMR Poisson multigrid solver of BoxLib.
//   The Fortran solver is part of AMReX till version 18.07
//   (Link: https://github.com/AMReX-Codes/amrex/archive/18.07.tar.gz)
//
// Copyright (c) 2016 - 2020, Matthias Frey, Paul Scherrer Institute, 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 FMG_POISSON_SOLVER_H_
#define FMG_POISSON_SOLVER_H_
 
#include "Solvers/AmrPoissonSolver.h"
#include "Amr/AmrBoxLib.h"
 
#include <AMReX_MultiFabUtil.H>
#include <AMReX_BLFort.H>
#include <AMReX_FMultiGrid.H>
 
class FMGPoissonSolver : public AmrPoissonSolver< AmrBoxLib > {
    
private:
    typedef AmrBoxLib::AmrGeomContainer_t GeomContainer_t;
    typedef amrex::Vector<AmrBoxLib::AmrField_t*> AmrFieldContainer_pt;
    typedef AmrBoxLib::AmrGeometry_t AmrGeometry_t;
    typedef AmrBoxLib::AmrGrid_t AmrGrid_t;
    typedef AmrBoxLib::AmrProcMap_t           AmrProcMap_t;
    typedef AmrBoxLib::AmrScalarFieldContainer_t    AmrScalarFieldContainer_t;
    typedef AmrBoxLib::AmrVectorFieldContainer_t    AmrVectorFieldContainer_t;
    
public:
    
    FMGPoissonSolver(AmrBoxLib* itsAmrObject_p);
    
    void solve(AmrScalarFieldContainer_t &rho,
               AmrScalarFieldContainer_t& phi,
               AmrVectorFieldContainer_t &efield,
               unsigned short baseLevel,
               unsigned short finestLevel,
               bool prevAsGuess = true);
    
    double getXRangeMin(unsigned short level = 0);
    double getXRangeMax(unsigned short level = 0);
    double getYRangeMin(unsigned short level = 0);
    double getYRangeMax(unsigned short level = 0);
    double getZRangeMin(unsigned short level = 0);
    double getZRangeMax(unsigned short level = 0);
    
    
    Inform &print(Inform &os) const;
    
    
private:
    
    void initParameters_m();
    
    double solveWithF90_m(const AmrFieldContainer_pt& rho,
                          const AmrFieldContainer_pt& phi,
                          const amrex::Vector< AmrFieldContainer_pt >& grad_phi_edge, 
                          const GeomContainer_t& geom,
                          int baseLevel,
                          int finestLevel);
    
    /*
    void interpolate_m(AmrScalarFieldContainer_t& phi, const GeomContainer_t& geom,
                       double l0norm, int finestLevel);
    */
private:
    int bc_m[2*AMREX_SPACEDIM];        
    double reltol_m;                
    double abstol_m;                
};
 
 
inline Inform &operator<<(Inform &os, const FMGPoissonSolver &fs) {
    return fs.print(os);
}
 
#endif