BDSFieldMag.cc

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2024.
 
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 "BDSFieldMag.hh"
#include "BDSModulator.hh"
 
#include "globals.hh"
#include "G4ThreeVector.hh"
#include "G4Transform3D.hh"
 
#include <cmath>
 
BDSFieldMag::BDSFieldMag():
  finiteStrength(true),
  transform(G4Transform3D::Identity),
  transformIsNotIdentity(false),
  modulator(nullptr),
  inverseTransform(G4Transform3D::Identity)
{;}
 
BDSFieldMag::BDSFieldMag(G4Transform3D transformIn):
  finiteStrength(true),
  transform(transformIn),
  transformIsNotIdentity(transformIn != G4Transform3D::Identity),
  modulator(nullptr),
  inverseTransform(transformIn.inverse())
{;}
 
G4ThreeVector BDSFieldMag::GetFieldTransformed(const G4ThreeVector& position,
                                               const G4double       t) const
{
  if (!finiteStrength)
    {return G4ThreeVector();} // quicker than query
  else if (transformIsNotIdentity)
    {
      G4ThreeVector transformedPosition = inverseTransform * (HepGeom::Point3D<G4double>)position;
      G4ThreeVector field = GetField(transformedPosition, t);
      if (modulator)
        {
          G4double factor = modulator->Factor(transformedPosition, t);
          field *= factor;
        }
      G4ThreeVector transformedField = transform * (HepGeom::Vector3D<G4double>)field;
      return transformedField;
    }
  else
    {
      G4ThreeVector field = GetField(position, t);
      if (modulator)
        {
          G4double factor = modulator->Factor(position, t);
          field *= factor;
        }
      return field;
    }
}
 
void BDSFieldMag::GetFieldValue(const G4double point[4],
                                G4double* field) const
{
  G4double t = point[3];
  if (std::isnan(t))
    {t = 0;}
  G4ThreeVector fieldValue = GetFieldTransformed(G4ThreeVector(point[0], point[1], point[2]), t);
  field[0] = fieldValue[0]; // B_x
  field[1] = fieldValue[1]; // B_y
  field[2] = fieldValue[2]; // B_z
  field[3] = 0;             // E_x
  field[4] = 0;             // E_y
  field[5] = 0;             // E_z
}
 
void BDSFieldMag::SetTransform(const G4Transform3D& transformIn)
{
  transform = transformIn;
  transformIsNotIdentity = transformIn != G4Transform3D::Identity;
  inverseTransform = transformIn.inverse();
}