BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
BDSFieldE.hh
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#ifndef BDSFIELDE_H
19#define BDSFIELDE_H
20
21#include "globals.hh" // geant4 types / globals
22#include "G4ElectricField.hh"
23#include "G4ThreeVector.hh"
24#include "G4Transform3D.hh"
25
26class BDSModulator;
27
37class BDSFieldE: public G4ElectricField
38{
39public:
44 BDSFieldE();
45 explicit BDSFieldE(G4Transform3D transformIn);
46 virtual ~BDSFieldE(){;}
47
50 virtual G4ThreeVector GetField(const G4ThreeVector& position,
51 const G4double t = 0) const = 0;
52
55 virtual G4bool TimeVarying() const {return false;}
56
61 virtual void GetFieldValue(const G4double point[4],
62 G4double* field) const;
63
65 virtual G4ThreeVector GetFieldTransformed(const G4ThreeVector& position,
66 const G4double t) const;
67
73 virtual void SetTransform(const G4Transform3D& transformIn);
74
76 void SetModulator(BDSModulator* modulatorIn) {modulator = modulatorIn;}
77
79 inline G4bool FiniteStrength() const {return finiteStrength;}
80
81protected:
83
85 G4Transform3D transform;
86
89
90private:
92 G4Transform3D inverseTransform;
93};
94
95#endif
Interface for BDSIM electric fields that may or may not be local.
Definition BDSFieldE.hh:38
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 G4bool TimeVarying() const
Definition BDSFieldE.hh:55
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
G4bool FiniteStrength() const
Accessor.
Definition BDSFieldE.hh:79
G4Transform3D transform
Transform to apply for the field relative to the local coordinates of the geometry.
Definition BDSFieldE.hh:85
void SetModulator(BDSModulator *modulatorIn)
Set the optional modulator.
Definition BDSFieldE.hh:76
G4bool transformIsNotIdentity
Cache of whether to use transform at all.
Definition BDSFieldE.hh:87
virtual void SetTransform(const G4Transform3D &transformIn)
Definition BDSFieldE.cc:83
Base class for a modulator.