G4InuclSpecialFunctions.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4InuclSpecialFunctions.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.          *
// ********************************************************************
//
//
// 20100114  M. Kelsey -- Remove G4CascadeMomentum, use G4LorentzVector directly
// 20100319  M. Kelsey -- Add optional mass argument to generateWithFixedTheta;
//    define new generateWithRandomAngles, encapsulating code; define
//    cbrt() cube-root function (in math.h, but not in <math>!)
// 20100412  M. Kelsey -- Modify paraMaker[Truncated] to take buffer as argument
// 20100914  M. Kelsey -- Migrate to integer A and Z.  Discard unused binding
//    energy functions
// 20120608  M. Kelsey -- Fix variable-name "shadowing" compiler warnings.
// 20130308  M. Kelsey -- New function to encapsulate INUCL power expansion
// 20130808  M. Kelsey -- Convert paraMaker[Truncated] to class object, to
//    allow thread isolation
// 20130829  M. Kelsey -- Address Coverity #52158, 52161 for copy actions.
// 20150619  M. Kelsey -- Overload G4cbrt for case of integer arguments

#ifndef G4INUCL_SPECIAL_FUNC_HH
#define G4INUCL_SPECIAL_FUNC_HH

#include "globals.hh"
#include "G4LorentzVector.hh"
#include <algorithm>
#include <vector>

template <int N> class G4CascadeInterpolator;


namespace G4InuclSpecialFunctions {
  G4double bindingEnergy(G4int A, G4int Z);

  // NOTE:  Used only by G4Fissioner
  G4double bindingEnergyAsymptotic(G4int A, G4int Z);

  G4double FermiEnergy(G4int A, G4int Z, G4int ntype);
  
  G4double getAL(G4int A);
 
  G4double csNN(G4double e);

  G4double csPN(G4double e);

  G4double G4cbrt(G4double x);  // Can't use "cbrt" name, clashes with <math.h>
  G4double G4cbrt(G4int n); // Use G4Pow::powN() here for speedup

  G4double inuclRndm();       // Wrapper for G4UniformRand()

  G4double randomInuclPowers(G4double ekin,   // Power series in Ekin, S
           const G4double (&coeff)[4][4]);

  G4double randomGauss(G4double sigma);   // Gaussian distribution

  G4double randomPHI();

  std::pair<G4double, G4double> randomCOS_SIN();

  G4double nucleiLevelDensity(G4int A);

  // Optional mass argument will be used to fill G4LorentzVector correctly
  G4LorentzVector generateWithFixedTheta(G4double ct, G4double p,
           G4double mass=0.);

  G4LorentzVector generateWithRandomAngles(G4double p, G4double mass=0.);

  // This is an object to be instantiated by client code
  class paraMaker {
  public:
    paraMaker(G4int verbose=0);
    ~paraMaker();

  // NOTE:  Passing Z as double here, to be used as interpolation argument
    void getParams(G4double Z, std::pair<std::vector<G4double>,
                             std::vector<G4double> >& parms);

    void getTruncated(G4double Z, std::pair<G4double, G4double>& parms); 

  private:
    G4int verboseLevel;
    G4CascadeInterpolator<5>* interp;

    // No copy actions
    paraMaker(const paraMaker& right);
    paraMaker& operator=(const paraMaker& right);
  };
}


#endif