BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
BDSFieldMagInterpolated.hh
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2022.
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#ifndef BDSFIELDMAGINTERPOLATED_H
20#define BDSFIELDMAGINTERPOLATED_H
21#include "BDSExtent.hh"
22#include "BDSFieldMag.hh"
23
24#include "G4Transform3D.hh"
25#include "G4Types.hh"
26
27class BDSInterpolator;
28
36{
37public:
38 BDSFieldMagInterpolated() = delete;
39 BDSFieldMagInterpolated(const BDSInterpolator* interpolator,
40 const G4Transform3D& offset,
41 G4double scalingIn = 1.0);
42
43 virtual ~BDSFieldMagInterpolated(){;}
44
45 inline G4double Scaling() const {return scaling;}
46 inline void SetScaling(G4double scalingIn) {scaling = scalingIn;}
47
49 inline BDSExtent ExtentNoOffset() const {return extentNoOffset;}
50
52 inline BDSExtent Extent() const {return extentNoOffset.Translate(transform.getTranslation());}
53
54 inline G4double SmallestSpatialStep() const {return smallestSpatialStep;}
55
56private:
57 G4double scaling;
59 G4double smallestSpatialStep;
60};
61
62#endif
Holder for +- extents in 3 dimensions.
Definition: BDSExtent.hh:39
BDSExtent Translate(const G4ThreeVector &offset) const
Provide a new copy of this extent with an offset applied.
Definition: BDSExtent.hh:125
Class to provide scaling and a base class pointer for interpolator fields.
BDSExtent Extent() const
For now, we will ignore any rotation of the transform. TODO.
BDSExtent extentNoOffset
Extent without offset.
BDSExtent ExtentNoOffset() const
Extent of field without any offset (ie in its own coordinate frame).
G4double scaling
Field value scaling.
Interface for static magnetic fields that may or may not be local.
Definition: BDSFieldMag.hh:37
G4Transform3D transform
Transform to apply for the field relative to the local coordinates of the geometry.
Definition: BDSFieldMag.hh:77
Interface for all interpolators containing basic extent of validity.