Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/extended/medical/dna/UHDR/include/ParticleChangeForPeriodic.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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 /*
 27  * Based on 'G4pbc'.
 28  * Copyright (c) 2020 Amentum Pty Ltd
 29  * team@amentum.space
 30  * The original open-source version of this code
 31  * may be found at https://github.com/amentumspace/g4pbc
 32  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 33  * associated documentation files (the "Software"), to deal in the Software without restriction,
 34  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 35  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
 36  * is furnished to do so, subject to the following conditions:
 37  * The above copyright notice and this permission notice shall be included in all copies
 38  * or substantial portions of the Software.
 39  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
 40  * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 41  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 42  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 43  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 44  *
 45  *
 46  */
 47 #ifndef ParticleChangeForPeriodic_hh
 48 #define ParticleChangeForPeriodic_hh 1
 49 
 50 #include "G4VParticleChange.hh"
 51 #include "globals.hh"
 52 
 53 class G4DynamicParticle;
 54 
 55 class ParticleChangeForPeriodic : public G4VParticleChange
 56 {
 57   public:
 58     ParticleChangeForPeriodic();
 59 
 60     ~ParticleChangeForPeriodic() override = default;
 61 
 62     G4Step* UpdateStepForPostStep(G4Step* Step) override;
 63 
 64     void InitializeForPostStep(const G4Track&);
 65 
 66     void AddSecondary(G4DynamicParticle* aParticle);
 67 
 68     const G4ThreeVector& GetProposedMomentumDirection() const;
 69 
 70     void ProposeMomentumDirection(G4double Px, G4double Py, G4double Pz);
 71 
 72     void ProposeMomentumDirection(const G4ThreeVector& Pfinal);
 73 
 74     const G4ThreeVector& GetProposedPolarization() const;
 75 
 76     void ProposePolarization(const G4ThreeVector& dir);
 77 
 78     void ProposePolarization(G4double Px, G4double Py, G4double Pz);
 79 
 80     const G4ThreeVector& GetProposedPosition() const;
 81 
 82     void ProposePosition(const G4ThreeVector& pos);
 83 
 84     void ProposePosition(G4double x, G4double y, G4double z);
 85 
 86     const G4Track* GetCurrentTrack() const;
 87 
 88     void DumpInfo() const override;
 89 
 90     ParticleChangeForPeriodic(const ParticleChangeForPeriodic& right) = delete;
 91 
 92     ParticleChangeForPeriodic& operator=(const ParticleChangeForPeriodic& right) = delete;
 93 
 94   private:
 95     const G4Track* fTrack{};
 96     G4ThreeVector fProposedMomentumDirection;
 97     G4ThreeVector fProposedPolarization;
 98     G4ThreeVector fProposedPosition;
 99 };
100 
101 inline const G4ThreeVector& ParticleChangeForPeriodic::GetProposedMomentumDirection() const
102 {
103   return fProposedMomentumDirection;
104 }
105 
106 inline void ParticleChangeForPeriodic::ProposeMomentumDirection(const G4ThreeVector& dir)
107 {
108   fProposedMomentumDirection = dir;
109 }
110 
111 inline void ParticleChangeForPeriodic::ProposeMomentumDirection(G4double Px, G4double Py,
112                                                                 G4double Pz)
113 {
114   fProposedMomentumDirection.setX(Px);
115   fProposedMomentumDirection.setY(Py);
116   fProposedMomentumDirection.setZ(Pz);
117 }
118 
119 inline const G4ThreeVector& ParticleChangeForPeriodic::GetProposedPolarization() const
120 {
121   return fProposedPolarization;
122 }
123 
124 inline void ParticleChangeForPeriodic::ProposePolarization(const G4ThreeVector& dir)
125 {
126   fProposedPolarization = dir;
127 }
128 
129 inline void ParticleChangeForPeriodic::ProposePolarization(G4double Px, G4double Py, G4double Pz)
130 {
131   fProposedPolarization.setX(Px);
132   fProposedPolarization.setY(Py);
133   fProposedPolarization.setZ(Pz);
134 }
135 
136 inline const G4ThreeVector& ParticleChangeForPeriodic::GetProposedPosition() const
137 {
138   return fProposedPosition;
139 }
140 
141 inline void ParticleChangeForPeriodic::ProposePosition(const G4ThreeVector& dir)
142 {
143   fProposedPosition = dir;
144 }
145 
146 inline void ParticleChangeForPeriodic::ProposePosition(G4double Px, G4double Py, G4double Pz)
147 {
148   fProposedPosition.setX(Px);
149   fProposedPosition.setY(Py);
150   fProposedPosition.setZ(Pz);
151 }
152 
153 inline void ParticleChangeForPeriodic::InitializeForPostStep(const G4Track& track)
154 {
155   theStatusChange = track.GetTrackStatus();
156   theLocalEnergyDeposit = 0.0;
157   theNonIonizingEnergyDeposit = 0.0;
158   InitializeSecondaries();
159   theParentWeight = track.GetWeight();
160   isParentWeightProposed = false;
161   fProposedMomentumDirection = track.GetMomentumDirection();
162   fProposedPolarization = track.GetPolarization();
163   fProposedPosition = track.GetPosition();
164   fTrack = &track;
165 }
166 
167 inline const G4Track* ParticleChangeForPeriodic::GetCurrentTrack() const
168 {
169   return fTrack;
170 }
171 #endif