BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
BDSFieldMag.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 "BDSFieldMag.hh"
20#include "BDSModulator.hh"
21
22#include "globals.hh"
23#include "G4ThreeVector.hh"
24#include "G4Transform3D.hh"
25
26#include <cmath>
27
29 finiteStrength(true),
30 transform(G4Transform3D::Identity),
31 transformIsNotIdentity(false),
32 modulator(nullptr),
33 inverseTransform(G4Transform3D::Identity)
34{;}
35
36BDSFieldMag::BDSFieldMag(G4Transform3D transformIn):
37 finiteStrength(true),
38 transform(transformIn),
39 transformIsNotIdentity(transformIn != G4Transform3D::Identity),
40 modulator(nullptr),
41 inverseTransform(transformIn.inverse())
42{;}
43
44G4ThreeVector BDSFieldMag::GetFieldTransformed(const G4ThreeVector& position,
45 const G4double t) const
46{
47 if (!finiteStrength)
48 {return G4ThreeVector();} // quicker than query
50 {
51 G4ThreeVector transformedPosition = inverseTransform * (HepGeom::Point3D<G4double>)position;
52 G4ThreeVector field = GetField(transformedPosition, t);
53 if (modulator)
54 {
55 G4double factor = modulator->Factor(transformedPosition, t);
56 field *= factor;
57 }
58 G4ThreeVector transformedField = transform * (HepGeom::Vector3D<G4double>)field;
59 return transformedField;
60 }
61 else
62 {
63 G4ThreeVector field = GetField(position, t);
64 if (modulator)
65 {
66 G4double factor = modulator->Factor(position, t);
67 field *= factor;
68 }
69 return field;
70 }
71}
72
73void BDSFieldMag::GetFieldValue(const G4double point[4],
74 G4double* field) const
75{
76 G4double t = point[3];
77 if (std::isnan(t))
78 {t = 0;}
79 G4ThreeVector fieldValue = GetFieldTransformed(G4ThreeVector(point[0], point[1], point[2]), t);
80 field[0] = fieldValue[0]; // B_x
81 field[1] = fieldValue[1]; // B_y
82 field[2] = fieldValue[2]; // B_z
83 field[3] = 0; // E_x
84 field[4] = 0; // E_y
85 field[5] = 0; // E_z
86}
87
88void BDSFieldMag::SetTransform(const G4Transform3D& transformIn)
89{
90 transform = transformIn;
91 transformIsNotIdentity = transformIn != G4Transform3D::Identity;
92 inverseTransform = transformIn.inverse();
93}
BDSModulator * modulator
Optional modulator;.
Definition: BDSFieldMag.hh:89
virtual void SetTransform(const G4Transform3D &transformIn)
Definition: BDSFieldMag.cc:88
virtual void GetFieldValue(const G4double point[4], G4double *field) const
Definition: BDSFieldMag.cc:73
virtual G4ThreeVector GetFieldTransformed(const G4ThreeVector &position, const G4double t) const
Get the field value after applying transform for local offset.
Definition: BDSFieldMag.cc:44
virtual G4ThreeVector GetField(const G4ThreeVector &position, const G4double t=0) const =0
G4bool finiteStrength
Flag to cache whether finite nor not.
Definition: BDSFieldMag.hh:83
G4Transform3D inverseTransform
The complimentary transform used to initially rotate the point of query.
Definition: BDSFieldMag.hh:93
G4Transform3D transform
Transform to apply for the field relative to the local coordinates of the geometry.
Definition: BDSFieldMag.hh:86
G4bool transformIsNotIdentity
Cache of whether to use transform at all.
Definition: BDSFieldMag.hh:88
virtual G4double Factor(const G4ThreeVector &xyz, G4double T) const =0