Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer 3 // * License and Disclaimer * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of * 6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and * 7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file * 8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These * 9 // * include a list of copyright holders. 9 // * include a list of copyright holders. * 10 // * 10 // * * 11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above * 16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. * 17 // * 17 // * * 18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and * 19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. * 20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or * 21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its * 22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your * 23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. * 24 // ******************************************* 24 // ******************************************************************** 25 // 25 // 26 // G4WrapperProcess << 27 // 26 // 28 // Class description: << 29 // 27 // 30 // Virtual class for wrapper process objects. << 28 // >> 29 // ------------------------------------------------------------ >> 30 // GEANT 4 class header file >> 31 // >> 32 // Class Description >> 33 // >> 34 // This class is the virtual class for wrapper process objects. >> 35 >> 36 // ------------------------------------------------------------ >> 37 // New Physics scheme 18 Dec. 1996 H.Kurahige >> 38 // ------------------------------------------------------------ 31 39 32 // Author: H.Kurahige, 18 December 1996 << 40 #ifndef G4WrapperProcess_h 33 // ------------------------------------------- << 41 #define G4WrapperProcess_h 1 34 #ifndef G4WrapperProcess_hh << 35 #define G4WrapperProcess_hh 1 << 36 42 37 #include "globals.hh" 43 #include "globals.hh" 38 #include "G4ios.hh" 44 #include "G4ios.hh" 39 #include "G4VProcess.hh" 45 #include "G4VProcess.hh" 40 46 41 class G4WrapperProcess : public G4VProcess 47 class G4WrapperProcess : public G4VProcess 42 { 48 { 43 public: << 49 // A virtual class for wrapper process objects. 44 << 45 G4WrapperProcess(const G4String& aName = << 46 G4ProcessType aType = fNo << 47 // Constructor requires the process name << 48 << 49 G4WrapperProcess(const G4WrapperProcess& r << 50 // Copy constructor copies the name but << 51 // physics table (null pointer is assign << 52 50 53 virtual ~G4WrapperProcess(); << 51 private: 54 // Destructor << 52 // hide default constructor and assignment operator as private >> 53 // do not hide default constructor for alpha version >> 54 inline G4WrapperProcess & operator=(const G4WrapperProcess &right); >> 55 >> 56 public: // with description >> 57 // constructor requires the process name and type >> 58 G4WrapperProcess(const G4String& aName = "Wrapped", >> 59 G4ProcessType aType = fNotDefined ); >> 60 >> 61 // copy constructor copys the name but does not copy the >> 62 // physics table (0 pointer is assigned) >> 63 G4WrapperProcess(const G4WrapperProcess &right); >> 64 >> 65 public: >> 66 // destructor >> 67 virtual ~G4WrapperProcess(); >> 68 >> 69 // equality opperators >> 70 inline G4bool operator==(const G4WrapperProcess &right) const; >> 71 inline G4bool operator!=(const G4WrapperProcess &right) const; 55 72 56 G4WrapperProcess& operator=(const G4Wrappe << 73 public: // with description 57 << 74 virtual void RegisterProcess(G4VProcess*); 58 inline G4bool operator==(const G4WrapperPr << 59 inline G4bool operator!=(const G4WrapperPr << 60 // Equality operators << 61 << 62 virtual void RegisterProcess(G4VProcess*); << 63 virtual const G4VProcess* GetRegisteredPro 75 virtual const G4VProcess* GetRegisteredProcess() const; 64 76 65 //////////////////////////// << 77 protected: 66 // DoIt ///////////////// << 78 G4VProcess* pRegProcess; 67 /////////////////////////// << 68 79 69 virtual G4VParticleChange* PostStepDoIt( << 80 public: // with description >> 81 //////////////////////////// >> 82 // DoIt ///////////////// >> 83 /////////////////////////// >> 84 virtual G4VParticleChange* PostStepDoIt( 70 const G4Track& tr 85 const G4Track& track, 71 const G4Step& st 86 const G4Step& stepData 72 ); 87 ); 73 88 74 virtual G4VParticleChange* AlongStepDoIt( << 89 virtual G4VParticleChange* AlongStepDoIt( 75 const G4Track& tr 90 const G4Track& track, 76 const G4Step& ste 91 const G4Step& stepData 77 ); 92 ); 78 virtual G4VParticleChange* AtRestDoIt( << 93 virtual G4VParticleChange* AtRestDoIt( 79 const G4Track& tr 94 const G4Track& track, 80 const G4Step& ste 95 const G4Step& stepData 81 ); 96 ); 82 << 97 ////////////////////////// 83 ////////////////////////// << 98 // GPIL ////////////// 84 // GPIL ////////////// << 99 ///////////////////////// 85 ///////////////////////// << 100 virtual G4double AlongStepGetPhysicalInteractionLength( 86 << 87 virtual G4double AlongStepGetPhysicalInter << 88 const G4Track& tr 101 const G4Track& track, 89 G4double previou 102 G4double previousStepSize, 90 G4double current 103 G4double currentMinimumStep, 91 G4double& propose 104 G4double& proposedSafety, 92 G4GPILSelection* 105 G4GPILSelection* selection); 93 106 94 virtual G4double AtRestGetPhysicalInteract << 107 virtual G4double AtRestGetPhysicalInteractionLength( 95 const G4Track& tr 108 const G4Track& track, 96 G4ForceCondition* 109 G4ForceCondition* condition 97 ); 110 ); 98 111 99 virtual G4double PostStepGetPhysicalIntera << 112 virtual G4double PostStepGetPhysicalInteractionLength( 100 const G4Track& tr 113 const G4Track& track, 101 G4double previo 114 G4double previousStepSize, 102 G4ForceCondition* 115 G4ForceCondition* condition 103 ); << 116 ) ; 104 117 105 virtual G4bool IsApplicable(const G4Partic << 118 ////////////////////// >> 119 virtual G4bool IsApplicable(const G4ParticleDefinition&); 106 // Returns true if this process object i 120 // Returns true if this process object is applicable to 107 // the particle type 121 // the particle type 108 // Process will not be registered to a p 122 // Process will not be registered to a particle if IsApplicable is false 109 123 110 virtual void BuildPhysicsTable(const G4Par << 124 virtual void BuildPhysicsTable(const G4ParticleDefinition&); 111 // Messaged by the Particle definition ( 125 // Messaged by the Particle definition (via the Process manager) 112 // whenever cross-section tables have to << 126 // whenever cross section tables have to be rebuilt (i.e. if new 113 // materials have been defined). 127 // materials have been defined). 114 // It is overloaded by individual proces 128 // It is overloaded by individual processes when they need physics 115 // tables << 129 // tables. 116 130 117 // Processes which build (for example in t << 131 // Processes which Build (for example in their 118 // physics tables independent of cuts shou << 132 // constructors) physics tables independent of cuts 119 // void BuildThePhysicsTable() function. << 133 // should preferably use a 120 // **Not** another BuildPhysicsTable(). << 134 // private void BuildThePhysicsTable() >> 135 // function. Not another BuildPhysicsTable, please. 121 136 122 virtual void PreparePhysicsTable(const G4P << 137 virtual void PreparePhysicsTable(const G4ParticleDefinition&); 123 // Messaged by the Particle definition ( 138 // Messaged by the Particle definition (via the Process manager) 124 // whenever cross-section tables have to << 139 // whenever cross section tables have to be prepare for rebuilt 125 // (i.e. if new materials have been defi 140 // (i.e. if new materials have been defined). 126 // It is overloaded by individual proces 141 // It is overloaded by individual processes when they need physics 127 // tables << 142 // tables. >> 143 >> 144 // Processes which Build physics tables independent of cuts >> 145 // (for example in their constructors) >> 146 // should preferably use private >> 147 // void BuildThePhysicsTable() and void PreparePhysicsTable(). >> 148 // Not another BuildPhysicsTable, please. 128 149 129 150 130 virtual G4bool StorePhysicsTable(const G4P << 151 virtual G4bool StorePhysicsTable(const G4ParticleDefinition* , 131 const G4S << 152 const G4String& directory, 132 G4bool as << 153 G4bool ascii = false); 133 // Store PhysicsTable in a file. 154 // Store PhysicsTable in a file. 134 // Return false in case of failure at I/ << 155 // (return false in case of failure at I/O ) 135 156 136 virtual G4bool RetrievePhysicsTable( const << 157 virtual G4bool RetrievePhysicsTable( const G4ParticleDefinition* , 137 const << 158 const G4String& directory, 138 G4boo << 159 G4bool ascii = false); 139 // Retrieve Physics from a file. 160 // Retrieve Physics from a file. 140 // Return true if the Physics Table can << 161 // (return true if the Physics Table can be build by using file) 141 // Return false if the process has no fu << 162 // (return false if the process has no functionality or in case of failure) 142 // File name should be defined by each p << 163 // File name should be defined by each process 143 // placed under the directory specified << 164 // and the file should be placed under the directory specifed by the argument. 144 << 165 //////////////////////////// 145 virtual void StartTracking(G4Track*); << 166 virtual void StartTracking(G4Track*); 146 virtual void EndTracking(); << 167 virtual void EndTracking(); 147 // inform Start/End of tracking for each 168 // inform Start/End of tracking for each track to the physics process 148 169 149 virtual void SetProcessManager(const G4Pro << 170 public: 150 // A process manager sets its own pointe << 171 virtual void SetProcessManager(const G4ProcessManager*); 151 // in the process Manager << 172 // A process manager set its own pointer when the process is registered 152 virtual const G4ProcessManager* GetProces << 173 // the process Manager >> 174 virtual const G4ProcessManager* GetProcessManager(); 153 // Get the process manager which the pro 175 // Get the process manager which the process belongs to 154 176 155 virtual void ResetNumberOfInteractionLengt << 177 public: 156 // Reset (determine the value of) Number << 178 virtual void ResetNumberOfInteractionLengthLeft(); 157 virtual void SetMasterProcess(G4VProcess* << 179 // reset (determine the value of)NumberOfInteractionLengthLeft 158 // Needed for MT, forward call to underl << 180 virtual void SetMasterProcess(G4VProcess* masterP); 159 << 181 // Needed for MT, forward call to underlying process 160 protected: << 161 << 162 G4VProcess* pRegProcess = nullptr; << 163 }; 182 }; 164 183 165 // ------------------------ << 184 inline 166 // Inline operators << 185 G4WrapperProcess & G4WrapperProcess::operator=(const G4WrapperProcess &) 167 // ------------------------ << 186 { >> 187 G4Exception("G4WrapperProcess::operator=","Illegal operation", >> 188 JustWarning,"Assignment operator is called"); >> 189 return *this; >> 190 } 168 191 169 inline 192 inline 170 G4bool G4WrapperProcess::operator==(const G4Wr << 193 G4bool G4WrapperProcess::operator==(const G4WrapperProcess &right) const 171 { 194 { 172 return (this == &right); 195 return (this == &right); 173 } 196 } 174 197 175 inline 198 inline 176 G4bool G4WrapperProcess::operator!=(const G4Wr << 199 G4bool G4WrapperProcess::operator!=(const G4WrapperProcess &right) const 177 { 200 { 178 return (this != &right); << 201 return (this != &right); 179 } 202 } 180 203 181 #endif 204 #endif 182 205