BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
BDSInterpolator1D.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 BDSINTERPOLATOR1D_H
19#define BDSINTERPOLATOR1D_H
20#include "BDSArray1DCoords.hh"
21#include "BDSDimensionType.hh"
22#include "BDSExtent.hh"
23#include "BDSFieldValue.hh"
24#include "BDSInterpolator.hh"
25
26#include "G4Types.hh"
27#include "G4ThreeVector.hh"
28
38{
39public:
40 BDSInterpolator1D() = delete;
41 explicit BDSInterpolator1D(BDSArray1DCoords* arrayIn);
42 virtual ~BDSInterpolator1D(){;}
43
45 G4ThreeVector GetInterpolatedValue(G4double x) const;
46
48 inline const BDSArray1DCoords* Array() const {return array;}
49
52
54 virtual BDSExtent Extent() const {return array->Extent();}
55
56 virtual G4bool TimeVarying() const {return array->TimeVarying();}
57
58protected:
62 virtual BDSFieldValue GetInterpolatedValueT(G4double x) const = 0;
63
66};
67
68#endif
1D array with spatial mapping derived from BDSArray4DCoords.
virtual BDSExtent Extent() const
virtual G4bool TimeVarying() const
BDSDimensionType FirstDimension() const
Accessor for each dimension label. e.g. array 'x' = spatial z.
Holder for +- extents in 3 dimensions.
Definition BDSExtent.hh:38
Interface for all 1D interpolators.
BDSDimensionType FirstDimension() const
Accessor for the active dimension this represents.
virtual BDSFieldValue GetInterpolatedValueT(G4double x) const =0
G4ThreeVector GetInterpolatedValue(G4double x) const
Public interface to a 1D interpolator. Returns Geant4 type as that's what will be needed.
BDSArray1DCoords * array
The field data.
virtual BDSExtent Extent() const
Extent of field.
const BDSArray1DCoords * Array() const
Accessor for the underlying array data.
Interface for all interpolators containing basic extent of validity.