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