BDSFieldLoader.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 BDSFIELDLOADER_H
#define BDSFIELDLOADER_H
 
#include "BDSArrayReflectionType.hh"
#include "BDSInterpolatorType.hh"
#include "G4String.hh"
#include "G4Transform3D.hh"
 
#include <array>
#include <set>
 
class BDSArray1DCoords;
class BDSArray2DCoords;
class BDSArray3DCoords;
class BDSArray4DCoords;
class BDSArrayInfo;
class BDSArrayOperatorIndex;
class BDSArrayOperatorValue;
class BDSFieldInfo;
class BDSFieldMag;
class BDSFieldMagInterpolated;
class BDSFieldEInterpolated;
class BDSFieldEMInterpolated;
class BDSInterpolator1D;
class BDSInterpolator2D;
class BDSInterpolator3D;
class BDSInterpolator4D;
class BDSMagnetStrength;
 
class BDSFieldLoader
{
public:
  static BDSFieldLoader* Instance();
 
  ~BDSFieldLoader();
 
  void DeleteArrays();
 
  BDSFieldMagInterpolated* LoadMagField(const BDSFieldInfo& info,
                                        const BDSMagnetStrength* scalingStrength = nullptr,
                                        const G4String&          scalingKey      = "none");
 
  BDSFieldEInterpolated*   LoadEField(const BDSFieldInfo& info);
 
  BDSFieldEMInterpolated*  LoadEMField(const BDSFieldInfo& info);
 
private:
  BDSFieldLoader();
 
  static BDSFieldLoader* instance;
  
  static void BFilePathOK(const BDSFieldInfo& info);
  static void EFilePathOK(const BDSFieldInfo& info);
 
  BDSArray1DCoords* Get1DCached(const G4String& filePath);
  BDSArray2DCoords* Get2DCached(const G4String& filePath);
  BDSArray3DCoords* Get3DCached(const G4String& filePath);
  BDSArray4DCoords* Get4DCached(const G4String& filePath);
 
  BDSArray2DCoords* LoadPoissonMag2D(const G4String& filePath);
  BDSArray1DCoords* LoadBDSIM1D(const G4String& filePath);
  BDSArray2DCoords* LoadBDSIM2D(const G4String& filePath);
  BDSArray3DCoords* LoadBDSIM3D(const G4String& filePath);
  BDSArray4DCoords* LoadBDSIM4D(const G4String& filePath);
 
  void CreateOperators(const BDSArrayReflectionTypeSet* reflectionTypes,
                       const BDSArray4DCoords* existingArray,
                       BDSArrayOperatorIndex*& indexOperator,
                       BDSArrayOperatorValue*& valueOperator) const;
  
  void ReportIfProblemWithReflection(const BDSArrayInfo& info,
                                     const std::array<G4bool, 4>& operatesOnXYZT,
                                     G4double tolerance=0.05) const;
 
  G4bool NeedToProvideTransform(const BDSArrayReflectionTypeSet* reflectionTypes) const;
  
  BDSArray1DCoords* CreateArrayReflected(BDSArray1DCoords* existingArray,
                                         const BDSArrayReflectionTypeSet* reflectionType) const;
  BDSArray2DCoords* CreateArrayReflected(BDSArray2DCoords* existingArray,
                                         const BDSArrayReflectionTypeSet* reflectionType) const;
  BDSArray3DCoords* CreateArrayReflected(BDSArray3DCoords* existingArray,
                                         const BDSArrayReflectionTypeSet* reflectionType) const;
  BDSArray4DCoords* CreateArrayReflected(BDSArray4DCoords* existingArray,
                                         const BDSArrayReflectionTypeSet* reflectionType) const;
 
  BDSInterpolator1D* CreateInterpolator1D(BDSArray1DCoords*   array,
                                          BDSInterpolatorType interpolatorType) const;
  
  BDSInterpolator2D* CreateInterpolator2D(BDSArray2DCoords*   array,
                                          BDSInterpolatorType interpolatorType) const;
 
  BDSInterpolator3D* CreateInterpolator3D(BDSArray3DCoords*   array,
                                          BDSInterpolatorType interpolatorType) const;
 
  BDSInterpolator4D* CreateInterpolator4D(BDSArray4DCoords*   array,
                                          BDSInterpolatorType interpolatorType) const;
 
  BDSFieldMagInterpolated* LoadBDSIM1DB(const G4String&      filePath,
                                        BDSInterpolatorType  interpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadBDSIM2DB(const G4String&      filePath,
                                        BDSInterpolatorType  interpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadBDSIM3DB(const G4String&      filePath,
                                        BDSInterpolatorType  interpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadBDSIM4DB(const G4String&      filePath,
                                        BDSInterpolatorType  interpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadPoissonSuperFishB(const G4String&      filePath,
                                                 BDSInterpolatorType  interpolatorType,
                                                 const G4Transform3D& transform,
                                                 G4double             bScaling,
                                                 const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadPoissonSuperFishBQuad(const G4String&      filePath,
                                                     BDSInterpolatorType  interpolatorType,
                                                     const G4Transform3D& transform,
                                                     G4double             bScaling,
                                                     const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldMagInterpolated* LoadPoissonSuperFishBDipole(const G4String&      filePath,
                                                       BDSInterpolatorType  interpolatorType,
                                                       const G4Transform3D& transform,
                                                       G4double             bScaling,
                                                       const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldEInterpolated* LoadBDSIM1DE(const G4String&      filePath,
                                      BDSInterpolatorType  interpolatorType,
                                      const G4Transform3D& transform,
                                      G4double             eScaling,
                                      const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldEInterpolated* LoadBDSIM2DE(const G4String&      filePath,
                                      BDSInterpolatorType  interpolatorType,
                                      const G4Transform3D& transform,
                                      G4double             eScaling,
                                      const BDSArrayReflectionTypeSet* reflection = nullptr);
  
  BDSFieldEInterpolated* LoadBDSIM3DE(const G4String&      filePath,
                                      BDSInterpolatorType  interpolatorType,
                                      const G4Transform3D& transform,
                                      G4double             eScaling,
                                      const BDSArrayReflectionTypeSet* reflection = nullptr);
 
  BDSFieldEInterpolated* LoadBDSIM4DE(const G4String&      filePath,
                                      BDSInterpolatorType  interpolatorType,
                                      const G4Transform3D& transform,
                                      G4double             eScaling,
                                      const BDSArrayReflectionTypeSet* reflection = nullptr);
 
  BDSFieldEMInterpolated* LoadBDSIM1DEM(const G4String&      eFilePath,
                                        const G4String&      bFilePath,
                                        BDSInterpolatorType  eInterpolatorType,
                                        BDSInterpolatorType  bInterpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             eScaling,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* eReflection = nullptr,
                                        const BDSArrayReflectionTypeSet* bReflection = nullptr);
 
  BDSFieldEMInterpolated* LoadBDSIM2DEM(const G4String&      eFilePath,
                                        const G4String&      bFilePath,
                                        BDSInterpolatorType  eInterpolatorType,
                                        BDSInterpolatorType  bInterpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             eScaling,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* eReflection = nullptr,
                                        const BDSArrayReflectionTypeSet* bReflection = nullptr);
  
  BDSFieldEMInterpolated* LoadBDSIM3DEM(const G4String&      eFilePath,
                                        const G4String&      bFilePath,
                                        BDSInterpolatorType  eInterpolatorType,
                                        BDSInterpolatorType  bInterpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             eScaling,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* eReflection = nullptr,
                                        const BDSArrayReflectionTypeSet* bReflection = nullptr);
 
  BDSFieldEMInterpolated* LoadBDSIM4DEM(const G4String&      eFilePath,
                                        const G4String&      bFilePath,
                                        BDSInterpolatorType  eInterpolatorType,
                                        BDSInterpolatorType  bInterpolatorType,
                                        const G4Transform3D& transform,
                                        G4double             eScaling,
                                        G4double             bScaling,
                                        const BDSArrayReflectionTypeSet* eReflection = nullptr,
                                        const BDSArrayReflectionTypeSet* bReflection = nullptr);
 
  std::map<G4String, BDSArray1DCoords*> arrays1d;
  std::map<G4String, BDSArray2DCoords*> arrays2d;
  std::map<G4String, BDSArray3DCoords*> arrays3d;
  std::map<G4String, BDSArray4DCoords*> arrays4d;
};
 
#endif