Introduction to GEANT4

From UCL HEP PBT Wiki

(Difference between revisions)
Jump to: navigation, search
m
Line 456: Line 456:
== <span style="color:#000080"> Optional user classes </span> ==
== <span style="color:#000080"> Optional user classes </span> ==
-
[http://geant4.web.cern.ch/geant4/UserDocumentation/Doxygen/examples_doc/html/group__extended__common__userActions.html Here] you can find an example of user defined RunAction and EventAction classes.
+
[http://geant4.web.cern.ch/geant4/UserDocumentation/Doxygen/examples_doc/html/group__extended__common__userActions.html Here] you can find examples of user defined RunAction and EventAction classes.

Revision as of 13:16, 8 July 2014

Contents

Introduction

GEANT4 is a software toolkit based on C++. In your code you have to define:

  • Your experimental setup - geometry, materials and primary particles.
  • Which physics process you are interested in.
  • You may take actions during the simulation - inspect and store results.

The interaction with GEANT4 is done via base classes.

Mandatory classes
  • G4VUserDetectorConstruction : Describe the experimental setup, geometry and materials;
  • G4VUserPhysicsList : Define particles, physics processes and range cuts;
  • G4VUserPrimaryGeneratorAction : Describe particle source, source dimensions, initial position, energy spectrum, angular distributions;
Optional classes
  • G4UserRunAction : Define and store histograms;
  • G4UserEventAction : Event selection and analysis of simulation data;
  • G4UserStackingAction : Customize priority of tracks;
  • G4UserTrackingAction : Decide whether a trajectory should be stored or not;
  • G4UserSteppingAction : Kill, suspend, postpone a track;
Manager class
  • G4RunManager : Manages the simulation process;

The function main()

The function main() defines the skeleton of your simulation code. Inside the function you instantiate G4RunManager and notify it of your mandatory and optional classes. This is example main() function, where MyDetectorConstruction , MyPhysicsList , MyPrimaryGeneratorAction , MyEventAction and MyRunAction are derived classes from the GEANT4 base classes:


int main() {

// Run manager construction

G4RunManager* runManager = new G4RunManager;


// mandatory user initialization classes

runManager->SetUserInitialization(new MyDetectorConstruction);

runManager->SetUserInitialization(new MyPhysicsList);


// mandatory user action classes

runManager->SetUserAction(new MyPrimaryGeneratorAction);


// optional user action classes

runManager->SetUserAction(new MyEventAction);

runManager->SetUserAction(new MyRunAction); ... }


Experimental setup

You derive your own class from G4VUserDetectorConstruction base class. In the derived class you will:

  • Describe the shape and the size of your detector using G4VSolid
  • Construct materials and electromagnetic fields using G4Logical Volume
  • Place volumes of your detector geometry using G4VPhysical Volume


Simple example of MyDetectorConstruction :


class MyDetectorConstruction:public G4VUserDetectorConstruction {

public:

MyDetectorConstruction();

~MyDetectorConstruction();

virtual G4VPhysicalVolume* Construct();


private:

void DefineMaterials(); };


Now construct the detector. Your detector is always placed in a mother volume called the world volume.


G4PhysicalVolume* MyDetectorConstruction::Construct() {

...

// World volume

G4VSolid* pWorld = new G4Box("World",5*m,5*m,5*m);

G4LogicalVolume* pWorldLog = new G4LogicalVolume(pWorld,vacuum, "World");

G4VPhysicalVolume* pWorldPhys = new G4PVPlacement(0,G4ThreeVector(),pWorldLog,"World",0,false,0);


// Water box

G4VSolid* pBoxSolid = new G4Box(“WaterBox”, 1.*m, 2.*m, 3.*m);

G4LogicalVolume* pBoxLog = new G4LogicalVolume( pBoxSolid, water, “WaterBox”);

G4VPhysicalVolume* aBoxPhys = new G4PVPlacement( pRotation, G4ThreeVector(posX, posY, posZ), pBoxLog, “WaterBox”, pWorldLog, false, copyNo); ... }


The elements and materials are defined using classes G4Element and G4Material . For example water, hydrogen and oxygen are defined as:


void MyDetectorConstruction::DefineMaterials() {

...

G4Element* H = new G4Element("Hydrogen","H",z=1.,a= 1.01*g/mole);

G4Element* O = new G4Element("Oxygen","O",z=8.,a=16.00*g/mole);


density = 1.000*g/cm3;

G4Material* H2O = new G4Material("Water",density,ncomp=2);

H2O->AddElement(H, natoms=2);

H2O->AddElement(O, natoms=1); ...}


Here you can find more examples of DetectorConstruction classes.


Physics processes

You can build your own physics list or chose from already built physics lists. To build your own physics lists, you can use two base physics list classes: G4VUserPhysicsList and G4ModularPhysicsList . The class G4VUserPhysicsList is used for simple physics lists while G4ModularPhysicsList is used to build more complex physics lists. There exist also already built pre-packaged physics lists.


Simple physics lists

If the particles in your simulation undergo a descrete number of physics processes you can use the class G4VUserPhysicsList to define them. This class has three methods:

  • ConstructParticles() : Define all necessary particles;
  • ConstructProcesses() : Define all necessary processes and assign them to proper particles;
  • SetCuts() : Define production thresholds in terms of range;


Simple example of MyPhysicsList :


class MyPhysicsList:public G4VUserPhysicsList() {

public:

MyPhysicsList();

~MyPhysicsList();

void ConstructParticle();

void ConstructProcess();

void SetCuts(); }


Now implement the methods ConstructParticle(), ConstructProcess() and SetCuts():


void MyPhysicsList::ConstructParticle() {

// Define the particles

G4Electron::ElectronDefinition();

G4Positron::PositronDefinition();

G4Proton::ProtonDefinition();

G4Neutron::NeutronDefinition();

G4Gamma::GammaDefinition(); ... }


GEANT4 provides a variety of physics processes. These processes are decoupled from one another and you can select those which are relevant to your simulation. The processes are grouped in seven categories and their list is available here:

  • electromagnetic
  • hadronic
  • decay
  • photolepton-hadron
  • optical
  • parameterization
  • transportation


For each particle defined in ConstructParticle() assign all the physics processes that you want to consider in your simulation:


void MyPhysicsList::ConstructProcess() {

AddTransportation(); // Assign transportation process to all particles

ConstructEM(); // Electromagnetic processes

ConstructGeneral(); // Other processes }


In methods ConstructEM() and ConstructGeneral() assign the physics processes to the corresponding particles:


void MyPhysicsList::ConstructEM() {

aParticleIterator->reset();

while((*aParticleIterator)()){

G4ParticleDefinition* particle = aParticleIterator->value();

G4ProcessManager* pmanager = particle->GetProcessManager();

G4String particleName = particle->GetParticleName();

if (particleName == "gamma") {

pmanager->AddDiscreteProcess(new G4GammaConversion); ...}


void MyPhysicsList::ConstructGeneral() {

G4Decay* theDecayProcess = new G4Decay()

aParticleIterator->reset();

while((*aParticleIterator)()) {

G4ParticleDefinition* particle = aParticleIterator->value();

G4ProcessManager* pmanager = particle->GetProcessManager();

if theDecayProcess->IsApplicable(*particle)) {

pmanager->AddProcess(theDecayProcess);

pmanager->SetProcessOrdering(theDecayProcess,idxPostStep);

pmanager->SetProcessOrdering(theDecayProcess,idxAtRest); }}}


This is the full list of physics processes every particle can participate in. Finally, method SetCuts() is defined as:


void MyPhysicsList::SetCuts() {

defaultCutValue = 1.0*mm;

SetCutValue(defaultCutValue, "gamma");

SetCutValue(defaultCutValue, "e+");

SetCutValue(defaultCutValue, "e-");


Detailed physics lists

If you want to build more realistic physics list you have to use the class G4VModularPhysicsList . For example, the photon from the example above can undergo compton scattering apart from conversion. In G4VModularPhysicsList you can group the physics processes into separate modules: EM physics, hadronic physics, decay physics etc.


Simple example of MyPhysicsList :


class MyPhysicsList:public G4VModularPhysicsList {

public:

MyPhysicsList();

~MyPhysicsList();

virtual void ConstructParticle();

virtual void SetCuts();

void AddPhysicsList(const G4String& name);

virtual void ConstructProcess();


private:

G4String fEmName;

G4VPhysicsConstructor* fEmPhysicsList;

G4VPhysicsConstructor* fDecPhysicsList;

std::vector<G4VPhysicsConstructor*> fHadronPhysicsList; };


Now we can build the physics lists:


void MyPhysicsList::AddPhysicsList(const G4String& name) {

...

if (name == "emstandard_opt3") {

fEmName = name;

delete fEmPhysicsList;

fEmPhysicsList = new G4EmStandardPhysics_option3();


} else if (name == "emlivermore") {

fEmName = name;

delete fEmPhysicsList;

fEmPhysicsList = new G4EmLivermorePhysics();


} else if (name == "empenelope") {

fEmName = name;

delete fEmPhysicsList;

fEmPhysicsList = new G4EmPenelopePhysics();


} else if (name == "HElastic") {

fHadronPhysicsList.push_back( new G4HadronHElasticPhysics());


} else if (name == "HInelastic") {

fHadronPhysicsList.push_back(new G4HadronInelasticQBBC());

} ... }


and


void MyPhysicsList::ConstructProcess() {

AddTransportation(); // transportation

fEmPhysicsList->ConstructProcess(); // electromagnetic physics list

fDecPhysicsList->ConstructProcess(); // decay physics list

for(size_t i=0; i<fHadronPhys.size(); i++) { // hadronic physics lists

fHadronPhys[i]->ConstructProcess(); } }


Pre-packaged physics lists

Some built-in pre-packaged physics lists are available here. You can use them as a starting point of your simulation.


Simple example of pre-packaged physics list :


In function main() :

G4PhysListFactory factory* physListFactory = new G4PhysListFactory();

G4VUserPhysicsList* physicsList = physListFactory->GetReferencePhysList(“FTFP_BERT”);

runManager->SetUserInitialization(physicsList);


Most of the pre-packaged physics lists use "standard" electromagnetic physics processes. The "standard" EM processes are defined with classes: G4EmStandardPhysics, G4EmStandardPhysics_option1, G4EmStandardPhysics_option2 and G4EmStandardPhysics_option3. If you want to use "low energy" electromagnetic physics processes (defined with classes G4EmLivermorePhysics, G4EmLivermorePolarizedPhysics, G4EmPenelopePhysics and G4EmDNAPhysics) in the pre-packaged physics list you have to define them in your physics list class (see example ProtonPencilBeam).


For example, if you want to simulate clinical proton beam of energy 150 MeV you can use pre-packaged physics list e.g. QGSP_BIC, QGSP_BERT and FTFP_BERT. If you are interested in Bragg curve physics, use a physics list ending in "EMV" or "EMX" e.g. QGSP_BERT_EMV.


Generate primary particles

You derive your own class from G4VUserPrimaryGeneratorAction base class. Actual generation of primary particles is done via classes G4ParticleGun and G4GeneralParticleSource .

  • G4ParticleGun is used to simulate a beam of particles. It shoots a primary particle of a certain energy and direction from a given point at a given time.
  • G4GeneralParticleSource simulates a beam of particles and the primary vertex is randomly chosen on surface of a given volume with pre-defined energy spectra, spatial and angular distribution.


Simple example of MyPrimaryGeneratorAction using particle gun :


class MyPrimaryGeneratorAction:public G4VUserPrimaryGeneratorAction {


public:

MyPrimaryGeneratorAction(

const G4String& particleName = "proton",

G4double energy = 1.*CLHEP::MeV,

G4ThreeVector position= G4ThreeVector(0,0,0),

G4ThreeVector momentumDirection = G4ThreeVector(0,0,1));

~MyPrimaryGeneratorAction();

virtual void GeneratePrimaries(G4Event*);


private:

G4ParticleGun* fParticleGun; };


Simple example of MyPrimaryGeneratorAction using general particle source :


class MyPrimaryGeneratorAction:public G4VUserPrimaryGeneratorAction {

public:

MyPrimaryGeneratorAction();

~MyPrimaryGeneratorAction();

virtual void GeneratePrimaries(G4Event*);


private:

static const G4String ParticleName;

static const G4double ParticleEnergy;

G4GeneralParticleSource* fGeneralParticleSource; };


Here you can find how to implement MyPrimaryGeneratorAction class defined above in your code.


Optional user classes

Here you can find examples of user defined RunAction and EventAction classes.

Personal tools