| Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of
>> 2 // the GEANT4 collaboration.
1 // 3 //
2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work
3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement,
4 // * << 6 // and all its terms.
5 // * The Geant4 software is copyright of th <<
6 // * the Geant4 Collaboration. It is provided <<
7 // * conditions of the Geant4 Software License <<
8 // * LICENSE and available at http://cern.ch/ <<
9 // * include a list of copyright holders. <<
10 // * <<
11 // * Neither the authors of this software syst <<
12 // * institutes,nor the agencies providing fin <<
13 // * work make any representation or warran <<
14 // * regarding this software system or assum <<
15 // * use. Please see the license in the file <<
16 // * for the full disclaimer and the limitatio <<
17 // * <<
18 // * This code implementation is the result <<
19 // * technical work of the GEANT4 collaboratio <<
20 // * By using, copying, modifying or distri <<
21 // * any work based on the software) you ag <<
22 // * use in resulting scientific publicati <<
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* <<
25 // 7 //
26 // G4UserLimits << 8 // $Id: G4UserLimits.hh,v 1.6 2000/02/17 16:13:06 gcosmo Exp $
>> 9 // GEANT4 tag $Name: geant4-03-01 $
>> 10 //
>> 11 //
>> 12 // class G4UserLimits
27 // 13 //
28 // Class description: 14 // Class description:
29 // 15 //
30 // Simple placeholder for user Step limitation 16 // Simple placeholder for user Step limitations
31 // In order to activate these limitations, use << 17 //
32 // their "special" processes to each particle << 18
33 // Sample processes below can be found under p << 19 // Author: Paul Kent August 96
34 // MaxAllowedStep : UserStepLimit << 20 //
35 // other limitation : UserSpecialCuts << 21 // 01-11-97: change GetMaxAllowedStep(), Hisaya Kurashige
36 // In addition, users can add their own Step l << 22 // 08-04-98: new data members, mma
37 // a new class derived from G4UserLimits. In t << 23 // 02-16-00: add fType member and accessors, Hisaya Kurashige
38 // is supposed to be used to identify the clas << 24 //
39 <<
40 // Author: Paul Kent, August 1996 <<
41 // Revisions: <<
42 // - 01-11-1997, H.Kurashige: changed GetMaxAl <<
43 // - 08-04-1998: M.Maire: new data members <<
44 // ------------------------------------------- <<
45 #ifndef G4USERLIMITS_HH 25 #ifndef G4USERLIMITS_HH
46 #define G4USERLIMITS_HH 1 << 26 #define G4USERLIMITS_HH
47 27
48 #include "globals.hh" 28 #include "globals.hh"
49 29
50 class G4Track; 30 class G4Track;
51 31
52 class G4UserLimits 32 class G4UserLimits
53 { 33 {
54 public: << 34 public: // with description
55 G4UserLimits(G4double ustepMax = DBL_MAX, G4 << 35
56 G4double utimeMax = DBL_MAX, G4 << 36 G4UserLimits(G4double ustepMax = DBL_MAX,
57 G4double urangMin = 0.); << 37 G4double utrakMax = DBL_MAX,
58 G4UserLimits(const G4String& type, G4double << 38 G4double utimeMax = DBL_MAX,
59 G4double utrakMax = DBL_MAX, G4 << 39 G4double uekinMin = 0.,
60 G4double uekinMin = 0., G4doubl << 40 G4double urangMin = 0. );
>> 41 G4UserLimits(const G4String& type,
>> 42 G4double ustepMax = DBL_MAX,
>> 43 G4double utrakMax = DBL_MAX,
>> 44 G4double utimeMax = DBL_MAX,
>> 45 G4double uekinMin = 0.,
>> 46 G4double urangMin = 0. );
61 virtual ~G4UserLimits(); 47 virtual ~G4UserLimits();
62 48
63 virtual G4double GetMaxAllowedStep(const G4T << 49 public: // with description
64 // If a logical volume has a G4UserLimits ob << 50
65 // be limited as shorter than MaxAllowedStep << 51 virtual G4double GetMaxAllowedStep(const G4Track&);
>> 52 // If a Logical Volume has a G4UserLimits object, the Step length should
>> 53 // be limited as shorter than MaxAllowedStep in the volume.
>> 54 // In the current design, the other limits are irrelevant in tracking
66 55
67 virtual G4double GetUserMaxTrackLength(const << 56 virtual G4double GetUserMaxTrackLength(const G4Track&) ;
68 virtual G4double GetUserMaxTime(const G4Trac << 57 virtual G4double GetUserMaxTime (const G4Track&);
69 virtual G4double GetUserMinEkine(const G4Tra 58 virtual G4double GetUserMinEkine(const G4Track&);
70 virtual G4double GetUserMinRange(const G4Tra 59 virtual G4double GetUserMinRange(const G4Track&);
71 << 60
72 virtual void SetMaxAllowedStep(G4double uste << 61 virtual void SetMaxAllowedStep(G4double ustepMax);
73 virtual void SetUserMaxTrackLength(G4double 62 virtual void SetUserMaxTrackLength(G4double utrakMax);
74 virtual void SetUserMaxTime(G4double utimeMa 63 virtual void SetUserMaxTime(G4double utimeMax);
75 virtual void SetUserMinEkine(G4double uekinM 64 virtual void SetUserMinEkine(G4double uekinMin);
76 virtual void SetUserMinRange(G4double urangM 65 virtual void SetUserMinRange(G4double urangMin);
77 66
78 const G4String& GetType() const; << 67 const G4String & GetType() const;
79 void SetType(const G4String& type); << 68 void SetType(const G4String& type);
80 // Set/Get type name for UserLimits. 69 // Set/Get type name for UserLimits.
81 // This type member is supposed to be used t 70 // This type member is supposed to be used to check real class types for
82 // each concrete instantiation of G4UserLimi 71 // each concrete instantiation of G4UserLimits. In other words, users who
83 // use special classes derived from this bas << 72 // use special classes derived from this base class should name their class
84 // class with a proper identifier << 73 // with a proper identifier.
85 << 74
86 protected: << 75 protected: // with description
87 G4double fMaxStep = 0.; // max allowed Ste << 76
88 G4double fMaxTrack = 0.; // max total track << 77 G4double fMaxStep; // max allowed Step size in this volume
89 G4double fMaxTime = 0.; // max time << 78 G4double fMaxTrack; // max total track length
90 G4double fMinEkine = 0.; // min kinetic ene << 79 G4double fMaxTime; // max time
91 G4double fMinRange = 0.; // min remaining r << 80 G4double fMinEkine; // min kinetic energy (only for charged particles)
>> 81 G4double fMinRange; // min remaining range (only for charged particles)
92 82
93 G4String fType; // type name << 83 G4String fType; // type name
94 }; 84 };
95 85
96 #include "G4UserLimits.icc" 86 #include "G4UserLimits.icc"
97 87
98 #endif 88 #endif
99 89