BDSFieldMagDipoleEnge.cc

/* 
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/>.
*/
#include "BDSFieldMagDipoleEnge.hh"
 
#include "globals.hh"
#include "G4ThreeVector.hh"
#include "G4Types.hh"
 
#include <cmath>
 
//BDSFieldMagDipoleEnge::BDSFieldMagDipoleEnge(BDSMagnetStrength const* strength,
//                                             G4double apertureIn, G4double engeIn, G4double toleranceIn):
//      BDSFieldMagDipoleEnge((*strength)["field"], apertureIn, (*strength)["length"], engeIn, toleranceIn)
//{;}
 
 
BDSFieldMagDipoleEnge::BDSFieldMagDipoleEnge(G4double strength,                                             
                                             G4double apertureRadius,
                                             G4double coilLength,
                                             G4double engeCoefficient):
  D(2*apertureRadius),
  halfLength(0.5*coilLength),
  B0(strength),
  engeCoeff(engeCoefficient)
  {;}
 
G4ThreeVector BDSFieldMagDipoleEnge::GetField(const G4ThreeVector& position,
                                              const G4double       /*t*/) const
{
  G4double z = position.z();
  G4double y = position.y();
  G4double rho = position.perp();
 
  G4double zleft = z + halfLength + D;
  G4double zright = z - halfLength - D;
 
  G4double By = 0;
  G4double Bz = 0;
    
  if (rho > D*0.5)  // Further improvement: apply longitudinal bounding box / tolerance cut
    {return G4ThreeVector();}
  else
    {
      G4double By_left = (1 + std::exp(-zleft*engeCoeff/D) * std::cos(y*engeCoeff/D)) / (1 + 2*std::exp(-zleft*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(-2*zleft*engeCoeff/D));
      G4double By_right = (1 + std::exp(zright*engeCoeff/D) * std::cos(y*engeCoeff/D)) / (1 + 2*std::exp(zright*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(2*zright*engeCoeff/D));
 
      G4double Bz_left = ( std::exp(-zleft*engeCoeff/D) * std::sin(y*engeCoeff/D)) / (1 + 2*std::exp(-zleft*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(-2*zleft*engeCoeff/D));
      G4double Bz_right = ( - std::exp(zright*engeCoeff/D) * std::sin(y*engeCoeff/D)) / (1 + 2*std::exp(zright*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(2*zright*engeCoeff/D));
      
      By = By_left + By_right - 1.0;
      Bz = Bz_left + Bz_right;
 
      G4ThreeVector centerField = QueryField(y, 0.0); // Get By field at the center of the dipole magnet to calculate the normalisation factor
      G4double normalisation = B0 / centerField.y();  
 
      By *= normalisation;
      Bz *= normalisation;
    }
 
  G4ThreeVector result = G4ThreeVector(0,By,Bz);
  return result;
}
 
 
G4ThreeVector BDSFieldMagDipoleEnge::QueryField(G4double y, G4double z) const
{ 
  G4double zleft = z + halfLength + D;
  G4double zright = z - halfLength - D;
 
  G4double By_left = (1 + std::exp(-zleft*engeCoeff/D) * std::cos(y*engeCoeff/D)) / (1 + 2*std::exp(-zleft*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(-2*zleft*engeCoeff/D));
  G4double By_right = (1 + std::exp(zright*engeCoeff/D) * std::cos(y*engeCoeff/D)) / (1 + 2*std::exp(zright*engeCoeff/D) * std::cos(y*engeCoeff/D) + std::exp(2*zright*engeCoeff/D));
 
  G4double By = By_left + By_right - 1.0;
 
  return G4ThreeVector(0, By, 0);
}