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