| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4VPrimaryGenerator
27 //
28 // Class description:
29 //
30 // This is an abstract base class of all of primary generators.
31 // This class has only one pure virtual method GeneratePrimaryVertex()
32 // which takes a G4Event object and generates a primay vertex and
33 // primary particles associate to the vertex
34
35 // Author: Makoto Asai (SLAC)
36 // --------------------------------------------------------------------
37 #ifndef G4VPrimaryGenerator_hh
38 #define G4VPrimaryGenerator_hh 1
39
40 #include "G4ThreeVector.hh"
41
42 class G4Event;
43
44 class G4VPrimaryGenerator
45 {
46 public:
47
48 G4VPrimaryGenerator() = default;
49 virtual ~G4VPrimaryGenerator() = default;
50 // Constructor and destructor
51
52 static G4bool CheckVertexInsideWorld(const G4ThreeVector& pos);
53 // Static service method for checking a point is included
54 // in the (current) world
55
56 virtual void GeneratePrimaryVertex(G4Event* evt) = 0;
57 // Pure virtual method which a concrete class derived from this
58 // base class must implement
59
60 inline G4ThreeVector GetParticlePosition() { return particle_position; }
61 inline G4double GetParticleTime() { return particle_time; }
62
63 void SetParticlePosition(G4ThreeVector aPosition);
64 // Sets the initial position of the primary vertex.
65 // The position must obviously be located inside the world volume.
66 // A location on the surface of the world volume is also discouraged,
67 // to avoid setting the momentum direction pointing out of the world
68 // and therefore causing undefined behaviour and crash
69
70 inline void SetParticleTime(G4double aTime)
71 { particle_time = aTime; }
72
73 inline void CheckInside(G4bool val=true)
74 { ifCheckInside = val; }
75 inline G4bool IfCheckInside()
76 { return ifCheckInside; }
77
78 protected:
79
80 G4ThreeVector particle_position; // Initialised at (0, 0, 0)
81 G4double particle_time = 0.0;
82 G4bool ifCheckInside = true;
83 };
84
85 #endif
86