G4SPSEneDistribution Class Reference

#include <G4SPSEneDistribution.hh>

Public Member Functions
	G4SPSEneDistribution ()
	~G4SPSEneDistribution ()
void	SetEnergyDisType (G4String)
G4String	GetEnergyDisType ()
void	SetEmin (G4double)
G4double	GetEmin ()
G4double	GetArbEmin ()
void	SetEmax (G4double)
G4double	GetEmax ()
G4double	GetArbEmax ()
void	SetMonoEnergy (G4double)
void	SetAlpha (G4double)
void	SetBiasAlpha (G4double)
void	SetTemp (G4double)
void	SetBeamSigmaInE (G4double)
void	SetEzero (G4double)
void	SetGradient (G4double)
void	SetInterCept (G4double)
void	UserEnergyHisto (G4ThreeVector)
void	ArbEnergyHisto (G4ThreeVector)
void	ArbEnergyHistoFile (G4String)
void	EpnEnergyHisto (G4ThreeVector)
void	InputEnergySpectra (G4bool)
void	InputDifferentialSpectra (G4bool)
void	ArbInterpolate (G4String)
G4String	GetIntType ()
void	Calculate ()
void	SetBiasRndm (G4SPSRandomGenerator *a)
void	ReSetHist (G4String)
void	SetVerbosity (G4int a)
G4double	GetWeight ()
G4double	GetMonoEnergy ()
G4double	GetSE ()
G4double	Getalpha ()
G4double	GetEzero ()
G4double	GetTemp ()
G4double	Getgrad ()
G4double	Getcept ()
G4PhysicsOrderedFreeVector	GetUserDefinedEnergyHisto ()
G4PhysicsOrderedFreeVector	GetArbEnergyHisto ()
G4double	GenerateOne (G4ParticleDefinition *)
G4double	GetProbability (G4double)

Detailed Description

Andrea Dotti Feb 2015 Important: This is a shared class between threads. Only one thread should use the set-methods here. Note that this is exactly what is achieved using UI commands. If you use the set methods to set defaults in your application take care that only one thread is executing them. In addition take care of calling these methods before the run is started Do not use these setters during the event loop

Definition at line 171 of file G4SPSEneDistribution.hh.

Constructor & Destructor Documentation

G4SPSEneDistribution::G4SPSEneDistribution

(

)

Definition at line 61 of file G4SPSEneDistribution.cc.

                                          : Epnflag(false),eneRndm(0),Splinetemp(0)
{
    G4MUTEXINIT(mutex);
    //
    // Initialise all variables
    particle_energy = 1.0 * MeV;
    EnergyDisType = "Mono";
    weight=1.;
    MonoEnergy = 1 * MeV;
    Emin = 0.;
    Emax = 1.e30;
    alpha = 0.;
    biasalpha = 0.;
    prob_norm = 1.0;
    Ezero = 0.;
    SE = 0.;
    Temp = 0.;
    grad = 0.;
    cept = 0.;
    Biased = false; // not biased
    EnergySpec = true; // true - energy spectra, false - momentum spectra
    DiffSpec = true; // true - differential spec, false integral spec
    IntType = "NULL"; // Interpolation type
    IPDFEnergyExist = false;
    IPDFArbExist = false;

    ArbEmin = 0.;
    ArbEmax = 1.e30;

    verbosityLevel = 0;
    
    //AG: Set these pointers to NULL so we know if they were used...
    Arb_grad = NULL;
    Arb_cept = NULL;
    Arb_alpha = NULL;
    Arb_Const = NULL;
    Arb_ezero = NULL;
    Arb_grad_cept_flag = false;
    Arb_alpha_Const_flag = false;
    Arb_ezero_flag = false;
    histInit = false;
    histCalcd = false;
    
    BBHist = NULL;
    Bbody_x = NULL;

    threadLocal_t& data = threadLocalData.Get();
    data.Emax = Emax;
    data.Emin = Emin;
    data.alpha =alpha;
    data.cept = cept;
    data.Ezero = Ezero;
    data.grad = grad;
    data.particle_energy = 0;
    data.particle_definition = NULL;
    data.weight = weight;
}

Here is the call graph for this function:

G4SPSEneDistribution::~G4SPSEneDistribution

(

)

Definition at line 119 of file G4SPSEneDistribution.cc.

{
    G4MUTEXDESTROY(mutex);
    if(Arb_grad_cept_flag)
    {
        delete[] Arb_grad;
        delete[] Arb_cept;
    }
    
    if(Arb_alpha_Const_flag)
    {
        delete[] Arb_alpha;
        delete[] Arb_Const;
    }
    
    if(Arb_ezero_flag)
    {
        delete[] Arb_ezero;
    }
    delete Bbody_x;
    delete BBHist;
    for ( std::vector<G4DataInterpolation*>::iterator it = SplineInt.begin() ; it!=SplineInt.end() ; ++it)
    {
        delete *it;
        *it = 0;
    }
    SplineInt.clear();
}

Member Function Documentation

void G4SPSEneDistribution::ArbEnergyHisto

(

G4ThreeVector

input

)

Definition at line 341 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    G4double ehi, val;
    ehi = input.x();
    val = input.y();
    if (verbosityLevel > 1)
    {
        G4cout << "In ArbEnergyHisto" << G4endl;
        G4cout << " " << ehi << " " << val << G4endl;
    }
    ArbEnergyH.InsertValues(ehi, val);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::ArbEnergyHistoFile

(

G4String

filename

)

Definition at line 355 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    std::ifstream infile(filename, std::ios::in);
    if (!infile)
    {
        G4Exception("G4SPSEneDistribution::ArbEnergyHistoFile","Event0301",FatalException,"Unable to open the histo ASCII file");
    }
    G4double ehi, val;
    while (infile >> ehi >> val)
    {
        ArbEnergyH.InsertValues(ehi, val);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::ArbInterpolate

(

G4String

IType

)

Definition at line 519 of file G4SPSEneDistribution.cc.

                                                        {
    G4AutoLock l(&mutex);
    if (EnergyDisType != "Arb")
        G4Exception("G4SPSEneDistribution::ArbInterpolate",
                    "Event0302",FatalException,
                    "Error: this is for arbitrary distributions");
    IntType = IType;
    ArbEmax = ArbEnergyH.GetMaxLowEdgeEnergy();
    ArbEmin = ArbEnergyH.GetMinLowEdgeEnergy();

    // Now interpolate points
    if (IntType == "Lin")
        LinearInterpolation();
    if (IntType == "Log")
        LogInterpolation();
    if (IntType == "Exp")
        ExpInterpolation();
    if (IntType == "Spline")
        SplineInterpolation();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::Calculate

(

)

Definition at line 387 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    if (EnergyDisType == "Cdg")
    {
        CalculateCdgSpectrum();
    }
    else if (EnergyDisType == "Bbody")
    {
        if(!histInit)
        {
            InitHists();
        }
        CalculateBbodySpectrum();
    }
}

Here is the caller graph for this function:

void G4SPSEneDistribution::EpnEnergyHisto

(

G4ThreeVector

input

)

Definition at line 370 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    G4double ehi, val;
    ehi = input.x();
    val = input.y();
    if (verbosityLevel > 1)
    {
        G4cout << "In EpnEnergyHisto" << G4endl;
        G4cout << " " << ehi << " " << val << G4endl;
    }
    EpnEnergyH.InsertValues(ehi, val);
    Emax = ehi;
    threadLocalData.Get().Emax = Emax;
    Epnflag = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4SPSEneDistribution::GenerateOne

(

G4ParticleDefinition *

a

)

Definition at line 1723 of file G4SPSEneDistribution.cc.

{
    //Copy global shared status to thread-local one
    threadLocal_t& params = threadLocalData.Get();
    params.particle_definition=a;
    params.particle_energy=-1;
    params.Emax = Emax;
    params.Emin = Emin;
    params.alpha = alpha;
    params.Ezero = Ezero;
    params.grad = grad;
    params.cept = cept;
    params.weight = weight;
    //particle_energy = -1.;
    while ((EnergyDisType == "Arb") ? (params.particle_energy < ArbEmin || params.particle_energy > ArbEmax) : (params.particle_energy < params.Emin|| params.particle_energy > params.Emax))
    {
        if (Biased)
        {
            GenerateBiasPowEnergies();
        }
        else
        {
            if (EnergyDisType == "Mono")
            {
                GenerateMonoEnergetic();
            }
            else if (EnergyDisType == "Lin")
            {
                GenerateLinearEnergies(false);
            }
            else if (EnergyDisType == "Pow")
            {
                GeneratePowEnergies(false);
            }
            else if (EnergyDisType == "Exp")
            {
                GenerateExpEnergies(false);
            }
            else if (EnergyDisType == "Gauss")
            {
                GenerateGaussEnergies();
            }
            else if (EnergyDisType == "Brem")
            {
                GenerateBremEnergies();
            }
            else if (EnergyDisType == "Bbody")
            {
                GenerateBbodyEnergies();
            }
            else if (EnergyDisType == "Cdg")
            {
                GenerateCdgEnergies();
            }
            else if (EnergyDisType == "User")
            {
                GenUserHistEnergies();
            }
            else if (EnergyDisType == "Arb")
            {
                GenArbPointEnergies();
            }
            else if (EnergyDisType == "Epn")
            {
                GenEpnHistEnergies();
            }
            else
            {
                G4cout << "Error: EnergyDisType has unusual value" << G4endl;
            }
        }
    }
    return params.particle_energy;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4SPSEneDistribution::Getalpha

(

)

Definition at line 289 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().alpha;
}

Here is the call graph for this function:

G4double G4SPSEneDistribution::GetArbEmax

(

)

Definition at line 192 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return ArbEmax;
}

G4double G4SPSEneDistribution::GetArbEmin

(

)

Definition at line 186 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return ArbEmin;
}

G4PhysicsOrderedFreeVector G4SPSEneDistribution::GetArbEnergyHisto

(

)

Definition at line 321 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return ArbEnergyH;
}

G4double G4SPSEneDistribution::Getcept

(

)

Definition at line 310 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().cept;
}

Here is the call graph for this function:

G4double G4SPSEneDistribution::GetEmax

(

)

Definition at line 204 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().Emax;
}

Here is the call graph for this function:

G4double G4SPSEneDistribution::GetEmin

(

)

Definition at line 181 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().Emin;
}

Here is the call graph for this function:

G4String G4SPSEneDistribution::GetEnergyDisType

(

)

Definition at line 169 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return EnergyDisType;
}

Here is the caller graph for this function:

G4double G4SPSEneDistribution::GetEzero

(

)

Definition at line 294 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().Ezero;
}

Here is the call graph for this function:

G4double G4SPSEneDistribution::Getgrad

(

)

Definition at line 305 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().grad;
}

Here is the call graph for this function:

G4String G4SPSEneDistribution::GetIntType

(

)

Definition at line 254 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return IntType;
}

G4double G4SPSEneDistribution::GetMonoEnergy

(

)

Definition at line 277 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return MonoEnergy;
}

G4double G4SPSEneDistribution::GetProbability

(

G4double

ene

)

Definition at line 1798 of file G4SPSEneDistribution.cc.

{
    G4double prob = 1.;

    threadLocal_t& params = threadLocalData.Get();
    if (EnergyDisType == "Lin")
    {
        if (prob_norm == 1.)
        {
            prob_norm = 0.5*params.grad*params.Emax*params.Emax + params.cept*params.Emax - 0.5*params.grad*params.Emin*params.Emin - params.cept*params.Emin;
        }
        prob = params.cept + params.grad * ene;
        prob /= prob_norm;
    }
    else if (EnergyDisType == "Pow")
    {
        if (prob_norm == 1.)
        {
            if (alpha != -1.)
            {
                G4double emina = std::pow(params.Emin, params.alpha + 1);
                G4double emaxa = std::pow(params.Emax, params.alpha + 1);
                prob_norm = 1./(1.+alpha) * (emaxa - emina);
            }
            else
            {
                prob_norm = std::log(params.Emax) - std::log(params.Emin) ;
            }
        }
        prob = std::pow(ene, params.alpha)/prob_norm;
    }
    else if (EnergyDisType == "Exp")
    {
        if (prob_norm == 1.)
        {
            prob_norm = -params.Ezero*(std::exp(-params.Emax/params.Ezero) - std::exp(params.Emin/params.Ezero));
        }  
        prob = std::exp(-ene / params.Ezero);
        prob /= prob_norm;
    }
    else if (EnergyDisType == "Arb")
    {
        prob = ArbEnergyH.Value(ene);
        //  prob = ArbEInt->CubicSplineInterpolation(ene);
        //G4double deltaY;
        //prob = ArbEInt->PolynomInterpolation(ene, deltaY);
        if (prob <= 0.)
        {
            //G4cout << " Warning:G4SPSEneDistribution::GetProbability: prob<= 0. "<<prob <<" "<<ene << " " <<deltaY<< G4endl;
            G4cout << " Warning:G4SPSEneDistribution::GetProbability: prob<= 0. "<<prob <<" "<<ene << G4endl;
            prob = 1e-30;
        }
        // already normalised
    }
    else
    {
        G4cout << "Error: EnergyDisType not supported" << G4endl;
    }
       
    return prob;
}

Here is the call graph for this function:

G4double G4SPSEneDistribution::GetSE

(

)

Definition at line 283 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return SE;
}

G4double G4SPSEneDistribution::GetTemp

(

)

Definition at line 299 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return Temp;
}

G4PhysicsOrderedFreeVector G4SPSEneDistribution::GetUserDefinedEnergyHisto

(

)

Definition at line 315 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    return UDefEnergyH;
}

G4double G4SPSEneDistribution::GetWeight

(

)

Definition at line 272 of file G4SPSEneDistribution.cc.

{
    return threadLocalData.Get().weight;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::InputDifferentialSpectra

(

G4bool

value

)

Definition at line 511 of file G4SPSEneDistribution.cc.

                                                                {
    G4AutoLock l(&mutex);
    // Allows user to specify integral or differential spectra
    DiffSpec = value; // true = differential, false = integral
    if (verbosityLevel > 1)
        G4cout << "Diffspec has value " << DiffSpec << G4endl;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::InputEnergySpectra

(

G4bool

value

)

Definition at line 503 of file G4SPSEneDistribution.cc.

                                                          {
    G4AutoLock l(&mutex);
    // Allows user to specifiy spectrum is momentum
    EnergySpec = value; // false if momentum
    if (verbosityLevel > 1)
        G4cout << "EnergySpec has value " << EnergySpec << G4endl;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::ReSetHist

(

G4String

atype

)

Definition at line 1696 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    if (atype == "energy")
    {
        UDefEnergyH = IPDFEnergyH = ZeroPhysVector;
        IPDFEnergyExist = false;
        Emin = 0.;
        Emax = 1e30;
    }
    else if (atype == "arb")
    {
        ArbEnergyH = IPDFArbEnergyH = ZeroPhysVector;
        IPDFArbExist = false;
    }
    else if (atype == "epn")
    {
        UDefEnergyH = IPDFEnergyH = ZeroPhysVector;
        IPDFEnergyExist = false;
        EpnEnergyH = ZeroPhysVector;
    }
    else
    {
        G4cout << "Error, histtype not accepted " << G4endl;
    }
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetAlpha

(

G4double

alp

)

Definition at line 219 of file G4SPSEneDistribution.cc.

                                                {
    G4AutoLock l(&mutex);
    alpha = alp;
    threadLocalData.Get().alpha = alpha;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetBeamSigmaInE

(

G4double

e

)

Definition at line 215 of file G4SPSEneDistribution.cc.

                                                     {
    G4AutoLock l(&mutex);
    SE = e;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetBiasAlpha

(

G4double

alp

)

Definition at line 225 of file G4SPSEneDistribution.cc.

                                                    {
    G4AutoLock l(&mutex);
    biasalpha = alp;
    Biased = true;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetBiasRndm

(

G4SPSRandomGenerator *

a

)

Definition at line 260 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    eneRndm = a;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetEmax

(

G4double

ema

)

Definition at line 198 of file G4SPSEneDistribution.cc.

                                               {
    G4AutoLock l(&mutex);
    Emax = ema;
    threadLocalData.Get().Emax = Emax;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetEmin

(

G4double

emi

)

Definition at line 175 of file G4SPSEneDistribution.cc.

                                               {
    G4AutoLock l(&mutex);
    Emin = emi;
    threadLocalData.Get().Emin = Emin;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetEnergyDisType

(

G4String

DisType

)

Definition at line 148 of file G4SPSEneDistribution.cc.

                                                            {
    G4AutoLock l(&mutex);
    EnergyDisType = DisType;
    if (EnergyDisType == "User")
    {
        UDefEnergyH = IPDFEnergyH = ZeroPhysVector;
        IPDFEnergyExist = false;
    }
    else if (EnergyDisType == "Arb")
    {
        ArbEnergyH = IPDFArbEnergyH = ZeroPhysVector;
        IPDFArbExist = false;
    }
    else if (EnergyDisType == "Epn")
    {
        UDefEnergyH = IPDFEnergyH = ZeroPhysVector;
        IPDFEnergyExist = false;
        EpnEnergyH = ZeroPhysVector;
    }
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetEzero

(

G4double

eze

)

Definition at line 236 of file G4SPSEneDistribution.cc.

                                                {
    G4AutoLock l(&mutex);
    Ezero = eze;
    threadLocalData.Get().Ezero = Ezero;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetGradient

(

G4double

gr

)

Definition at line 242 of file G4SPSEneDistribution.cc.

                                                  {
    G4AutoLock l(&mutex);
    grad = gr;
    threadLocalData.Get().grad = grad;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetInterCept

(

G4double

c

)

Definition at line 248 of file G4SPSEneDistribution.cc.

                                                  {
    G4AutoLock l(&mutex);
    cept = c;
    threadLocalData.Get().cept = cept;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4SPSEneDistribution::SetMonoEnergy

(

G4double

menergy

)

Definition at line 210 of file G4SPSEneDistribution.cc.

                                                         {
    G4AutoLock l(&mutex);
    MonoEnergy = menergy;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetTemp

(

G4double

tem

)

Definition at line 231 of file G4SPSEneDistribution.cc.

                                               {
    G4AutoLock l(&mutex);
    Temp = tem;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::SetVerbosity

(

G4int

a

)

Definition at line 266 of file G4SPSEneDistribution.cc.

{
    G4AutoLock l(&mutex);
    verbosityLevel = a;
}

Here is the caller graph for this function:

void G4SPSEneDistribution::UserEnergyHisto

(

G4ThreeVector

input

)

Definition at line 327 of file G4SPSEneDistribution.cc.

                                                              {
    G4AutoLock l(&mutex);
    G4double ehi, val;
    ehi = input.x();
    val = input.y();
    if (verbosityLevel > 1) {
        G4cout << "In UserEnergyHisto" << G4endl;
        G4cout << " " << ehi << " " << val << G4endl;
    }
    UDefEnergyH.InsertValues(ehi, val);
    Emax = ehi;
    threadLocalData.Get().Emax = Emax;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• geant4.10.03.p01/source/event/include/G4SPSEneDistribution.hh
• geant4.10.03.p01/source/event/src/G4SPSEneDistribution.cc