particledatabase.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2014 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library 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 library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef PARTICLEDATABASE_HPP
#define PARTICLEDATABASE_HPP 1


#include "scalarfield.hpp"
#include "vectorfield.hpp"
#include "particles.hpp"
#include "trajectorydiagnostics.hpp"
#include "particlestatistics.hpp"
#include "constants.hpp"
#include "types.hpp"


class TrajectoryHandlerCallback {
public:

    virtual ~TrajectoryHandlerCallback() {}

    virtual void operator()( ParticleBase *particle, ParticlePBase *xcur, ParticlePBase *xend ) = 0;
};


class TrajectoryEndCallback {
public:

    virtual ~TrajectoryEndCallback() {}

    virtual void operator()( ParticleBase *particle, class ParticleDataBase *pdb ) = 0;
};


class TrajectorySurfaceCollisionCallback {
public:

    virtual ~TrajectorySurfaceCollisionCallback() {}

    virtual void operator()( ParticleBase *particle, ParticlePBase *x, uint32_t tri, 
                             double s, double t ) = 0;
};


class PPlasmaBfieldSuppression : public CallbackFunctorD_V {

    double                 _phi;    
    const MeshScalarField &_epot;   
public:

    PPlasmaBfieldSuppression( const MeshScalarField &epot, double phi ) 
        : _phi(phi), _epot(epot) {}

    ~PPlasmaBfieldSuppression() {}

    virtual double operator()( const Vec3D &x ) const {
        if( _epot( x ) > _phi )
            return( 0.0 );
        return( 1.0 );
    }
};


class NPlasmaBfieldSuppression : public CallbackFunctorD_V {

    double             _phi;    
    const MeshScalarField &_epot;   
public:

    NPlasmaBfieldSuppression( const MeshScalarField &epot, double phi ) 
        : _phi(phi), _epot(epot) {}

    ~NPlasmaBfieldSuppression() {}
    
    virtual double operator()( const Vec3D &x ) const {
        if( _epot( x ) < _phi )
            return( 0.0 );
        return( 1.0 );
    }
};


/* ******************************************************************************************* *
 * ParticleDataBase classes                                                                    *
 * ******************************************************************************************* */


class ParticleDataBase {

    class ParticleDataBaseImp *_imp;
    
protected:

/* ************************************** *
 * Constructors                           *
 * ************************************** */

    ParticleDataBase();

    ParticleDataBase( const ParticleDataBase &pdb );

    const ParticleDataBase &operator=( const ParticleDataBase &pdb );

    void set_implementation_pointer( class ParticleDataBaseImp *imp );

public:

/* ************************************** *
 * Destructor                             *
 * ************************************** */

    virtual ~ParticleDataBase();

/* ****************************************** *
 * Particle iteration settings and statictics *
 * ****************************************** */

    void set_thread_count( uint32_t threadcount ) {}

    void set_accuracy( double epsabs, double epsrel );

    void set_bfield_suppression( const CallbackFunctorD_V *functor );

    void set_trajectory_handler_callback( TrajectoryHandlerCallback *thand_cb );

    void set_trajectory_end_callback( TrajectoryEndCallback *tend_cb );

    void set_trajectory_surface_collision_callback( TrajectorySurfaceCollisionCallback *tsur_cb );

    void set_relativistic( bool enable );

    void set_surface_collision( bool surface_collision );

    void set_polyint( bool polyint );
    
    bool get_polyint( void ) const;
    
    void set_trajectory_interpolation( trajectory_interpolation_e intrp );

    trajectory_interpolation_e get_trajectory_interpolation( void ) const;

    void set_scharge_deposition( scharge_deposition_e type );

    scharge_deposition_e get_scharge_deposition( void ) const;

    void set_max_steps( uint32_t maxsteps );

    void set_max_time( double maxt );

    void set_save_all_points( bool save_points );

    void set_save_trajectories( uint32_t div );

    uint32_t get_save_trajectories( void ) const;

    void set_mirror( const bool mirror[6] );

    void get_mirror( bool mirror[6] ) const;

    int get_iteration_number( void ) const;

    double get_rhosum( void ) const;

    void set_rhosum( double rhosum );

    const ParticleStatistics &get_statistics( void ) const;

/* ************************************** *
 * Information and queries                *
 * ************************************** */

    geom_mode_e geom_mode() const;

    size_t size( void ) const;

    virtual ParticleBase &particle( uint32_t i ) = 0;

    virtual const ParticleBase &particle( uint32_t i ) const = 0;

    double traj_length( uint32_t i ) const;
    
    size_t traj_size( uint32_t i ) const;
    
    virtual const ParticlePBase &trajectory_point( uint32_t i, uint32_t j ) const = 0;

    void trajectory_point( double &t, Vec3D &loc, Vec3D &vel, uint32_t i, uint32_t j ) const;

    void trajectories_at_plane( TrajectoryDiagnosticData &tdata, 
                                coordinate_axis_e axis,
                                double val,
                                const std::vector<trajectory_diagnostic_e> &diagnostics ) const;

    void build_trajectory_density_field( MeshScalarField &tdens ) const;

/* ************************************** *
 * Particle and trajectory clearing       *
 * ************************************** */

    void clear( void );

    void clear_trajectories( void );

    void clear_trajectory( size_t a );

/* ************************************** *
 * Particle definition                    *
 * ************************************** */

    void reserve( size_t size );

/* ************************************** *
 * Particle iterators                     *
 * ************************************** */

    void iterate_trajectories( MeshScalarField &scharge, const VectorField &efield, 
                               const VectorField &bfield );

    void step_particles( MeshScalarField &scharge, const VectorField &efield, 
                         const VectorField &bfield, double dt );

/* ************************************** *
 * Debugging, plotting and saving         *
 * ************************************** */

    virtual void save( const std::string &filename ) const = 0;

    virtual void save( std::ostream &os ) const = 0;

    virtual void debug_print( std::ostream &os ) const = 0;
};


class ParticleDataBase2D : public ParticleDataBase {

    class ParticleDataBase2DImp *_imp;

public:

/* ************************************** *
 * Constructors and destructor            *
 * ************************************** */

    ParticleDataBase2D( const Geometry &geom );

    ParticleDataBase2D( const ParticleDataBase2D &pdb );

    ParticleDataBase2D( std::istream &s, const Geometry &geom );

    ~ParticleDataBase2D();

    const ParticleDataBase2D &operator=( const ParticleDataBase2D &pdb );
    
/* ************************************** *
 * Information and queries                *
 * ************************************** */

    virtual Particle2D &particle( uint32_t i );

    virtual const Particle2D &particle( uint32_t i ) const;
    
    virtual const ParticleP2D &trajectory_point( uint32_t i, uint32_t j ) const;

    using ParticleDataBase::trajectory_point;

    void trajectories_at_plane( std::vector<Particle2D> &tdata,
                                coordinate_axis_e axis,
                                double val ) const;

    using ParticleDataBase::trajectories_at_plane;

/* ************************************** *
 * Particle definition                    *
 * ************************************** */

    void add_particle( double IQ, double q, double m, const ParticleP2D &x );

    void add_particle( const Particle2D &p );

/* ************************************** *
 * Particle beam definition               *
 * ************************************** */

    void add_2d_beam_with_energy( uint32_t N, double J, double q, double m, 
                                  double E, double Tp, double Tt, 
                                  double x1, double y1, double x2, double y2 );

    void add_2d_beam_with_velocity( uint32_t N, double J, double q, double m, 
                                    double v, double dvp, double dvt, 
                                    double x1, double y1, double x2, double y2 );

    void add_2d_KV_beam_with_emittance( uint32_t N, double I, double q, double m,
                                        double a, double b, double e,
                                        double Ex, double x0, double y0 );

    void add_2d_gaussian_beam_with_emittance( uint32_t N, double I, double q, double m,
                                              double a, double b, double e,
                                              double Ex, double x0, double y0 );

/* ************************************** *
 * Debugging, plotting and saving         *
 * ************************************** */

    virtual void save( const std::string &filename ) const;

    virtual void save( std::ostream &s ) const;

    virtual void debug_print( std::ostream &os ) const;
};




class ParticleDataBaseCyl : public ParticleDataBase {

    class ParticleDataBaseCylImp *_imp;

public:

/* ************************************** *
 * Constructors and destructor            *
 * ************************************** */

    ParticleDataBaseCyl( const Geometry &geom );

    ParticleDataBaseCyl( const ParticleDataBaseCyl &pdb );

    ParticleDataBaseCyl( std::istream &s, const Geometry &geom );

    ~ParticleDataBaseCyl();

    const ParticleDataBaseCyl &operator=( const ParticleDataBaseCyl &pdb );

/* ************************************** *
 * Information and queries                *
 * ************************************** */

    virtual ParticleCyl &particle( uint32_t i );

    virtual const ParticleCyl &particle( uint32_t i ) const;
    
    virtual const ParticlePCyl &trajectory_point( uint32_t i, uint32_t j ) const;

    using ParticleDataBase::trajectory_point;

    void trajectories_at_plane( std::vector<ParticleCyl> &tdata,
                                coordinate_axis_e axis,
                                double val ) const;

    using ParticleDataBase::trajectories_at_plane;

    void export_path_manager_data( const std::string &filename, 
                                   double ref_E, double ref_q, double ref_m, 
                                   double val, uint32_t Np ) const;

/* ************************************** *
 * Particle definition                    *
 * ************************************** */

    void add_particle( double IQ, double q, double m, const ParticlePCyl &x );

    void add_particle( const ParticleCyl &p );

 /* ************************************** *
 * Particle beam definition               *
 * ************************************** */

    void add_2d_beam_with_energy( uint32_t N, double J, double q, double m, 
                                  double E, double Tp, double Tt, 
                                  double x1, double y1, double x2, double y2 );

    void add_2d_beam_with_total_energy( uint32_t N, double J, double q, double m, 
                                        double Etot, const ScalarField &epot, 
                                        double Tp, double Tt, 
                                        double x1, double y1, double x2, double y2 );

    void add_2d_beam_with_velocity( uint32_t N, double J, double q, double m, 
                                    double v, double dvp, double dvt, 
                                    double x1, double y1, double x2, double y2 );

    void add_2d_full_gaussian_beam( uint32_t N, double I, double q, double m,
                                    double Ex, double Tp, double Tt, 
                                    double x0, double dr );

    void add_2d_gaussian_beam_with_emittance( uint32_t N, double I, double q, double m,
                                              double a, double b, double e,
                                              double Ex, double x0 );

/* ************************************** *
 * Debugging, plotting and saving         *
 * ************************************** */

    virtual void save( const std::string &filename ) const;

    virtual void save( std::ostream &s ) const;

    virtual void debug_print( std::ostream &os ) const;
};



class ParticleDataBase3D : public ParticleDataBase {

    class ParticleDataBase3DImp *_imp;

public:

/* ************************************** *
 * Constructors and destructor            *
 * ************************************** */

    ParticleDataBase3D( const Geometry &geom );

    ParticleDataBase3D( const ParticleDataBase3D &pdb );

    ParticleDataBase3D( std::istream &s, const Geometry &geom );

    ~ParticleDataBase3D();

    const ParticleDataBase3D &operator=( const ParticleDataBase3D &pdb );

/* ************************************** *
 * Information and queries                *
 * ************************************** */

    virtual Particle3D &particle( uint32_t i );

    virtual const Particle3D &particle( uint32_t i ) const;
    
    virtual const ParticleP3D &trajectory_point( uint32_t i, uint32_t j ) const;

    using ParticleDataBase::trajectory_point;

    void trajectories_at_plane( std::vector<Particle3D> &tdata,
                                coordinate_axis_e axis,
                                double val ) const;

    using ParticleDataBase::trajectories_at_plane;

/* ************************************** *
 * Particle definition                    *
 * ************************************** */

    void add_particle( double IQ, double q, double m, const ParticleP3D &x );

    void add_particle( const Particle3D &p );

/* ************************************** *
 * Particle beam definition               *
 * ************************************** */


    void add_cylindrical_beam_with_total_energy( uint32_t N, double J, double q, double m, 
                                                 double Etot, const ScalarField &epot, 
                                                 double Tp, double Tt, Vec3D c, 
                                                 Vec3D dir1, Vec3D dir2, double r );

    void add_cylindrical_beam_with_energy( uint32_t N, double J, double q, double m, 
                                           double E, double Tp, double Tt, Vec3D c, 
                                           Vec3D dir1, Vec3D dir2, double r );

    void add_cylindrical_beam_with_velocity( uint32_t N, double J, double q, double m, 
                                             double v, double dvp, double dvt, Vec3D c, 
                                             Vec3D dir1, Vec3D dir2, double r );

    void add_rectangular_beam_with_energy( uint32_t N, double J, double q, double m, 
                                           double E, double Tp, double Tt, Vec3D c, 
                                           Vec3D dir1, Vec3D dir2, double size1, double size2 );

    void add_rectangular_beam_with_velocity( uint32_t N, double J, double q, double m, 
                                             double v, double dvp, double dvt, Vec3D c, 
                                             Vec3D dir1, Vec3D dir2, double size1, double size2 );


    void add_3d_KV_beam_with_emittance( uint32_t N, double I, double q, double m,
                                        double E0,
                                        double a1, double b1, double e1,
                                        double a2, double b2, double e2,
                                        Vec3D c, Vec3D dir1, Vec3D dir2 );

    void add_3d_waterbag_beam_with_emittance( uint32_t N, double I, double q, double m,
                                              double E0,
                                              double a1, double b1, double e1,
                                              double a2, double b2, double e2,
                                              Vec3D c, Vec3D dir1, Vec3D dir2 );
    
    void add_3d_gaussian_beam_with_emittance( uint32_t N, double I, double q, double m,
                                              double E0, 
                                              double a1, double b1, double e1,
                                              double a2, double b2, double e2,
                                              Vec3D c, Vec3D dir1, Vec3D dir2 );


/* ************************************** *
 * Information and queries                *
 * ************************************** */


    void trajectories_at_free_plane( TrajectoryDiagnosticData &tdata, 
                                     const Vec3D &c, const Vec3D &o, const Vec3D &p,
                                     const std::vector<trajectory_diagnostic_e> &diagnostics ) const;


    void export_path_manager_data( const std::string &filename, 
                                   double ref_E, double ref_q, double ref_m, 
                                   const Vec3D &c, const Vec3D &o, const Vec3D &p ) const;

/* ************************************** *
 * Debugging, plotting and saving         *
 * ************************************** */

    virtual void save( const std::string &filename ) const;

    virtual void save( std::ostream &s ) const;

    virtual void debug_print( std::ostream &os ) const;
};

#endif