egs_interface2.h

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc simple C interface headers
#  Copyright (C) 2015 National Research Council Canada
#
#  This file is part of EGSnrc.
#
#  EGSnrc is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the
#  Free Software Foundation, either version 3 of the License, or (at your
#  option) any later version.
#
#  EGSnrc 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 Affero General Public License for
#  more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with EGSnrc. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
#
#  Author:          Iwan Kawrakow, 2003
#
#  Contributors:    Ernesto Mainegra-Hing
#                   Blake Walters
#                   Reid Townson
#
###############################################################################
*/


#ifndef EGS_INTERFACE1_
#define EGS_INTERFACE1_

#include "egs_config1.h"

/* Note: The C-preprocessor macros MXMED and MXSTACK must be defined in the
   file array_sizes.h. */
#include "array_sizes.h"

#define MXAUS 35  /* there are 35 different calls to ausgab */

struct EGS_Stack {
  double    E[MXSTACK];
  EGS_Float x[MXSTACK];
  EGS_Float y[MXSTACK];
  EGS_Float z[MXSTACK];
  EGS_Float u[MXSTACK];
  EGS_Float v[MXSTACK];
  EGS_Float w[MXSTACK];
  EGS_Float dnear[MXSTACK];
  EGS_Float wt[MXSTACK];
  EGS_I32   iq[MXSTACK];
  EGS_I32   ir[MXSTACK];
  EGS_I32   latch[MXSTACK];
  EGS_I32   latchi;
  EGS_I32   np;
  EGS_I32   npold;
};

struct EGS_Bounds {
    EGS_Float ecut;
    EGS_Float pcut;
    EGS_Float ecut_new;
    EGS_Float pcut_new;
    EGS_Float vacdst;
};

struct EGS_Thresh {
    EGS_Float  rmt2;
    EGS_Float  rmsq;
    EGS_Float  ap[MXMED];
    EGS_Float  ae[MXMED];
    EGS_Float  up[MXMED];
    EGS_Float  ue[MXMED];
    EGS_Float  te[MXMED];
    EGS_Float  thmoll[MXMED];
};

struct EGS_Epcont {
  double    edep;
  double    edep_local;
  EGS_Float tstep;
  EGS_Float tustep;
  EGS_Float ustep;
  EGS_Float tvstep;
  EGS_Float vstep;
  EGS_Float rhof;
  EGS_Float eold;
  EGS_Float enew;
  EGS_Float eke;
  EGS_Float elke;
  EGS_Float gle;
  EGS_Float e_range;
  EGS_Float x_final, y_final, z_final;
  EGS_Float u_final, v_final, w_final;
  EGS_I32   idisc;
  EGS_I32   irold;
  EGS_I32   irnew;
  EGS_I32   iausfl[MXAUS];
};

struct EGS_EtControl {
    EGS_Float smaxir;
    EGS_Float smax_new;
    EGS_Float estepe;
    EGS_Float ximax;
    EGS_Float skindepth_for_bca;
    EGS_I32   transport_algorithm;
    EGS_I32   bca_algorithm;
    EGS_I32   exact_bca;
};

struct EGS_Media {
    EGS_Float rho[MXMED];
    char      pxsec[16];
    char      eiixsec[16];
    char      compxsec[16];
    char      photonucxsec[16];
    EGS_I32   nmed;
};

struct EGS_Rayleigh {
    char  ff_media[MXMED][24];
    char ff_file[MXMED][128];
};

struct EGS_Useful {
  double    pzero,      
            prm,        
            prmt2;      
  EGS_Float rm,         
            rhor,       
            rhor_new;   
  EGS_I32   medium,     
            medium_new, 
            medold;     
};

struct EGS_XOptions {

  EGS_I32   ibrdst;

  EGS_I32   iprdst;

  EGS_I32   ibr_nist;

  EGS_I32   spin_effects;

  EGS_I32   ibcmp;

  EGS_I32 iraylr;

  EGS_I32   iedgfl;

  EGS_I32   iphter;

  EGS_I32   pair_nrc;

  EGS_I32   itriplet;

  EGS_I32   radc_flag;

  EGS_I32   eii_flag;

  EGS_I32 iphotonuc;

  EGS_I32 eadl_relax;

  EGS_I32 mcdf_pe_xsections;

};

struct EGS_VarianceReduction {
    EGS_Float e_max_rr;

    EGS_Float e_max_rr_new;

    EGS_Float prob_RR;

    EGS_I32   nbr_split;

    EGS_I32   i_play_RR;

    EGS_I32   i_survived_RR;

    EGS_I32   n_RR_warning;

    EGS_I32   i_do_rr;
};

struct EGS_IO {
    char file_extensions[20][10];
    EGS_I32 file_units[20];
    char user_code[64];
    char input_file[256];
    char output_file[256];
    char pegs_file[256];
    char hen_house[128];
    char egs_home[128];
    char work_dir[128];
    char host_name[64];
    EGS_I32 n_parallel, i_parallel, first_parallel, n_max_parallel,
            n_chunk, n_files, i_input, i_log, i_incoh, i_nist_data,
            i_mscat, i_photo_cs, i_photo_relax, xsec_out, is_batch,
            is_uniform_run, is_pegsless;
};

struct EGS_emfInputs {
    EGS_Float ExIN, EyIN, EzIN, EMLMTIN,
    BxIN, ByIN, BzIN, Bx, By, Bz, Bx_new, By_new, Bz_new;
    bool emfield_on;
};

extern __extc__ struct EGS_Stack             *the_stack;

extern __extc__ struct EGS_Bounds            *the_bounds;

extern __extc__ struct EGS_Thresh            *the_thresh;

extern __extc__ struct EGS_Epcont            *the_epcont;

extern __extc__ struct EGS_EtControl         *the_etcontrol;

extern __extc__ struct EGS_Media             *the_media;

extern __extc__ struct EGS_Useful            *the_useful;

extern __extc__ struct EGS_XOptions          *the_xoptions;

extern __extc__ struct EGS_IO                *the_egsio;

extern __extc__ struct EGS_VarianceReduction *the_egsvr;

extern __extc__ struct EGS_Rayleigh *the_rayleigh;

extern __extc__ struct EGS_emfInputs *the_emf;

/* ******************* EGSnrc interface functions *************************/


extern __extc__ void egsInit(int argc, char **argv);

#define egsFinish F77_OBJ_(egs_finish,EGS_FINISH)

extern __extc__ void egsFinish(void);

#define egsAddMedium F77_OBJ_(egs_add_medium,EGS_ADD_MEDIUM)

extern __extc__ EGS_I32 egsAddMedium(const char *medname, EGS_I32 length);

#define egsHatch F77_OBJ_(egs_hatch,EGS_HATCH)

extern __extc__ void egsHatch(void);

#define egsShower F77_OBJ_(egs_shower,EGS_SHOWER)

extern __extc__ void egsShower(void);

/****************************************************************************
            Functions for using the EGSnrc random number generator
            Only relevant for user codes written in C
 ****************************************************************************/

#define egsRandomDefaultInit F77_OBJ_(egs_init_default_rng,EGS_INIT_DEFAULT_RNG)

extern __extc__ void egsRandomDefaultInit();

#define egsRandomInit F77_OBJ_(egs_init_rng,EGS_INIT_RNG)

extern __extc__ void egsRandomInit(const EGS_I32 *s1, const EGS_I32 *s2);

#define egsRandomGet F77_OBJ_(egs_get_rndm,EGS_GET_RNDM)

extern __extc__ void egsRandomGet(EGS_Float *ranno);

#define egsFillRandomArray F77_OBJ_(egs_fill_rndm_array,EGS_GET_RNDM_ARRAY)

extern __extc__ void egsFillRandomArray(const EGS_I32 *n, EGS_Float *rarray);

/*****************************************************************************
       Some utility functions
 *****************************************************************************/

#define egsElapsedTime F77_OBJ_(egs_tot_time,EGS_TOT_TIME)

extern __extc__ EGS_Float egsElapsedTime(int *flag);

#define egsCpuTime F77_OBJ_(egs_etime,EGS_ETIME)

extern __extc__ EGS_Float egsCpuTime(void);

#define egsGetTransportParameter F77_OBJ_(get_transport_parameter,GET_TRANSPORT_PARAMETER)

extern __extc__ void egsGetTransportParameter(const int *ounit);


/*****************************************************************************
  Fuctions that must be implemented by user codes written in C
 *****************************************************************************/

#define egsHowfar F77_OBJ_(egs_howfar,EGS_HOWFAR)

extern __extc__ void egsHowfar(void);

#define egsHownear F77_OBJ_(egs_hownear,EGS_HOWNEAR)

extern __extc__ void egsHownear(EGS_Float *tperp);

#define egsAusgab F77_OBJ_(egs_ausgab,EGS_AUSGAB)

extern __extc__ void egsAusgab(EGS_I32 *iarg);

#define egsStartParticle F77_OBJ_(egs_start_particle,EGS_START_PARTICLE)

extern __extc__ void egsStartParticle(void);

#endif