BoxLibParticle.h

Go to the documentation of this file.

//
// Class BoxLibParticle
//   Particle class for AMReX. It works together with BoxLibLayout.
//   The class does the scatter and gather operations of attributes
//   to and from the grid. Ippl implements the same functionality in the
//   attribute class.
//
// Copyright (c) 2016 - 2020, Matthias Frey, Uldis Locans, 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 BOXLIB_PARTICLE_H
#define BOXLIB_PARTICLE_H

#include "AmrParticle/AmrParticleBase.h"

#include <AMReX_REAL.H>
#include <AMReX_IntVect.H>
#include <AMReX_Vector.H>
#include <AMReX_Utility.H>
#include <AMReX_Geometry.H>
#include <AMReX_RealBox.H>


template<class PLayout>
class BoxLibParticle: public virtual AmrParticleBase<PLayout> {

public:
    typedef typename AmrParticleBase<PLayout>::ParticlePos_t             ParticlePos_t;
    typedef typename AmrParticleBase<PLayout>::ParticleIndex_t           ParticleIndex_t;
    typedef typename AmrParticleBase<PLayout>::SingleParticlePos_t       SingleParticlePos_t;
    typedef typename AmrParticleBase<PLayout>::AmrField_t                AmrField_t;
    // Array<std::unique_ptr<MultiFab> >
    typedef typename AmrParticleBase<PLayout>::AmrScalarFieldContainer_t AmrScalarFieldContainer_t;
    typedef typename AmrParticleBase<PLayout>::AmrVectorFieldContainer_t AmrVectorFieldContainer_t;
    typedef typename AmrParticleBase<PLayout>::AmrVectorField_t          AmrVectorField_t;
    typedef typename AmrParticleBase<PLayout>::ParticleLevelCounter_t    ParticleLevelCounter_t;

    typedef typename PLayout::AmrProcMap_t  AmrProcMap_t;
    typedef typename PLayout::AmrGrid_t     AmrGrid_t;
    typedef typename PLayout::AmrGeometry_t AmrGeometry_t;
    typedef typename PLayout::AmrIntVect_t  AmrIntVect_t;
    typedef typename PLayout::AmrBox_t      AmrBox_t;
    typedef typename PLayout::AmrReal_t     AmrReal_t;

    typedef amrex::FArrayBox                FArrayBox_t;

public:
    BoxLibParticle();

    BoxLibParticle(PLayout *layout);

    template <class FT, unsigned Dim, class PT>
    void scatter(ParticleAttrib<FT>& attrib, AmrScalarFieldContainer_t& f,
                 ParticleAttrib<Vektor<PT, Dim> >& pp,
                 int lbase, int lfine,
                 const ParticleAttrib<int>& pbin, int bin = -1);

    template <class FT, unsigned Dim, class PT>
    void scatter(ParticleAttrib<FT>& attrib, AmrField_t& f,
                 ParticleAttrib<Vektor<PT, Dim> >& pp,
                 const ParticleAttrib<int>& pbin, int bin = -1,
                 int level = 0);

    template <class FT, unsigned Dim, class PT>
    void gather(ParticleAttrib<FT>& attrib, AmrVectorFieldContainer_t& f,
                ParticleAttrib<Vektor<PT, Dim> >& pp,
                int lbase, int lfine);

private:
    /*
     * AMReX functions adjusted to work with Ippl
     */

    template <class AType>
    void AssignDensityFort(ParticleAttrib<AType>& pa,
                           AmrScalarFieldContainer_t& mf_to_be_filled, 
                           int lev_min, int ncomp, int finest_level,
                           const ParticleAttrib<int>& pbin, int bin = -1) const;

    template <class AType>
    void InterpolateFort(ParticleAttrib<AType> &pa,
                         AmrVectorFieldContainer_t& mesh_data, 
                         int lev_min, int lev_max);

    template <class AType>
    void InterpolateSingleLevelFort(ParticleAttrib<AType> &pa, AmrVectorField_t& mesh_data, int lev);

    template <class AType>
    void InterpolateMultiLevelFort(ParticleAttrib<AType>& pa,
                                   AmrVectorFieldContainer_t& mesh_data,
                                   int lev);

    template <class AType>
    void AssignCellDensitySingleLevelFort(ParticleAttrib<AType>& pa, AmrField_t& mf, int level,
                                          const ParticleAttrib<int>& pbin, int bin = -1,
                                          int ncomp=1, int particle_lvl_offset = 0) const;

private:
    IpplTimings::TimerRef AssignDensityTimer_m;
};


#include "Amr/BoxLibParticle.hpp"

#endif