corsika-tape.h

Go to the documentation of this file.

/*****************************************************************************/
/*                                                                           */
/* Define the data structures for the CORSIKA output file                    */
/*                                                                           */
/* Lukas Nellen, 18-September-1997                                           */
/*                                                                           */
/*****************************************************************************/

#ifndef CORSIKA_TAPE_H
#define CORSIKA_TAPE_H

#include <string.h>
#include <stdio.h>

#define RWORD float             /* 4 byte real */
#define IWORD int               /* 4 byte integer */
#ifndef BLOCK_PAD_B
#  define BLOCK_PAD_B 4         /* extra bytes at beginning of block */
#endif
#ifndef BLOCK_PAD_E
#  define BLOCK_PAD_E 4         /* extra bytes at end of block */
#endif

#define MAX_OBSERVATION_LEVELS 10
#define SUB_BLOCKS_IN_BLOCK    21
#define PARTICLES_IN_SUB_BLOCK 39

#define RUN_HEADER_ID "RUNH"
#define is_run_header(r) (memcmp(r, RUN_HEADER_ID, 4) == 0)
typedef struct {
  char id[4];                   /* is "RUNH" */
  RWORD run_number;
  RWORD date_start;
  RWORD version;

  RWORD observation_levels;
  RWORD observation_height[MAX_OBSERVATION_LEVELS]; /* in cm */

  RWORD spectral_slope;
  RWORD e_min;                  /* in GeV */
  RWORD e_max;                  /* in GeV */

  RWORD flag_egs4;
  RWORD flag_nkg;

  RWORD cutoff_hadrons;         /* in GeV */
  RWORD cutoff_muons;           /* in GeV */
  RWORD cutoff_electrons;       /* in GeV */
  RWORD cutoff_photons;         /* in GeV */

  RWORD const_c[50];
  RWORD const_cc[20];
  RWORD const_cka[40];
  RWORD const_ceta[5];
  RWORD const_cstrba[11];
  RWORD const_unused[4];
  RWORD const_can[50];
  RWORD const_cann[50];
  RWORD const_aatm[5];
  RWORD const_batm[5];
  RWORD const_catm[5];
  RWORD const_nflain;
  RWORD const_nfldif;
  RWORD const_nflpi;
  RWORD const_nflche;

#ifdef THINNING
  RWORD pad[39];
#endif
} run_header;


#define RUN_END_ID "RUNE"
#define is_run_end(r) (memcmp(r, RUN_END_ID, 4) == 0)
typedef struct {
  char id[4];                   /* is "RUNE" */
  RWORD run_number;
  RWORD events_processed;
#ifndef THINNING
  RWORD pad[270];
#else
  RWORD pad[309];
#endif
} run_end;


#define EVENT_HEADER_ID "EVTH"
#define is_event_header(r) (memcmp(r, EVENT_HEADER_ID, 4) == 0)
typedef struct {
  char id[4];                   /* is "EVTH"  */
  RWORD event_number;

  RWORD particle_id;
  RWORD energy;
  RWORD starting_altitude;      /* in g/cm^2 */
  RWORD first_target;
  RWORD z_first;                /* in cm */
  RWORD px;                     /* in GeV */
  RWORD py;                     /* in GeV */
  RWORD pz;                     /* in GeV */
  RWORD theta;                  /* zenith angle, in rad */
  RWORD phi;                    /* azimuthal angle, in rad */

  RWORD random_sequences;
  struct {
    RWORD seed;
    RWORD initial_calls_mod;
    RWORD initial_calls_div;
  } seeds[10];

  RWORD run_number;
  RWORD date_start;
  RWORD version;

  RWORD observation_levels;
  RWORD observation_height[MAX_OBSERVATION_LEVELS]; /* in cm */

  RWORD spectral_slope;
  RWORD e_min;                  /* in GeV */
  RWORD e_max;                  /* in GeV */

  RWORD cutoff_hadrons;         /* in GeV */
  RWORD cutoff_muons;           /* in GeV */
  RWORD cutoff_electrons;       /* in GeV */
  RWORD cutoff_photons;         /* in GeV */

  RWORD nflain;
  RWORD nfldif;
  RWORD nflpi0;
  RWORD nflpif;
  RWORD nflche;
  RWORD nfragm;

  RWORD bx;                     /* magnetic field in mu T */
  RWORD bz;                     /* magnetic field in mu T */
  RWORD flag_egs4;
  RWORD flag_nkg;

  RWORD flag_gheisha;
  RWORD flag_venus;
  RWORD flag_cerenkov;
  RWORD flag_neutrino;
  RWORD flag_horizontal;
  RWORD flag_computer;          /* 1:IBM, 2:Transputer, 3: DEC/UNIX
                                   4:Macintosh, 5:VAX/VMS 6:LINUX */
  RWORD theta_min;              /* in degrees */
  RWORD theta_max;              /* in degrees */
  RWORD phi_min;                /* in degrees */
  RWORD phi_max;                /* in degrees */

  RWORD cerenkov_bunch;
  RWORD cerenkov_number_x;
  RWORD cerenkov_number_y;
  RWORD cerenkov_grid_x;        /* in cm */
  RWORD cerenkov_grid_y;        /* in cm */
  RWORD cerenkov_detector_x;    /* in cm */
  RWORD cerenkov_detector_y;    /* in cm */
  RWORD cerenkov_output_flag;

  RWORD array_rotation;
  RWORD flag_extra_muon_information;

  RWORD multiple_scatternig_step;
  RWORD cerenkov_bandwidth_min; /* in nm */
  RWORD cerenkov_bandwidth_max; /* in nm */
  RWORD uses_of_event;
  RWORD core_x[20];             /* in cm */
  RWORD core_y[20];             /* in cm */

  RWORD flag_sybill;
  RWORD flag_sybill_cross;
  RWORD flag_qgsjet;
  RWORD flag_qgsjet_cross;
  RWORD flag_dpmjet;
  RWORD flag_dpmjet_cross;
  RWORD flag_venus_cross;
  RWORD flag_muon_multiple;     /* 0:Gauss, 1:Moliere */
  RWORD efrcthn;                /* energy fracion of thinning level */
  RWORD nkg_radial_range;       /* in cm */

#ifndef THINNING
  RWORD pad[125];
#else
  RWORD pad[164];
#endif
} event_header;


#define EVENT_END_ID "EVTE"
#define is_event_end(r) (memcmp(r, EVENT_END_ID, 4) == 0)
typedef struct {
  char id[4];                   /* is "EVTE" */
  RWORD event_number;

  RWORD photons;
  RWORD electrons;
  RWORD hadrons;
  RWORD muons;
  RWORD particles;

  /* NKG output */
  RWORD lateral1_x[21];         /* in cm^{-2} */
  RWORD lateral1_y[21];         /* in cm^{-2} */
  RWORD lateral1_xy[21];        /* in cm^{-2} */
  RWORD lateral1_yx[21];        /* in cm^{-2} */

  RWORD lateral2_x[21];         /* in cm^{-2} */
  RWORD lateral2_y[21];         /* in cm^{-2} */
  RWORD lateral2_xy[21];        /* in cm^{-2} */
  RWORD lateral2_yx[21];        /* in cm^{-2} */

  RWORD electron_number[10];    /* in steps of 100 g/cm^2 */
  RWORD age[10];                /* in steps of 100 g/cm^2 */
  RWORD distances[10];          /* in cm */
  RWORD local_age1[10];

  RWORD level_height_mass[10];  /* in g/cm^2 */
  RWORD level_height_distance[10]; /* in cm */
  RWORD distance_bins_age[10];  /* in cm */
  RWORD local_age2[10];

  /* longitudinal distribution */
  RWORD longitudinal_par[6];
  RWORD chi2;

#ifndef THINNING
  RWORD pad[11];
#else
  RWORD pad[50];
#endif
} event_end;

#define is_control(r) (is_run_header(r) || is_event_header(r) || \
                       is_run_end(r)    || is_event_end(r))


/* The data records have the (numercial) particle code as an id */
#define is_particle_r(p) (((p)>0) && ((p)<100000))
#define is_nucleus_r(p) (((p)>=100000) && ((p)<9900000))
#define is_cerenkov_r(p) ((p)>=9900000)
typedef struct {
  RWORD description;
  RWORD px;                     /* in GeV */
  RWORD py;                     /* in GeV */
  RWORD pz;                     /* in GeV */
  RWORD x;                      /* in cm */
  RWORD y;                      /* in cm */
  RWORD torz;                   /* in nsec or cm */
#ifdef THINNING
  RWORD weight;
#endif
} particle_data;

typedef struct {
  particle_data particle[PARTICLES_IN_SUB_BLOCK];
} particle_sub_block;

typedef struct {
    RWORD photons_in_bunch;
    RWORD x;                    /* in cm */
    RWORD y;                    /* in cm */
    RWORD u;                    /* in cos to x axis */
    RWORD v;                    /* in cos to y axis */
    RWORD t;                    /* in ns */
    RWORD production_height;    /* in cm */
#ifdef THINNING
    RWORD weight;
#endif
} cerenkov_data;

typedef struct {
  cerenkov_data particle[PARTICLES_IN_SUB_BLOCK];
} cerenkov_sub_block;

typedef union {
  run_header rh;
  run_end re;
  event_header eh;
  event_end ee;
  particle_sub_block pb;
  cerenkov_sub_block cb;
} sub_block ;

typedef struct {
#if BLOCK_PAD_B
  char pad_b[BLOCK_PAD_B];      /* initial padding of each block */
#endif
  sub_block sb[SUB_BLOCKS_IN_BLOCK];
#if BLOCK_PAD_E
  char pad_e[BLOCK_PAD_E];      /* final padding of each block */
#endif
} block;


/* routines to manipulate CORSIKA blocked files */
typedef struct {
  FILE *file;
  block bl;
  int sub_index;
} corsika_file;

corsika_file *corsika_fopen(char *name, char *mode);
sub_block    *corsika_get(corsika_file *file);

#endif