BDSMagnetOuterFactoryLHC.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 BDSMAGNETOUTERFACTORYLHC_H
#define BDSMAGNETOUTERFACTORYLHC_H
 
#include "BDSMagnetOuterFactoryBase.hh"
 
#include "globals.hh"           // geant4 globals / types
 
class BDSBeamPipe;
class G4Material;
 
class BDSMagnetOuterFactoryLHC: public BDSMagnetOuterFactoryBase
{
private:
  enum class YokeColour {dipole, kicker};
public:
  explicit BDSMagnetOuterFactoryLHC(G4bool isLeftOffset);
  virtual ~BDSMagnetOuterFactoryLHC();
  
  virtual BDSMagnetOuter* CreateSectorBend(G4String           name,             // name
                                           G4double           length,           // full length [mm]
                                           const BDSBeamPipe* beamPipe,         // beampipe
                                           G4double           containerLength,  // full length to make AccComp container
                                           const BDSMagnetOuterInfo* recipe);   // recipe for geometry
        
  static const G4double beamSeparation;
private:
  BDSMagnetOuter* CreateLHCDipole(const G4String&    name,             // name
                                  G4double           length,           // full length [mm]
                                  const BDSBeamPipe* beamPipe,         // beampipe
                                  G4double           containerLength,  // full length to make AccComp container
                                  const BDSMagnetOuterInfo* recipe,    // recipe for geometry
                                  YokeColour         colourIn);
public:
  virtual BDSMagnetOuter* CreateRectangularBend(G4String           name,             // name
                                                G4double           length,           // full length [mm]
                                                const BDSBeamPipe* beamPipe,         // beampipe
                                                G4double           containerLength,  // full length to make AccComp container
                                                const BDSMagnetOuterInfo* recipe);   // recipe for geometry
  
  virtual BDSMagnetOuter* CreateQuadrupole(G4String     name,                  // name
                                           G4double     length,                // length
                                           BDSBeamPipe* beamPipe,              // beampipe
                                           G4double     containerLength,       // full length to make AccComp container
                                           const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateSextupole(G4String     name,                  // name
                                          G4double     length,                // length
                                          BDSBeamPipe* beamPipe,              // beampipe
                                          G4double     containerLength,       // full length to make AccComp container
                                          const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateOctupole(G4String     name,                  // name
                                         G4double     length,                // length
                                         BDSBeamPipe* beamPipe,              // beampipe
                                         G4double     containerLength,       // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateDecapole(G4String     name,                  // name
                                         G4double     length,                // length
                                         BDSBeamPipe* beamPipe,              // beampipe
                                         G4double     containerLength,       // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe);  // geometry recipe
 
  virtual BDSMagnetOuter* CreateSolenoid(G4String     name,                  // name
                                         G4double     length,                // length
                                         BDSBeamPipe* beamPipe,              // beampipe
                                         G4double     containerLength,       // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe);  // geometry recipe
 
  virtual BDSMagnetOuter* CreateMultipole(G4String     name,                  // name
                                          G4double     length,                // length
                                          BDSBeamPipe* beamPipe,              // beampipe
                                          G4double     containerLength,       // full length to make AccComp container
                                          const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateRfCavity(G4String     name,                  // name
                                         G4double     length,                // length
                                         BDSBeamPipe* beamPipe,              // beampipe
                                         G4double     containerLength,       // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateMuonSpoiler(G4String     name,                  // name
                                            G4double     length,                // length
                                            BDSBeamPipe* beamPipe,              // beampipe
                                            G4double     containerLength,       // full length to make AccComp container
                                            const BDSMagnetOuterInfo* recipe);  // geometry recipe
  
  virtual BDSMagnetOuter* CreateKicker(G4String                  name,            // name
                                       G4double                  length,          // length
                                       const BDSBeamPipe*        beamPipe,        // beampipe
                                       G4double                  containerLength, // full length to make AccComp container
                                       const BDSMagnetOuterInfo* recipe,          // geometry recipe
                                       G4bool                    vertical);       // is it a vertical kicker?
  
protected:
  G4bool isLeftOffset;
  G4bool IsLeftOffset(){return isLeftOffset;}
  
private:
  void TestInputParameters(const BDSBeamPipe* beamPipe,
                           G4double&    horizontalWidthIn);
 
  BDSMagnetOuterFactoryBase* cylindrical; 
};
 
#endif