| 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 /*
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 * team@amentum.space
46 */
47 #ifndef PeriodicBoundaryProcess_h
48 #define PeriodicBoundaryProcess_h 1
49
50 #include "ParticleChangeForPeriodic.hh"
51
52 #include "G4Electron.hh"
53 #include "G4VDiscreteProcess.hh"
54 #include "globals.hh"
55
56 class G4Step;
57
58 enum ProcessStatus
59 {
60 Undefined,
61 Reflection,
62 Cycling,
63 StepTooSmall,
64 NotAtBoundary
65 };
66
67 class PeriodicBoundaryProcess : public G4VDiscreteProcess
68 {
69 public:
70 explicit PeriodicBoundaryProcess(const G4String& processName = "PBC",
71 G4ProcessType type = fNotDefined, bool per_x = true,
72 bool per_y = true, bool per_z = true);
73
74 ~PeriodicBoundaryProcess() override = default;
75
76 PeriodicBoundaryProcess(const PeriodicBoundaryProcess& right) = delete;
77
78 PeriodicBoundaryProcess& operator=(const PeriodicBoundaryProcess& right) = delete;
79
80 public:
81 G4bool IsApplicable(const G4ParticleDefinition&) override;
82
83 G4double GetMeanFreePath(const G4Track&, G4double, G4ForceCondition* condition) override;
84
85 ProcessStatus GetStatus() const;
86
87 G4VParticleChange* PostStepDoIt(const G4Track&, const G4Step&) override;
88
89 protected:
90 ParticleChangeForPeriodic fParticleChange;
91
92 private:
93 void BoundaryProcessVerbose();
94 std::map<ProcessStatus, G4String> fStatusMessages = {{Undefined, " *** Undefined *** "},
95 {NotAtBoundary, " *** NotAtBoundary *** "},
96 {Reflection, " *** Reflection *** "},
97 {Cycling, " *** Periodic *** "},
98 {StepTooSmall, " *** StepTooSmall *** "}};
99
100 ProcessStatus fTheStatus = Undefined;
101 G4ThreeVector fOldPosition;
102 G4ThreeVector fNewPosition;
103 G4ThreeVector fOldMomentum;
104 G4ThreeVector fNewMomentum;
105 G4ThreeVector fOldPolarization;
106 G4ThreeVector fNewPolarization;
107 G4ThreeVector fTheGlobalNormal;
108 G4double fkCarTolerance;
109 G4bool fPeriodicX = true;
110 G4bool fPeriodicY = true;
111 G4bool fPeriodicZ = true;
112 };
113
114 inline G4bool PeriodicBoundaryProcess::IsApplicable(const G4ParticleDefinition& aParticleType)
115 {
116 G4bool applicable = false;
117 // applied only for electrons
118 if (&aParticleType == G4Electron::Electron()) {
119 applicable = true;
120 }
121 return applicable;
122 }
123
124 inline ProcessStatus PeriodicBoundaryProcess::GetStatus() const
125 {
126 return fTheStatus;
127 }
128
129 #endif
130