BDSFieldObjects.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 BDSFIELDOBJECTS_H
#define BDSFIELDOBJECTS_H
 
#include "globals.hh" // geant4 types / globals
#include "G4Version.hh"
 
#include <vector>
 
class BDSFieldInfo;
 
class G4ChordFinder;
class G4ElectroMagneticField;
class G4EquationOfMotion;
class G4Field;
class G4FieldManager;
class G4LogicalVolume;
class G4MagneticField;
class G4MagInt_Driver;
class G4MagIntegratorStepper;
class G4UserLimits;
 
class BDSFieldObjects
{
public:
  BDSFieldObjects() = delete;
  
  BDSFieldObjects(const BDSFieldObjects& other) = delete;
  
  BDSFieldObjects(const BDSFieldInfo*     infoIn,
                  G4Field*                fieldIn,
                  G4EquationOfMotion*     equationOfMotionIn,
                  G4MagIntegratorStepper* magIntegratorStepperIn,
                  G4ChordFinder*          chordFinderIn,
                  G4FieldManager*         fieldManagerIn);
 
  BDSFieldObjects(const BDSFieldInfo*     infoIn,
                  G4ElectroMagneticField* fieldIn,
                  G4EquationOfMotion*     equationOfMotionIn,
                  G4MagIntegratorStepper* magIntegratorStepperIn);
 
#if G4VERSION_NUMBER > 1049
  BDSFieldObjects(const BDSFieldInfo*     infoIn,
                  G4MagneticField*        fieldIn,
                  G4EquationOfMotion*     equationOfMotionIn,
                  G4MagIntegratorStepper* magIntegratorStepperIn);
#endif
 
  ~BDSFieldObjects();
 
  inline const BDSFieldInfo*     GetInfo()             const {return info;}
  inline G4Field*                GetField()            const {return field;}
  inline G4EquationOfMotion*     GetEquationOfMotion() const {return equationOfMotion;}
  inline G4MagIntegratorStepper* GetIntegrator()       const {return magIntegratorStepper;}
  inline G4ChordFinder*          GetChordFinder()      const {return chordFinder;}
  inline G4FieldManager*         GetFieldManager()     const {return fieldManager;}
  inline G4MagInt_Driver*        GetMagIntDriver()     const {return magIntDriver;}
 
  void AttachToVolume(G4LogicalVolume* volume,
                      G4bool penetrateToDaughterVolumes = true) const;
 
  void AttachToVolume(const std::vector<G4LogicalVolume*>& volumes,
                      G4bool penetrateToDaughterVolumes = true) const;
 
  void AttachUserLimitsToVolume(G4LogicalVolume* volume,
                                G4UserLimits*    userLimits,
                                G4bool           penetrateToDaughterVolumes = true) const;
  
private:
  const BDSFieldInfo* info;
  
  G4Field* field;
  
  G4EquationOfMotion* equationOfMotion;
 
  G4MagIntegratorStepper* magIntegratorStepper;
 
  G4ChordFinder* chordFinder;
 
  G4FieldManager* fieldManager;
 
  G4MagInt_Driver* magIntDriver;
 
  void SetFieldManagerOptions();
 
  void SetFieldManagerOptionsThin();
};
 
#endif