G4INCLParticleTable.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4INCLParticleTable.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// INCL++ intra-nuclear cascade model
// Alain Boudard, CEA-Saclay, France
// Joseph Cugnon, University of Liege, Belgium
// Jean-Christophe David, CEA-Saclay, France
// Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
// Sylvie Leray, CEA-Saclay, France
// Davide Mancusi, CEA-Saclay, France
//
#define INCLXX_IN_GEANT4_MODE 1

#include "globals.hh"

#ifndef G4INCLParticleTable_hh
#define G4INCLParticleTable_hh 1

#include <string>
#include <vector>
// #include <cassert>

#include "G4INCLParticleType.hh"
#include "G4INCLParticleSpecies.hh"
#include "G4INCLLogger.hh"
#include "G4INCLConfig.hh"
#include "G4INCLHFB.hh"

#ifdef INCLXX_IN_GEANT4_MODE
#include "G4IonTable.hh"
#include "G4ParticleTable.hh"
#endif
#include "G4INCLGlobals.hh"
#include "G4INCLNaturalIsotopicDistributions.hh"

namespace G4INCL {

  namespace ParticleTable {

    const G4int maxClusterMass = 12;
    const G4int maxClusterCharge = 8;

    const G4int clusterTableZSize = maxClusterCharge+1;
    const G4int clusterTableASize = maxClusterMass+1;
    const G4int clusterTableSSize = 4;

    const G4double effectiveNucleonMass = 938.2796;
    const G4double effectiveNucleonMass2 = 8.8036860777616e5;
    const G4double effectiveDeltaMass = 1232.0;
    const G4double effectiveDeltaWidth = 130.0;
    const G4double effectivePionMass = 138.0;
    const G4double effectiveLambdaMass = 1115.683;
    const G4double effectiveSigmaMass = 1197.45; // max value
    const G4double effectiveKaonMass = 497.614; // max value
    const G4double effectiveAntiKaonMass = 497.614; // max value
    const G4double effectiveEtaMass = 547.862;
    const G4double effectiveOmegaMass = 782.65;
    const G4double effectiveEtaPrimeMass = 957.78;
    const G4double effectivePhotonMass = 0.0;
    extern G4ThreadLocal G4double minDeltaMass;
    extern G4ThreadLocal G4double minDeltaMass2;
    extern G4ThreadLocal G4double minDeltaMassRndm;

    void initialize(Config const * const theConfig = 0);

    G4int getIsospin(const ParticleType t);

    std::string getName(const ParticleType t);

    std::string getShortName(const ParticleType t);

    std::string getName(const ParticleSpecies &s);

    std::string getShortName(const ParticleSpecies &s);

    std::string getName(const G4int A, const G4int Z);

    std::string getShortName(const G4int A, const G4int Z);

    G4double getINCLMass(const G4int A, const G4int Z, const G4int S);

    G4double getINCLMass(const ParticleType t);

#ifndef INCLXX_IN_GEANT4_MODE

    G4double hasMassTable(const unsigned int A, const unsigned int Z);

    G4double getWeizsaeckerMass(const G4int A, const G4int Z);
#endif

    G4double getRealMass(const G4INCL::ParticleType t);
    G4double getRealMass(const G4int A, const G4int Z, const G4int S = 0);

    G4double getTableQValue(const G4int A1, const G4int Z1, const G4int S1, const G4int A2, const G4int Z2, const G4int S2);

    G4double getTableQValue(const G4int A1, const G4int Z1, const G4int S1, const G4int A2, const G4int Z2, const G4int S2, const G4int A3, const G4int Z3, const G4int S3);

    G4double getTableSpeciesMass(const ParticleSpecies &p);

    G4int getMassNumber(const ParticleType t);

    G4int getChargeNumber(const ParticleType t);
    
    G4int getStrangenessNumber(const ParticleType t);

    G4double getNuclearRadius(const ParticleType t, const G4int A, const G4int Z);
    G4double getLargestNuclearRadius(const G4int A, const G4int Z);
    G4double getRadiusParameter(const ParticleType t, const G4int A, const G4int Z);
    G4double getMaximumNuclearRadius(const ParticleType t, const G4int A, const G4int Z);
    G4double getSurfaceDiffuseness(const ParticleType t, const G4int A, const G4int Z);

    G4double getMomentumRMS(const G4int A, const G4int Z);

    G4double getSeparationEnergyINCL(const ParticleType t, const G4int /*A*/, const G4int /*Z*/);

    G4double getSeparationEnergyReal(const ParticleType t, const G4int A, const G4int Z);

    G4double getSeparationEnergyRealForLight(const ParticleType t, const G4int A, const G4int Z);

    G4double getProtonSeparationEnergy();

    G4double getNeutronSeparationEnergy();

    void setProtonSeparationEnergy(const G4double s);

    void setNeutronSeparationEnergy(const G4double s);

    std::string getElementName(const G4int Z);

    std::string getIUPACElementName(const G4int Z);

    G4int parseElement(std::string pS);

    G4int parseIUPACElement(std::string const &pS);

    IsotopicDistribution const &getNaturalIsotopicDistribution(const G4int Z);

    G4int drawRandomNaturalIsotope(const G4int Z);

    // Typedefs and pointers for transparent handling of mass functions
    //typedef G4double (*NuclearMassFn)(const G4int, const G4int);
    typedef G4double (*NuclearMassFn)(const G4int, const G4int, const G4int);
    typedef G4double (*ParticleMassFn)(const ParticleType);
    extern G4ThreadLocal NuclearMassFn getTableMass;
    extern G4ThreadLocal ParticleMassFn getTableParticleMass;

    // Typedefs and pointers for transparent handling of separation energies
    typedef G4double (*SeparationEnergyFn)(const ParticleType, const G4int, const G4int);
    extern G4ThreadLocal SeparationEnergyFn getSeparationEnergy;

    // Typedefs and pointers for transparent handling of Fermi momentum
    typedef G4double (*FermiMomentumFn)(const G4int, const G4int);
    extern G4ThreadLocal FermiMomentumFn getFermiMomentum;

    G4double getFermiMomentumConstant(const G4int /*A*/, const G4int /*Z*/);

    G4double getFermiMomentumConstantLight(const G4int A, const G4int Z);

    G4double getFermiMomentumMassDependent(const G4int A, const G4int /*Z*/);

    G4double getRPCorrelationCoefficient(const ParticleType t);

    G4double getNeutronSkin();

    G4double getNeutronHalo();

    ParticleType getPionType(const G4int isosp);

    ParticleType getNucleonType(const G4int isosp);

    ParticleType getDeltaType(const G4int isosp);

    ParticleType getSigmaType(const G4int isosp);

    ParticleType getKaonType(const G4int isosp);

    ParticleType getAntiKaonType(const G4int isosp);

    G4double getWidth(const ParticleType t);
  }
}

#endif