BDSFieldFactory.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
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 BDSFIELDFACTORY_H
#define BDSFIELDFACTORY_H
 
#include "BDSFieldType.hh"
#include "BDSInterpolatorType.hh"
#include "BDSMagnetType.hh"
 
#include "globals.hh"
 
#include <map>
#include <vector>
 
namespace GMAD
{
  class Field;
  class Modulator;
}
 
class BDSFieldE;
class BDSFieldInfo;
class BDSFieldMag;
class BDSFieldObjects;
class BDSMagnetStrength;
class BDSModulator;
class BDSModulatorInfo;
class BDSParticleDefinition;
class BDSPrimaryGeneratorAction;
 
class G4EquationOfMotion;
class G4MagIntegratorStepper;
class G4Mag_EqRhs;
 
class BDSFieldFactory
{
public:
  static BDSFieldFactory* Instance();
 
  static void SetDesignParticle(const BDSParticleDefinition* designParticleIn)
  {designParticle = designParticleIn;}
  static void SetPrimaryGeneratorAction(BDSPrimaryGeneratorAction* pgaIn) {primaryGeneratorAction = pgaIn;}
  
  ~BDSFieldFactory();
 
  BDSFieldObjects* CreateField(const BDSFieldInfo&      info,
                               const BDSMagnetStrength* scalingStrength = nullptr,
                               const G4String&          scalingKey      = "none");
 
  BDSFieldInfo* GetDefinition(const G4String& name) const;
  
  BDSModulatorInfo* GetModulatorDefinition(const G4String& modulatorName) const;
 
  static BDSInterpolatorType DefaultInterpolatorType(G4int numberOfDimensions);
  
  static G4double CalculateGlobalPhase(G4double oscillatorFrequency,
                                       G4double tOffsetIn);
  
  static G4double CalculateGlobalPhase(const BDSModulatorInfo& modulatorInfo,
                                       const BDSFieldInfo& fieldInfo);
 
private:
  BDSFieldObjects* CreateFieldMag(const BDSFieldInfo&      info,
                                  const BDSMagnetStrength* scalingStrength = nullptr,
                                  const G4String&          scalingKey      = "none");
 
  BDSFieldObjects* CreateFieldEM(const BDSFieldInfo& info);
 
  BDSFieldObjects* CreateFieldE(const BDSFieldInfo& info);
 
  BDSFieldObjects* CreateFieldIrregular(const BDSFieldInfo& info);
 
  BDSFieldMag* CreateFieldMagRaw(const BDSFieldInfo&      info,
                                 const BDSMagnetStrength* scalingStrength = nullptr,
                                 const G4String&          scalingKey      = "none");
 
  BDSFieldE* CreateFieldERaw(const BDSFieldInfo& info);
 
  G4MagIntegratorStepper* CreateIntegratorMag(const BDSFieldInfo&      info,
                                              G4Mag_EqRhs*             eqOfM,
                                              const BDSMagnetStrength* strength);
 
  G4MagIntegratorStepper* CreateIntegratorEM(const BDSFieldInfo& info,
                                             G4EquationOfMotion* eqOfM);
 
  G4MagIntegratorStepper* CreateIntegratorE(const BDSFieldInfo& info,
                                            G4EquationOfMotion* eqOfM);
 
  BDSFieldObjects* CreateTeleporter(const BDSFieldInfo& info);
 
  BDSFieldObjects* CreateRMatrix(const BDSFieldInfo& info);
 
  BDSFieldObjects* CreateCavityFringe(const BDSFieldInfo& info);
 
  BDSFieldObjects* CreateParallelTransport(const BDSFieldInfo& info);
  
  G4double GetOuterScaling(const BDSMagnetStrength* st) const;
  
  BDSModulator* CreateModulator(const BDSModulatorInfo* modulatorRecipe,
                                const BDSFieldInfo& info) const;
  
  BDSFieldFactory();
 
  static BDSFieldFactory* instance;
 
  void PrepareFieldDefinitions(const std::vector<GMAD::Field>& definitions,
                               G4double defaultBRho);
  
  void PrepareModulatorDefinitions(const std::vector<GMAD::Modulator>& definitions);
  
  G4double ConvertToDoubleWithException(const G4String& value,
                                        const G4String& parameterNameForError) const;
  
  void PrepareFieldStrengthFromParameters(BDSMagnetStrength* st,
                                          const G4String& fieldParameters,
                                          G4double& poleTipRadius) const;
 
  std::map<G4String, BDSFieldInfo*> parserDefinitions;
  std::map<G4String, BDSModulatorInfo*> parserModulatorDefinitions;
 
  static const BDSParticleDefinition* designParticle;
 
  static BDSPrimaryGeneratorAction* primaryGeneratorAction;
  
  G4bool useOldMultipoleOuterFields;
};
#endif