class TVirtualMC: public TNamed

 Standard constructor

 Default constructor

 Destructor

static: return virtual MC object

 Set particles stack.

 Set external decayer.

 Set random number generator.

 Set magnetic field.

 Standard constructor
 isRootGeometrySupported = True if implementation of TVirtualMC
        supports geometry defined with TGeo

 methods for building/management of geometry


 Info about supporting geometry defined via Root

 functions from GCONS


 Define a material
 kmat   number assigned to the material
 name   material name
 a      atomic mass in au
 z      atomic number
 dens   density in g/cm3
 absl   absorption length in cm;
               if >=0 it is ignored and the program
               calculates it, if <0. -absl is taken
 radl   radiation length in cm
               if >=0 it is ignored and the program
               calculates it, if <0. -radl is taken
 buf    pointer to an array of user words
 nwbuf  number of user words

 The same as previous but in double precision
 Define mixture or compound
 with a number kmat composed by the basic nlmat materials defined
 by arrays a, z and wmat

 If nlmat > 0 then wmat contains the proportion by
 weights of each basic material in the mixture.

 If nlmat < 0 then wmat contains the number of atoms
 of a given kind into the molecule of the compound.
 In this case, wmat in output is changed to relative
 weights.

 The same as previous but in double precision
 Define a medium.
 kmed      tracking medium number assigned
 name      tracking medium name
 nmat      material number
 isvol     sensitive volume flag
 ifield    magnetic field:
                  - ifield = 0 if no magnetic field;
                  - ifield = -1 if user decision in guswim;
                  - ifield = 1 if tracking performed with g3rkuta;
                  - ifield = 2 if tracking performed with g3helix;
                  - ifield = 3 if tracking performed with g3helx3.
 fieldm    max. field value (kilogauss)
 tmaxfd    max. angle due to field (deg/step)
 stemax    max. step allowed
 deemax    max. fraction of energy lost in a step
 epsil     tracking precision (cm)
 stmin     min. step due to continuous processes (cm)
 ubuf      pointer to an array of user words
 nbuf      number of user words

 The same as previous but in double precision
 Define a rotation matrix
 krot     rotation matrix number assigned
 thetaX   polar angle for axis X
 phiX     azimuthal angle for axis X
 thetaY   polar angle for axis Y
 phiY     azimuthal angle for axis Y
 thetaZ   polar angle for axis Z
 phiZ     azimuthal angle for axis Z

 Change the value of cut or mechanism param
 to a new value parval for tracking medium itmed.
 In Geant3, the  data  structure JTMED contains the standard tracking
 parameters (CUTS and flags to control the physics processes)  which
 are used  by default for all tracking media.
 It is possible to redefine individually with this function any of these
 parameters for a given tracking medium.
  itmed   tracking medium number
  param   is a character string (variable name)
  parval  must be given as a floating point.

 functions from GGEOM


 Create a new volume
 name   Volume name
 shape  Volume type
 nmed   Tracking medium number
 np     Number of shape parameters
 upar   Vector containing shape parameters

 The same as previous but in double precision
 Create a new volume by dividing an existing one.
 It divides a previously defined volume
 name   Volume name
 mother Mother volume name
 ndiv   Number of divisions
 iaxis  Axis value:
               X,Y,Z of CAXIS will be translated to 1,2,3 for IAXIS.

 Create a new volume by dividing an existing one.
 Divide mother into ndiv divisions called name
 along axis iaxis starting at coordinate value c0i.
 The new volume created will be medium number numed.
 Create a new volume by dividing an existing one
 Divide mother into divisions called name along
 axis iaxis in steps of step. If not exactly divisible
 will make as many as possible and will center them
 with respect to the mother. Divisions will have medium
 number numed. If numed is 0, numed of mother is taken.
 ndvmx is the expected maximum number of divisions
 (If 0, no protection tests are performed in Geant3)

 Create a new volume by dividing an existing one
 Divides mother into divisions called name along
 axis iaxis starting at coordinate value c0 with step
 size step.
 The new volume created will have medium number numed.
 If numed is 0, numed of mother is taken.
 ndvmx is the expected maximum number of divisions
 (If 0, no protection tests are performed in Geant3)
 Flag volume name whose contents will have to be ordered
 along axis iax, by setting the search flag to -iax
 (Geant3 only)

 Position a volume into an existing one.
 It positions a previously defined volume in the mother.
   name   Volume name
   nr     Copy number of the volume
   mother Mother volume name
   x      X coord. of the volume in mother ref. sys.
   y      Y coord. of the volume in mother ref. sys.
   z      Z coord. of the volume in mother ref. sys.
   irot   Rotation matrix number w.r.t. mother ref. sys.
   konly  ONLY/MANY flag

 Place a copy of generic volume name with user number
  nr inside mother, with its parameters upar(1..np)
 The same as previous but in double precision

 Helper function for resolving MANY.
 Specify the ONLY volume that overlaps with the
 specified MANY and has to be substracted.
 (Geant4 only)
 Define the tables for UV photon tracking in medium itmed.
 Please note that it is the user's responsibility to
 provide all the coefficients:
  itmed       Tracking medium number
  npckov      Number of bins of each table
  ppckov      Value of photon momentum (in GeV)
  absco       Absorption coefficients
                     dielectric: absorption length in cm
                     metals    : absorption fraction (0<=x<=1)
  effic       Detection efficiency for UV photons
  rindex      Refraction index (if=0 metal)

 The same as previous but in double precision

 functions for definition of surfaces
 and material properties for optical physics


 Define the optical surface
 name           surface name
 model          selection of model (see #EMCOpSurfaceModel values)
 surfaceType    surface type (see #EMCOpSurfaceType values)
 surfaceFinish  surface quality (see #EMCOpSurfaceType values)
 sigmaAlpha     an unified model surface parameter
 (Geant4 only)

 Define the optical surface border
 name        border surface name
 vol1Name    first volume name
 vol1CopyNo  first volume copy number
 vol2Name    second volume name
 vol2CopyNo  second volume copy number
 opSurfaceName  name of optical surface which this border belongs to
 (Geant4 only)
 Define the optical skin surface
 name        skin surface name
 volName     volume name
 opSurfaceName  name of optical surface which this border belongs to
 (Geant4 only)

 Define material property via a table of values
 itmed         tracking medium id
 propertyName  property name
 np            number of bins of the table
 pp            value of photon momentum (in GeV)
 values        property values
 (Geant4 only)
 Define material property via a value
 itmed         tracking medium id
 propertyName  property name
 value         property value
 (Geant4 only)

 Define optical surface property via a table of values
 surfaceName   optical surface name
 propertyName  property name
 np            number of bins of the table
 pp            value of photon momentum (in GeV)
 values        property values
 (Geant4 only)

 functions for access to geometry


 Return the transformation matrix between the volume specified by
 the path volumePath and the top or master volume.

 Return the name of the shape (shapeType)  and its parameters par
 for the volume specified by the path volumePath .
 Return the material parameters for the material specified by
 the material Id

 Return the material parameters for the volume specified by
 the volumeName.
 Return the medium parameters for the volume specified by the
 volumeName.

 Write out the geometry of the detector in EUCLID file format
 filnam  file name - will be with the extension .euc                 *
 topvol  volume name of the starting node
 number  copy number of topvol (relevant for gsposp)
 nlevel  number of  levels in the tree structure
                to be written out, starting from topvol
 (Geant3 only)
 Deprecated
 Set geometry from Root (built via TGeo)

 Activate the parameters defined in tracking media
 (DEEMAX, STMIN, STEMAX), which are, be default, ignored.
 In Geant4 case, only STEMAX is taken into account.
 In FLUKA, all tracking media parameters are ignored.

 get methods


 Return the unique numeric identifier for volume name volName

 Return the volume name for a given volume identifier id

 Return the unique numeric identifier for medium name mediumName

 Return total number of volumes in the geometry

 Return material number for a given volume id

 Return number of daughters of the volume specified by volName

 Return the name of i-th daughter of the volume specified by volName

 Return the copyNo of i-th daughter of the volume specified by volName

 methods for physics management



 set methods


 Set transport cuts for particles

 Set process control

 Set a user defined particle
 Function is ignored if particle with specified pdg
 already exists and error report is printed.
   pdg           PDG encoding
   name          particle name
   mcType        VMC Particle type
   mass          mass [GeV]
   charge        charge [eplus]
   lifetime      time of life [s]
   pType         particle type as in Geant4
   width         width [GeV]
   iSpin         spin
   iParity       parity
   iConjugation  conjugation
   iIsospin      isospin
   iIsospinZ     isospin - #rd component
   gParity       gParity
   lepton        lepton number
   baryon        baryon number
   stable        stability
   shortlived    is shorlived?
   subType       particle subType as in Geant4
   antiEncoding  anti encoding
   magMoment     magnetic moment
   excitation    excitation energy [GeV]

 Set a user defined particle
 Function is ignored if particle with specified pdg
 already exists and error report is printed.
   pdg           PDG encoding
   name          particle name
   mcType        VMC Particle type
   mass          mass [GeV]
   charge        charge [eplus]
   lifetime      time of life [s]
   pType         particle type as in Geant4
   width         width [GeV]
   iSpin         spin
   iParity       parity
   iConjugation  conjugation
   iIsospin      isospin
   iIsospinZ     isospin - #rd component
   gParity       gParity
   lepton        lepton number
   baryon        baryon number
   stable        stability
   shortlived    is shorlived?
   subType       particle subType as in Geant4
   antiEncoding  anti encoding
   magMoment     magnetic moment
   excitation    excitation energy [GeV]
 Set a user defined ion.
   name          ion name
   Z             atomic number
   A             atomic mass
   Q             charge [eplus}
   excitation    excitation energy [GeV]
   mass          mass  [GeV] (if not specified by user, approximative
                 mass is calculated)

 Set a user phase space decay for a particle
   pdg           particle PDG encoding
   bratios       the array with branching ratios (in %)
   mode[6][3]    the array with daughters particles PDG codes  for each
                 decay channel
 Calculate X-sections
 (Geant3 only)
 Deprecated

 particle table usage


 Return MC specific code from a PDG and pseudo ENDF code (pdg)

 Return PDG code and pseudo ENDF code from MC specific code (id)

 get methods


 Return name of the particle specified by pdg.

 Return mass of the particle specified by pdg.

 Return charge (in e units) of the particle specified by pdg.

 Return life time of the particle specified by pdg.

 Return VMC type of the particle specified by pdg.

 methods for step management



 action methods


 Stop the transport of the current particle and skip to the next

 Stop simulation of the current event and skip to the next

 Stop simulation of the current event and set the abort run flag to true

 set methods


 Set the maximum step allowed till the particle is in the current medium

 Set the maximum number of steps till the particle is in the current medium

 Force the decays of particles to be done with Pythia
 and not with the Geant routines.

 Force the decay time of the current particle

 tracking volume(s)


 Return the current volume ID and copy number

 Return the current volume off upward in the geometrical tree
 ID and copy number

 Return the current volume name

 Return the current volume off upward in the geometrical tree
 name and copy number'
 if name=0 no name is returned

 Return the path in geometry tree for the current volume

 If track is on a geometry boundary, fill the normal vector of the crossing
 volume surface and return true, return false otherwise

 Return the parameters of the current material during transport
 Return the number of the current medium

 new function (to replace GetMedium() const)
 Return the number of the current event

 Computes coordinates xd in daughter reference system
 from known coordinates xm in mother reference system.
 xm    coordinates in mother reference system (input)
 xd    coordinates in daughter reference system (output)
 iflag
 - IFLAG = 1  convert coordinates
 - IFLAG = 2  convert direction cosines

 The same as previous but in double precision

 Computes coordinates xm in mother reference system
 from known coordinates xd in daughter reference system.
 xd    coordinates in daughter reference system (input)
 xm    coordinates in mother reference system (output)
 iflag
 - IFLAG = 1  convert coordinates
 - IFLAG = 2  convert direction cosines

 The same as previous but in double precision

 Return the maximum step length in the current medium

 Return the maximum number of steps allowed in the current medium

 get methods
 tracking particle
 dynamic properties


 Return the current position in the master reference frame of the
 track being transported

 Return the current position in the master reference frame of the
 track being transported

 Return the direction and the momentum (GeV/c) of the track
 currently being transported

 Return the direction and the momentum (GeV/c) of the track
 currently being transported

 Return the length in centimeters of the current step (in cm)

 Return the length of the current track from its origin (in cm)

 Return the current time of flight of the track being transported

 Return the energy lost in the current step

 get methods
 tracking particle
 static properties


 Return the PDG of the particle transported

 Return the charge of the track currently transported

 Return the mass of the track currently transported

 Return the total energy of the current track

 get methods - track status


 Return true when the track performs the first step

 Return true if the track is not at the boundary of the current volume

 Return true if this is the first step of the track in the current volume

 Return true if this is the last step of the track in the current volume

 Return true if the track is out of the setup

 Return true if the current particle has disappeared
 either because it decayed or because it underwent
 an inelastic collision

 Return true if the track energy has fallen below the threshold

 Return true if the current particle is alive and will continue to be
 transported

 get methods - secondaries


 Return the number of secondary particles generated in the current step

 Return the parameters of the secondary track number isec produced
 in the current step

 Return the VMC code of the process that has produced the secondary
 particles in the current step
 Return the array of the VMC code of the processes active in the current
 step

 Return the information about the transport order needed by the stack

 Control methods


 Initialize MC

 Initialize MC physics

 Process one event
 Deprecated

 Process one  run and return true if run has finished successfully,
 return false in other cases (run aborted by user)

 Set switches for lego transport

 (In)Activate collecting TGeo tracks

 Return the info if collecting tracks is activated

 Return the info if multi-threading is supported/activated

 Get methods


 Return the particle stack

 Return the external decayer

 Return the random number generator

 Return the magnetic field