BDSIntegratorDipoleFringe.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 BDSINTEGRATORDIPOLEFRINGEBASE_H
#define BDSINTEGRATORDIPOLEFRINGEBASE_H
 
#include "BDSAuxiliaryNavigator.hh"
#include "BDSIntegratorDipoleRodrigues2.hh"
#include "BDSIntegratorDipoleQuadrupole.hh"
#include "BDSIntegratorMultipoleThin.hh"
 
#include "globals.hh"
 
namespace BDS
{
  G4double FringeFieldCorrection(BDSMagnetStrength const* strength, G4bool entranceOrExit);
 
  G4double SecondFringeFieldCorrection(BDSMagnetStrength const* strength, G4bool entranceOrExit);
}
 
class G4Mag_EqRhs;
class BDSMagnetStrength;
 
class BDSIntegratorDipoleFringe: public BDSIntegratorDipoleRodrigues2, public BDSAuxiliaryNavigator
{
public:
  BDSIntegratorDipoleFringe(BDSMagnetStrength const* strength,
                            G4double                 brhoIn,
                            G4Mag_EqRhs*             eqOfMIn,
                            G4double                 minimumRadiusOfCurvature,
                            const G4double&          tiltIn = 0);
  
  virtual ~BDSIntegratorDipoleFringe();
 
  BDSIntegratorDipoleFringe& operator=(const BDSIntegratorDipoleFringe&) = delete;
  BDSIntegratorDipoleFringe(BDSIntegratorDipoleFringe&) = delete;
 
  virtual void Stepper(const G4double yIn[6],
                       const G4double dydx[6],
                       const G4double h,
                       G4double       yOut[6],
                       G4double       yErr[6]);
 
  void BaseStepper(const G4double  yIn[6],
                   const G4double  dydx[6],
                   const G4double& h,
                   G4double        yOut[6],
                   G4double        yErr[6],
                   const G4double& fcof,
                   const G4double& momScaling);
 
 
  void OneStep(const G4ThreeVector& posIn,
               const G4ThreeVector& momUIn, // assumed unit momentum of momIn
               G4ThreeVector&       posOut,
               G4ThreeVector&       momOut,
               const G4double&      bendingRadius) const;
 
  void MultipoleStep(const G4double  yIn[6],
                     G4double        yMultipoleOut[6],
                     const G4double& h);
 
  inline G4double GetPolefaceAngle() {return polefaceAngle;}
  inline G4double GetFringeCorr() {return fringeCorr;}
  inline G4double GetSecondFringeCorr() {return secondFringeCorr;}
  inline G4double GetPolefaceCurv() {return polefaceCurvature;}
 
protected:
  G4double polefaceAngle;
  G4double fringeCorr;
  G4double secondFringeCorr;
  G4double polefaceCurvature;
  G4double rho;
 
  G4ThreeVector unitField;       
  const G4double fieldArcLength; 
  const G4double fieldAngle;     
 
  const G4double tilt;
  const G4bool   finiteTilt;
  G4double bx;
  G4double by;
  G4bool zeroStrength;
  
  static G4double thinElementLength;
 
  BDSIntegratorMultipoleThin* multipoleIntegrator;
 
  G4bool isEntrance; 
 
  G4double backupStepperMomLimit;
 
private:
  BDSIntegratorDipoleFringe() = delete;
};
 
#endif