BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
BDSFieldEM.cc
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2023.
4
5This file is part of BDSIM.
6
7BDSIM is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published
9by the Free Software Foundation version 3 of the License.
10
11BDSIM is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
18*/
19#include "BDSFieldEM.hh"
20#include "BDSModulator.hh"
21
22#include "globals.hh"
23#include "G4ThreeVector.hh"
24#include "G4Transform3D.hh"
25
26#include <utility>
27
29 finiteStrength(true),
30 transform(G4Transform3D::Identity),
31 transformIsNotIdentity(false),
32 modulator(nullptr),
33 inverseTransform(G4Transform3D::Identity)
34{;}
35
36BDSFieldEM::BDSFieldEM(G4Transform3D transformIn):
37 finiteStrength(true),
38 transform(transformIn),
39 transformIsNotIdentity(transformIn != G4Transform3D::Identity),
40 modulator(nullptr),
41 inverseTransform(transformIn.inverse())
42{;}
43
44std::pair<G4ThreeVector,G4ThreeVector> BDSFieldEM::GetFieldTransformed(const G4ThreeVector& position,
45 const G4double t) const
46{
47 if (!finiteStrength)
48 {return std::make_pair(G4ThreeVector(), G4ThreeVector());} // quicker than query
50 {
51 G4ThreeVector transformedPosition = transform * (HepGeom::Point3D<G4double>)position;
52 auto field = GetField(transformedPosition, t);
53 G4ThreeVector transformedBField = transform * (HepGeom::Vector3D<G4double>)field.first;
54 G4ThreeVector transformedEField = transform * (HepGeom::Vector3D<G4double>)field.second;
55 if (modulator)
56 {
57 G4double factor = modulator->Factor(position, t);
58 transformedBField *= factor;
59 transformedEField *= factor;
60 }
61 return std::make_pair(transformedBField, transformedEField);
62 }
63 else
64 {
65 auto field = GetField(position, t);
66 if (modulator)
67 {
68 G4double factor = modulator->Factor(position, t);
69 field.first *= factor;
70 field.second *= factor;
71 }
72 return field;
73 }
74}
75
76void BDSFieldEM::GetFieldValue(const G4double point[4],
77 G4double* field) const
78{
79 auto fieldValue = GetFieldTransformed(G4ThreeVector(point[0], point[1], point[2]), point[3]);
80 field[0] = fieldValue.first[0]; // B_x
81 field[1] = fieldValue.first[1]; // B_y
82 field[2] = fieldValue.first[2]; // B_z
83 field[3] = fieldValue.second[0]; // E_x
84 field[4] = fieldValue.second[1]; // E_y
85 field[5] = fieldValue.second[2]; // E_z
86}
87
88void BDSFieldEM::SetTransform(const G4Transform3D& transformIn)
89{
90 transform = transformIn;
91 transformIsNotIdentity = transformIn != G4Transform3D::Identity;
92 inverseTransform = transformIn.inverse();
93}
G4Transform3D inverseTransform
The complimentary transform used to initially rotate the point of query.
Definition: BDSFieldEM.hh:98
virtual void SetTransform(const G4Transform3D &transformIn)
Definition: BDSFieldEM.cc:88
G4bool transformIsNotIdentity
Cache of whether to use transform at all.
Definition: BDSFieldEM.hh:93
virtual std::pair< G4ThreeVector, G4ThreeVector > GetField(const G4ThreeVector &position, const G4double t=0) const =0
G4Transform3D transform
Transform to apply for the field relative to the local coordinates of the geometry.
Definition: BDSFieldEM.hh:91
BDSModulator * modulator
Optional modulator;.
Definition: BDSFieldEM.hh:94
virtual void GetFieldValue(const G4double point[4], G4double *field) const
Definition: BDSFieldEM.cc:76
virtual std::pair< G4ThreeVector, G4ThreeVector > GetFieldTransformed(const G4ThreeVector &position, const G4double t) const
Get the field value after applying transform for local offset.
Definition: BDSFieldEM.cc:44
G4bool finiteStrength
Flag to cache whether finite nor not.
Definition: BDSFieldEM.hh:88
virtual G4double Factor(const G4ThreeVector &xyz, G4double T) const =0