GLG4VertexGen.hh

Go to the documentation of this file.

#ifndef __GLG4VertexGen_h__
#define __GLG4VertexGen_h__ 1
#include <stdio.h>  // for FILE
 
#include <G4ThreeVector.hh>
 
#include "globals.hh"
 
class G4Event;
class G4Track;
class G4PrimaryVertex;
class G4ParticleDefinition;
class GLG4PrimaryGeneratorAction;
 
class GLG4VertexGen {
 public:
  GLG4VertexGen(const char *arg_dbname = "vertex") : _dbname(arg_dbname){};
  virtual ~GLG4VertexGen(){};
  // Generate and add new vertex to this event.  Position and
  // time of vertex are offset from 0 by dx and dt.  (These
  // are usually derived from GLG4PosGen and GLG4TimeGen.)
  virtual void GeneratePrimaryVertex(G4Event *argEvent, G4ThreeVector &dx, G4double dt) = 0;
  // adds vertices.
  virtual void SetState(G4String newValues) = 0;
  // sets filename or other information needed by vertex generator
  virtual G4String GetState() = 0;
  // returns the current state information in a form that can be understood
  // by SetState (and, hopefully, a well-informed human)
 
  virtual bool ELimitable() { return false; };
  virtual void LimitEnergies(double, double){};
  virtual double EMaximum() { return 99999; };
  virtual double EMinimum() { return 0; };
 
 protected:
  G4String _dbname;  // used for GLG4param key prefix
};
 
class GLG4VertexGen_Gun : public GLG4VertexGen {
 public:
  GLG4VertexGen_Gun(const char *arg_dbname = "gun");
  virtual ~GLG4VertexGen_Gun();
  virtual void GeneratePrimaryVertex(G4Event *argEvent, G4ThreeVector &dx, G4double dt);
  // generates a primary vertex with given particle type, direction, energy,
  // and consistent polarization.
 
  virtual void SetState(G4String newValues);
  // format: particle_name  dir_x dir_y dir_z  kinetic_energy  polx poly polz
  // If dir_x==dir_y==dir_z==0, the directions are isotropic.
  // If particle has mass==0 and spin==1, final polarization will be
  // projected into plane perpindicular to momentum and made a unit vector;
  // if polarization has zero magnitude, a polarization is chosen randomly.
 
  virtual G4String GetState();
  // returns current state formatted as above
 
 public:
  // the following useful static const data should be universally accessable
  // (I copied it from the G4IonTable source code, where it is privatized
  // with no accessor functions.)
  enum { numberOfElements = 110 };
  static const char *theElementNames[numberOfElements];
 
 protected:
  G4ParticleDefinition *_pDef;
  G4ThreeVector _mom;
  G4double _ke;
  G4ThreeVector _pol;
  G4int _multiplicity;
};
 
 
class GLG4VertexGen_Gun2 : public GLG4VertexGen {
 public:
  GLG4VertexGen_Gun2(const char *arg_dbname = "gun2");
  virtual ~GLG4VertexGen_Gun2();
  virtual void GeneratePrimaryVertex(G4Event *argEvent, G4ThreeVector &dx, G4double dt);
  // generates a primary vertex with given particle type, direction, energy,
  // and consistent polarization.
 
  virtual void SetState(G4String newValues);
  // format: particle_name  dir_x dir_y dir_z  kinetic_energy  polx poly polz
  // If dir_x==dir_y==dir_z==0, the directions are isotropic.
  // If particle has mass==0 and spin==1, final polarization will be
  // projected into plane perpindicular to momentum and made a unit vector;
  // if polarization has zero magnitude, a polarization is chosen randomly.
 
  virtual G4String GetState();
  // returns current state formatted as above
 
 public:
  // the following useful static const data should be universally accessable
  // (I copied it from the G4IonTable source code, where it is privatized
  // with no accessor functions.)
  enum { numberOfElements = 110 };
  static const char *theElementNames[numberOfElements];
 
 protected:
  G4ParticleDefinition *_pDef;
  G4ThreeVector _mom;
  G4double _mom_theta;
  G4double _ke1;
  G4double _ke2;
  G4ThreeVector _pol;
  G4int _multiplicity;
};
 
class GLG4VertexGen_HEPEvt : public GLG4VertexGen {
 public:
  GLG4VertexGen_HEPEvt(const char *arg_dbname = "external");
  virtual ~GLG4VertexGen_HEPEvt();
  virtual void GeneratePrimaryVertex(G4Event *argEvent, G4ThreeVector &dx, G4double dt);
 
  // Generates a primary vertex based on information from an ASCII stream.
  // The ASCII stream contains information in a HEPEVT style.
 
  virtual void SetState(G4String newValues);
  // The argument is a Perl "open" style filename argument:
  // if the filename ends with '|', the filename is interpreted as
  // a command which pipes output to us; otherwise, if the filename begins
  // with '<' or an ordinary character, the file is opened for input.
  // The "pipe" style can be used to read a gzip'ped file or to start
  // a program which feeds events to us directly.
  virtual G4String GetState();
  // returns current state formatted as above
 
  void Open(const char *argFilename);
  void GetDataLine(char *buffer, size_t size);
  void Close();
  void SetUseExternalPos(bool val) { _useExternalPos = val; };
  bool GetUseExternalPos() { return _useExternalPos; };
 
  enum {
    kIonCodeOffset = 9800000,         // nuclei have codes like 98zzaaa
    kPDGcodeModulus = 10000000,       // PDG codes are 7 digits long
    kISTHEP_ParticleForTracking = 1,  // only ISTHEP==1 are for tracking
    kISTHEP_InformatonMin = 100,      // 100 and above are "informatons"
    kISTHEP_Max = 213                 // <= MAXINT / kPDGcodeModulus
  };
 
 protected:
  G4String _filename;
  FILE *_file;
  bool _isPipe;
  bool _useExternalPos;  // true to use positions listed in ACCII stream
};
 
#endif