BDSFieldMagGradient.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSFIELDMAGGRADIENT_H
#define BDSFIELDMAGGRADIENT_H
 
#include "globals.hh"
 
#include <vector>
 
class BDSFieldMag;
class BDSMagnetStrength;
class BDSFieldMagSkew;
 
class BDSFieldMagGradient
{
public:
  BDSFieldMagGradient();
  ~BDSFieldMagGradient();
 
  BDSMagnetStrength* CalculateMultipoles(BDSFieldMag* BField, G4int order, G4double Brho=4);
 
  G4double GetBy(BDSFieldMag* BField, G4double x, G4double y=0) const;
 
  std::vector<G4double> PrepareValues(BDSFieldMag* field,
                                      G4int        order,
                                      G4double     centreX,
                                      G4double     h,
                                      G4int&       centreIndex) const;
 
  std::vector<std::vector<G4double> > PrepareSkewValues(BDSFieldMag* field,
                                                        G4int        order,
                                                        G4double     centreX,
                                                        G4double     h,
                                                        G4int&       centreIndex) const;
  
  G4double Derivative(const std::vector<G4double>& data,
                      const G4int                  order,
                      const G4int                  startIndex,
                      const G4double               h) const;
 
};
 
#endif