types.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2012,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 TYPES_HPP
#define TYPES_HPP 1


enum geom_mode_e {
    MODE_1D = 0, 
    MODE_2D,     
    MODE_CYL,    
    MODE_3D      
};


enum field_extrpl_e {
    FIELD_EXTRAPOLATE = 0,     
    FIELD_MIRROR,              
    FIELD_ANTIMIRROR,          
    FIELD_SYMMETRIC_POTENTIAL, 
    FIELD_ZERO,                
    FIELD_NAN                  
};


enum field_type_e {
    FIELD_NONE = 0,   
    FIELD_EPOT,       
    FIELD_SCHARGE,    
    FIELD_TRAJDENS,   
    FIELD_EFIELD,     
    FIELD_EFIELD_X,   
    FIELD_EFIELD_Y,   
    FIELD_EFIELD_Z,   
    FIELD_BFIELD,     
    FIELD_BFIELD_X,   
    FIELD_BFIELD_Y,   
    FIELD_BFIELD_Z    
};


typedef field_type_e field_diag_type_e;


enum bound_e {
    BOUND_DIRICHLET = 0, 
    BOUND_NEUMANN        
};


#define PARTICLE_T   0

#define PARTICLE_X   1

#define PARTICLE_VX  2

#define PARTICLE_Y   3

#define PARTICLE_VY  4

#define PARTICLE_R   3

#define PARTICLE_VR  4

#define PARTICLE_W   5

#define PARTICLE_Z   5

#define PARTICLE_VZ  6


enum trajectory_interpolation_e {
    TRAJECTORY_INTERPOLATION_POLYNOMIAL = 0, 
    TRAJECTORY_INTERPOLATION_LINEAR          
};


enum scharge_deposition_e {
    SCHARGE_DEPOSITION_PIC = 0,  
    SCHARGE_DEPOSITION_LINEAR    
};


enum coordinate_axis_e {
    AXIS_X = 0, 
    AXIS_Y,     
    AXIS_R,     
    AXIS_Z      
};


extern const char *coordinate_axis_string[];


extern const char *coordinate_axis_string_with_unit[];


enum trajectory_diagnostic_e {
    DIAG_NONE = 0, 
    DIAG_T,        
    DIAG_X,        
    DIAG_VX,       
    DIAG_Y,        
    DIAG_R,        
    DIAG_VY,       
    DIAG_VR,       
    DIAG_W,        
    DIAG_VTHETA,   
    DIAG_Z,        
    DIAG_VZ,       
    DIAG_O,        
    DIAG_VO,       
    DIAG_P,        
    DIAG_VP,       
    DIAG_Q,        
    DIAG_VQ,       
    DIAG_XP,       
    DIAG_YP,       
    DIAG_RP,       
    DIAG_AP,       
    DIAG_ZP,       
    DIAG_OP,       
    DIAG_PP,       
    DIAG_CURR,     
    DIAG_EK,       
    DIAG_QM,       
    DIAG_CHARGE,   
    DIAG_MASS,     
    DIAG_NO        
};


extern const char *trajectory_diagnostic_string[];


extern const char *trajectory_diagnostic_string_with_unit[];


extern const char *trajectory_diagnostic_string_unit[];


#endif