G4GeneralParticleSource Class Reference

#include <G4GeneralParticleSource.hh>

Inheritance diagram for G4GeneralParticleSource:

Collaboration diagram for G4GeneralParticleSource:

Public Member Functions
	G4GeneralParticleSource ()
	~G4GeneralParticleSource ()
void	GeneratePrimaryVertex (G4Event *)
G4int	GetNumberofSource ()
void	ListSource ()
void	SetCurrentSourceto (G4int)
void	SetCurrentSourceIntensity (G4double)
G4SingleParticleSource *	GetCurrentSource () const
G4int	GetCurrentSourceIndex () const
G4double	GetCurrentSourceIntensity () const
void	ClearAll ()
void	AddaSource (G4double)
void	DeleteaSource (G4int)
void	SetVerbosity (G4int i)
void	SetMultipleVertex (G4bool av)
void	SetFlatSampling (G4bool av)
void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)
G4ParticleDefinition *	GetParticleDefinition () const
void	SetParticleCharge (G4double aCharge)
void	SetParticlePolarization (G4ThreeVector aVal)
G4ThreeVector	GetParticlePolarization () const
void	SetParticleTime (G4double aTime)
G4double	GetParticleTime () const
void	SetNumberOfParticles (G4int i)
G4int	GetNumberOfParticles () const
G4ThreeVector	GetParticlePosition () const
G4ThreeVector	GetParticleMomentumDirection () const
G4double	GetParticleEnergy () const
Public Member Functions inherited from G4VPrimaryGenerator
	G4VPrimaryGenerator ()
virtual	~G4VPrimaryGenerator ()
G4ThreeVector	GetParticlePosition ()
G4double	GetParticleTime ()
void	SetParticlePosition (G4ThreeVector aPosition)
void	SetParticleTime (G4double aTime)

Private Member Functions
void	IntensityNormalization ()

Private Attributes
G4bool	normalised
G4GeneralParticleSourceMessenger *	theMessenger
G4GeneralParticleSourceData *	GPSData

Additional Inherited Members
Static Public Member Functions inherited from G4VPrimaryGenerator
static G4bool	CheckVertexInsideWorld (const G4ThreeVector &pos)
Protected Attributes inherited from G4VPrimaryGenerator
G4ThreeVector	particle_position
G4double	particle_time

Detailed Description

Andrea Dotti Feb 2015 GPS messenger design requires some explanation for what distributions parameters are concerned : Each thread has its own GPS since primary generation is a user action. However to save memory the underlying structures that provide the GPS functionalities ( the G4SPS*Distribution classes and the G4SPSRandomGenerator class) are shared among threads. This implies that modifying parameters of sources requires some attention: 1- Only one thread should change source parameters. 2- Changing of parameters can happen only between runs, when is guaranteed that no thread is accessing them 2- UI commands require that even if messenger is instantiated in a thread the commands are executed in the master (this is possible since V10.1) The simplest solution is to use UI commands to change GPS parameters and avoid C++ APIs. If this is inevitable a simple solution is to instantiate an instance of G4GeneralParticleSource explicitly in the master thread (for example in G4VUserActionInitialization::BuildForMaster() and set the defaults parameter there).

Definition at line 179 of file G4GeneralParticleSource.hh.

Constructor & Destructor Documentation

G4GeneralParticleSource()

G4GeneralParticleSource::G4GeneralParticleSource

(

)

Definition at line 78 of file G4GeneralParticleSource.cc.

                                                 : normalised(false),
    theMessenger(0)
{
    GPSData = G4GeneralParticleSourceData::Instance();
    //currentSource = GPSData->GetCurrentSource();
    //currentSourceIdx = G4int(GPSData->GetSourceVectorSize() - 1);

    //Messenger is special, only a worker should instantiate it. Singleton pattern
    theMessenger = G4GeneralParticleSourceMessenger::GetInstance(this);
    //Some initialization should be done only once
    G4AutoLock l(&messangerInit);
    static G4bool onlyOnce = false;
    if ( !onlyOnce ) {
        theMessenger->SetParticleGun(GPSData->GetCurrentSource());
        IntensityNormalization();
        onlyOnce = true;
    }
}

Here is the call graph for this function:

~G4GeneralParticleSource()

G4GeneralParticleSource::~G4GeneralParticleSource

(

)

Definition at line 97 of file G4GeneralParticleSource.cc.

{
    theMessenger->Destroy();
}

Here is the call graph for this function:

Member Function Documentation

AddaSource()

void G4GeneralParticleSource::AddaSource

(

G4double

aV

)

Definition at line 102 of file G4GeneralParticleSource.cc.

{
    GPSData->Lock();
    GPSData->AddASource(aV);
    theMessenger->SetParticleGun(GPSData->GetCurrentSource());
    //TODO: But do we really normalize here after each source?
    IntensityNormalization();
    GPSData->Unlock();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ClearAll()

void G4GeneralParticleSource::ClearAll

(

)

Definition at line 166 of file G4GeneralParticleSource.cc.

{
    GPSData->ClearSources();
    normalised=GPSData->Normalised();
}

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteaSource()

void G4GeneralParticleSource::DeleteaSource

(

G4int

aV

)

Definition at line 172 of file G4GeneralParticleSource.cc.

{
    G4int id = aV;
    if ( id <= GPSData->GetIntensityVectorSize() )
    {
        GPSData->DeleteASource(aV);
        normalised=GPSData->Normalised();
    }
    else
    {
        G4cout << " source index is invalid " << G4endl;
        G4cout << "    it shall be <= " << GPSData->GetIntensityVectorSize() << G4endl;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

GeneratePrimaryVertex()

void G4GeneralParticleSource::GeneratePrimaryVertex ( G4Event *  evt )

virtual

Implements G4VPrimaryGenerator.

Definition at line 187 of file G4GeneralParticleSource.cc.

{
    if (!GPSData->GetMultipleVertex())
    {
        G4SingleParticleSource* currentSource = GPSData->GetCurrentSource();
        if (GPSData->GetIntensityVectorSize() > 1)
        {
            //Try to minimize locks
            if (! normalised ) {
                //According to local variable, normalization is needed
                //Check with underlying shared resource, another
                //thread could have already normalized this
                GPSData->Lock();
                G4bool norm = GPSData->Normalised();
                if (!norm) {
                    IntensityNormalization();
                }
                //This takes care of the case in which the local variable
                //is False and the underlying resource is true.
                normalised = GPSData->Normalised();
                GPSData->Unlock();
            }
            G4double rndm = G4UniformRand();
            size_t i = 0 ;
            if (! GPSData->GetFlatSampling() )
            {
                while ( rndm > GPSData->GetSourceProbability(i) ) i++;
                currentSource = GPSData->GetCurrentSource(i);
            }
            else
            {
                i = size_t (GPSData->GetIntensityVectorSize()*rndm);
                currentSource = GPSData->GetCurrentSource(i);
            }
        }
        currentSource->GeneratePrimaryVertex(evt);
    } 
    else
    {
        for (G4int i = 0; i <  GPSData->GetIntensityVectorSize(); i++)
        {
            GPSData->GetCurrentSource(i)->GeneratePrimaryVertex(evt);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetCurrentSource()

G4SingleParticleSource* G4GeneralParticleSource::GetCurrentSource ( ) const

inline

Definition at line 193 of file G4GeneralParticleSource.hh.

          {return GPSData->GetCurrentSource();}

Here is the call graph for this function:

Here is the caller graph for this function:

GetCurrentSourceIndex()

G4int G4GeneralParticleSource::GetCurrentSourceIndex ( ) const

inline

Definition at line 195 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSourceIdx(); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetCurrentSourceIntensity()

G4double G4GeneralParticleSource::GetCurrentSourceIntensity ( ) const

inline

Definition at line 197 of file G4GeneralParticleSource.hh.

          { return GPSData->GetIntensity(GetCurrentSourceIndex()); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumberOfParticles()

G4int G4GeneralParticleSource::GetNumberOfParticles ( ) const

inline

Definition at line 238 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSource()->GetNumberOfParticles(); };

Here is the call graph for this function:

GetNumberofSource()

G4int G4GeneralParticleSource::GetNumberofSource ( )

inline

Definition at line 189 of file G4GeneralParticleSource.hh.

{ return GPSData->GetSourceVectorSize(); };

Here is the call graph for this function:

Here is the caller graph for this function:

GetParticleDefinition()

G4ParticleDefinition* G4GeneralParticleSource::GetParticleDefinition ( ) const

inline

Definition at line 217 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSource()->GetParticleDefinition();} ;

Here is the call graph for this function:

Here is the caller graph for this function:

GetParticleEnergy()

G4double G4GeneralParticleSource::GetParticleEnergy ( ) const

inline

Definition at line 244 of file G4GeneralParticleSource.hh.

          {return GPSData->GetCurrentSource()->GetParticleEnergy();};

Here is the call graph for this function:

Here is the caller graph for this function:

GetParticleMomentumDirection()

G4ThreeVector G4GeneralParticleSource::GetParticleMomentumDirection ( ) const

inline

Definition at line 242 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSource()->GetParticleMomentumDirection();};

Here is the call graph for this function:

Here is the caller graph for this function:

GetParticlePolarization()

G4ThreeVector G4GeneralParticleSource::GetParticlePolarization ( ) const

inline

Definition at line 226 of file G4GeneralParticleSource.hh.

          {return GPSData->GetCurrentSource()->GetParticlePolarization();};

Here is the call graph for this function:

GetParticlePosition()

G4ThreeVector G4GeneralParticleSource::GetParticlePosition ( ) const

inline

Definition at line 240 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSource()->GetParticlePosition();};

Here is the call graph for this function:

GetParticleTime()

G4double G4GeneralParticleSource::GetParticleTime ( ) const

inline

Definition at line 232 of file G4GeneralParticleSource.hh.

          { return GPSData->GetCurrentSource()->GetParticleTime(); };

Here is the call graph for this function:

IntensityNormalization()

void G4GeneralParticleSource::IntensityNormalization ( )

private

Definition at line 112 of file G4GeneralParticleSource.cc.

{
    GPSData->IntensityNormalise();
    normalised=GPSData->Normalised();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ListSource()

void G4GeneralParticleSource::ListSource

(

)

Definition at line 118 of file G4GeneralParticleSource.cc.

{
    G4cout << "The number of particle sources is: " << GPSData->GetIntensityVectorSize() << G4endl;
    G4cout <<" Multiple Vertex sources: "<<GPSData->GetMultipleVertex();
    G4cout <<" Flat Sampling flag: "<<GPSData->GetFlatSampling()<<G4endl;
    const G4int currentIdx = GPSData->GetCurrentSourceIdx();
    for(G4int i=0; i<GPSData->GetIntensityVectorSize(); i++)
    {
        G4cout << "\tsource " << i << " with intensity: " << GPSData->GetIntensity(i) << G4endl;
        const G4SingleParticleSource* thisSrc = GPSData->GetCurrentSource(i);
        G4cout <<" \t\tNum Particles: "<<thisSrc->GetNumberOfParticles()<<"; Particle type: "<<thisSrc->GetParticleDefinition()->GetParticleName()<<G4endl;
        G4cout <<" \t\tEnergy: "<<G4BestUnit(thisSrc->GetParticleEnergy(),"Energy")<<G4endl;
        G4cout <<" \t\tDirection: "<<thisSrc->GetAngDist()->GetDirection()<<"; Position: ";
        G4cout <<G4BestUnit(thisSrc->GetPosDist()->GetCentreCoords(),"Length")<<G4endl;
        G4cout <<" \t\tAngular Distribution: "<<thisSrc->GetAngDist()->GetDistType()<<G4endl;
        G4cout <<" \t\tEnergy Distribution: "<<thisSrc->GetEneDist()->GetEnergyDisType()<<G4endl;
        G4cout <<" \t\tPosition Distribution Type: "<<thisSrc->GetPosDist()->GetPosDisType();
        G4cout <<"; Position Shape: "<<thisSrc->GetPosDist()->GetPosDisShape()<<G4endl;
    }
    //Set back previous source
    GPSData->GetCurrentSource(currentIdx);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetCurrentSourceIntensity()

void G4GeneralParticleSource::SetCurrentSourceIntensity

(

G4double

aV

)

Definition at line 158 of file G4GeneralParticleSource.cc.

{
    GPSData->Lock();
    GPSData->SetCurrentSourceIntensity(aV);
    GPSData->Unlock();
    normalised = GPSData->Normalised();
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetCurrentSourceto()

void G4GeneralParticleSource::SetCurrentSourceto

(

G4int

aV

)

Definition at line 141 of file G4GeneralParticleSource.cc.

{
    G4int id = aV;
    if ( id < GPSData->GetIntensityVectorSize() )
    {
        //currentSourceIdx = aV;
        //currentSource = GPSData->GetCurrentSource(id);
        theMessenger->SetParticleGun(GPSData->GetCurrentSource(id));
    }
    else
    {
        G4ExceptionDescription msg;
        msg<<"Trying to set source to index "<<aV<<" but only "<<GPSData->GetIntensityVectorSize()<<" sources are defined.";
        G4Exception("G4GeneralParticleSoruce::SetCurrentSourceto","G4GPS004",FatalException,msg);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetFlatSampling()

void G4GeneralParticleSource::SetFlatSampling ( G4bool  av )

inline

Definition at line 211 of file G4GeneralParticleSource.hh.

{ GPSData->SetFlatSampling(av); normalised = false;} ;

Here is the call graph for this function:

Here is the caller graph for this function:

SetMultipleVertex()

void G4GeneralParticleSource::SetMultipleVertex ( G4bool  av )

inline

Definition at line 207 of file G4GeneralParticleSource.hh.

{ GPSData->SetMultipleVertex(av);} ;

Here is the call graph for this function:

Here is the caller graph for this function:

SetNumberOfParticles()

void G4GeneralParticleSource::SetNumberOfParticles ( G4int  i )

inline

Definition at line 235 of file G4GeneralParticleSource.hh.

          { GPSData->GetCurrentSource()->SetNumberOfParticles(i); };

Here is the call graph for this function:

SetParticleCharge()

void G4GeneralParticleSource::SetParticleCharge ( G4double  aCharge )

inline

Definition at line 220 of file G4GeneralParticleSource.hh.

          { GPSData->GetCurrentSource()->SetParticleCharge(aCharge); } ;

Here is the call graph for this function:

SetParticleDefinition()

void G4GeneralParticleSource::SetParticleDefinition ( G4ParticleDefinition *  aParticleDefinition )

inline

Definition at line 214 of file G4GeneralParticleSource.hh.

          {GPSData->GetCurrentSource()->SetParticleDefinition(aParticleDefinition); } ;

Here is the call graph for this function:

Here is the caller graph for this function:

SetParticlePolarization()

void G4GeneralParticleSource::SetParticlePolarization ( G4ThreeVector  aVal )

inline

Definition at line 224 of file G4GeneralParticleSource.hh.

          {GPSData->GetCurrentSource()->SetParticlePolarization(aVal);};

Here is the call graph for this function:

Here is the caller graph for this function:

SetParticleTime()

void G4GeneralParticleSource::SetParticleTime ( G4double  aTime )

inline

Definition at line 230 of file G4GeneralParticleSource.hh.

          { GPSData->GetCurrentSource()->SetParticleTime(aTime); };

Here is the call graph for this function:

Here is the caller graph for this function:

SetVerbosity()

void G4GeneralParticleSource::SetVerbosity ( G4int  i )

inline

Definition at line 204 of file G4GeneralParticleSource.hh.

{GPSData->SetVerbosityAllSources(i);} ;

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

GPSData

G4GeneralParticleSourceData* G4GeneralParticleSource::GPSData

private

Definition at line 259 of file G4GeneralParticleSource.hh.

normalised

G4bool G4GeneralParticleSource::normalised

private

Definition at line 254 of file G4GeneralParticleSource.hh.

theMessenger

G4GeneralParticleSourceMessenger* G4GeneralParticleSource::theMessenger

private

Definition at line 257 of file G4GeneralParticleSource.hh.

---

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

• G4GeneralParticleSource.hh
• G4GeneralParticleSource.cc