BDSMagnetOuterFactoryBase.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 BDSMAGNETOUTERFACTORYBASE_H
#define BDSMAGNETOUTERFACTORYBASE_H
 
#include "BDSExtent.hh"
#include "BDSFactoryBase.hh"
#include "BDSMagnetOuter.hh"
 
#include "globals.hh"         // geant4 globals / types
 
#include <set>
#include <vector>
 
class BDSBeamPipe;
class BDSGeometryComponent;
class BDSMagnetOuterInfo;
 
class G4Colour;
class G4Material;
class G4UserLimits;
class G4VisAttributes;
class G4VPhysicalVolume;
class G4VSolid;
 
class BDSMagnetOuterFactoryBase: public BDSFactoryBase
{
public:
  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
                                           ) = 0;
  
  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
                                                ) = 0;  
  
  virtual BDSMagnetOuter* CreateQuadrupole(G4String     name,               // name
                                           G4double     length,             // length
                                           BDSBeamPipe* beamPipe,           // beampipe
                                           G4double     containerLength,    // full length to make AccComp container
                                           const BDSMagnetOuterInfo* recipe // recipe for geometry
                                           ) = 0;
  
 
  virtual BDSMagnetOuter* CreateSextupole(G4String     name,               // name
                                          G4double     length,             // length
                                          BDSBeamPipe* beamPipe,           // beampipe
                                          G4double     containerLength,    // full length to make AccComp container
                                          const BDSMagnetOuterInfo* recipe // recipe for geometry
                                          ) = 0;
  
  virtual BDSMagnetOuter* CreateOctupole(G4String     name,               // name
                                         G4double     length,             // length
                                         BDSBeamPipe* beamPipe,           // beampipe
                                         G4double     containerLength,    // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe // recipe for geometry
                                         ) = 0;
 
  virtual BDSMagnetOuter* CreateDecapole(G4String     name,               // name
                                         G4double     length,             // length
                                         BDSBeamPipe* beamPipe,           // beampipe
                                         G4double     containerLength,    // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe // recipe for geometry
                                         ) = 0;
  
  virtual BDSMagnetOuter* CreateSolenoid(G4String     name,               // name
                                         G4double     length,             // length
                                         BDSBeamPipe* beamPipe,           // beampipe
                                         G4double     containerLength,    // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe // recipe for geometry
                                         ) = 0;
  
  virtual BDSMagnetOuter* CreateMultipole(G4String     name,               // name
                                          G4double     length,             // length
                                          BDSBeamPipe* beamPipe,           // beampipe
                                          G4double     containerLength,    // full length to make AccComp container
                                          const BDSMagnetOuterInfo* recipe // recipe for geometry
                                          ) = 0;
  
  virtual BDSMagnetOuter* CreateRfCavity(G4String     name,               // name
                                         G4double     length,             // length
                                         BDSBeamPipe* beamPipe,           // beampipe
                                         G4double     containerLength,    // full length to make AccComp container
                                         const BDSMagnetOuterInfo* recipe // recipe for geometry
                                         ) = 0;
 
  virtual BDSMagnetOuter* CreateMuonSpoiler(G4String     name,               // name
                                            G4double     length,             // length
                                            BDSBeamPipe* beamPipe,           // beampipe
                                            G4double     containerLength,    // full length to make AccComp container
                                            const BDSMagnetOuterInfo* recipe // recipe for geometry
                                            ) = 0;
  
  virtual BDSMagnetOuter* CreateKicker(G4String                  name,            // name
                                       G4double                  length,          // length [mm]
                                       const BDSBeamPipe*        beamPipe,        // beampipe
                                       G4double                  containerLength, // full length to make AccComp container
                                       const BDSMagnetOuterInfo* recipe,          // geometry recipe
                                       G4bool                    vertical         // is it a vertical kicker?
                                       ) = 0;
 
  virtual void CleanUp();
 
  void CleanUpBase();
  
  virtual ~BDSMagnetOuterFactoryBase() {;}
 
protected:
  BDSMagnetOuterFactoryBase();
 
  virtual void CreateLogicalVolumes(const G4String& name,
                                    G4Colour*       colour,
                                    G4Material*     outerMaterial);
 
  virtual void SetUserLimits();
 
  void BuildMagnetContainerSolidAngled(const G4String& name,
                                       G4double        magnetContainerLength,
                                       G4double        magnetContainerRadius,
                                       G4bool          flatFaces = false);
 
  void BuildMagnetContainerSolidStraight(const G4String& name,
                                         G4double        magnetContainerLength,
                                         G4double        magnetContainerRadius);
 
  void CreateMagnetContainerComponent();
 
  void SetFaceNormals(BDSMagnetOuter* outer);
 
  G4bool sensitiveOuter;
 
  // Geometric pointers that will be used to pass around components
  // within the factory (as different parts factorised so they can
  // be overridden by the derived classes.
  G4VSolid*          poleSolid; 
  G4VSolid*          yokeSolid; 
  G4VSolid*          containerSolid;
  G4VSolid*          magnetContainerSolid;
  G4LogicalVolume*   poleLV;
  G4LogicalVolume*   yokeLV;
  G4LogicalVolume*   containerLV;
  G4LogicalVolume*   magnetContainerLV;
  G4VPhysicalVolume* yokePV;
  G4VisAttributes*   outerVisAttributes;
 
  BDSExtent             magContExtent;
  BDSGeometryComponent* magnetContainer;
 
  G4ThreeVector inputFaceNormal;
  G4ThreeVector outputFaceNormal;
};
 
#endif