PoissonSolver.h

Go to the documentation of this file.

#ifndef POISSON_SOLVER_H_
#define POISSON_SOLVER_H_

#include "Algorithms/PBunchDefs.h"

#ifdef ENABLE_AMR
    #include "Utilities/OpalException.h"
#endif
template <class T, unsigned Dim>
class PartBunchBase;

class PoissonSolver {
public:

    // given a charge-density field rho and a set of mesh spacings hr,
    // compute the scalar potential in open space
    virtual void computePotential(Field_t &rho, Vector_t hr) = 0;
    
#ifdef ENABLE_AMR

    virtual void solve(AmrScalarFieldContainer_t &rho,
                       AmrScalarFieldContainer_t &phi,
                       AmrVectorFieldContainer_t &efield,
                       unsigned short baseLevel,
                       unsigned short finestLevel,
                       bool prevAsGuess = true)
    {
        throw OpalException("PoissonSolver::solve()", "Not supported for non-AMR code.");
    };
    
    virtual void hasToRegrid() {
        throw OpalException("PoissonSolver::hasToRegrid()", "Not supported for non-AMR code.");
    }
#endif
                                  
    virtual void computePotential(Field_t &rho, Vector_t hr, double zshift) = 0;

    virtual double getXRangeMin(unsigned short level = 0) = 0;
    virtual double getXRangeMax(unsigned short level = 0) = 0;
    virtual double getYRangeMin(unsigned short level = 0) = 0;
    virtual double getYRangeMax(unsigned short level = 0) = 0;
    virtual double getZRangeMin(unsigned short level = 0) = 0;
    virtual double getZRangeMax(unsigned short level = 0) = 0;
    virtual void test(PartBunchBase<double, 3> *bunch) = 0 ;
    virtual ~PoissonSolver(){};

};

inline Inform &operator<<(Inform &os, const PoissonSolver &fs) {
    return os << "";
}

#endif