BDSMagnetOuterFactoryPolesBase.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 BDSMAGNETOUTERFACTORYPOLESBASE_H
#define BDSMAGNETOUTERFACTORYPOLESBASE_H
 
#include "BDSMagnetOuter.hh"
#include "BDSMagnetOuterFactoryBase.hh"
 
#include "globals.hh"           // geant4 globals / types
#include "G4TwoVector.hh"
 
#include <vector>
 
class BDSBeamPipe;
class BDSMagnetOuterInfo;
class G4Material;
class G4VSolid;
 
class BDSMagnetOuterFactoryPolesBase: public BDSMagnetOuterFactoryBase
{
public:
  BDSMagnetOuterFactoryPolesBase();
  explicit BDSMagnetOuterFactoryPolesBase(G4double poleStopFactorIn);
  virtual ~BDSMagnetOuterFactoryPolesBase();
  
  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
 
  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 [mm]
                                           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 [mm]
                                          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 [mm]
                                         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:
  // geometry parameters
  const G4double poleFraction;
 
  const G4double poleAngularFraction;
 
  const G4double poleTipFraction;
 
  const G4double poleAnnulusFraction;
 
  const G4double bendHeightFraction;
 
  const G4double poleStopFactor;
  
  G4double yokeStartRadius;        
  G4double yokeFinishRadius;       
  G4double magnetContainerRadius;  
  G4bool   buildPole;              
  G4double poleStartRadius;        
  G4double poleFinishRadius;       
  G4double poleSquareWidth;        
  G4double poleSquareStartRadius;  
  G4double segmentAngle;           
  G4double poleAngle;              
  G4ThreeVector poleTranslation;   
  G4double coilHeight;             
  G4double coilCentreRadius;       
  G4double endPieceLength;         
  G4double endPieceInnerR;         
  G4double endPieceOuterR;         
 
  G4VSolid* poleIntersectionSolid; 
  G4VSolid* coilLeftSolid;         
  G4VSolid* coilRightSolid;        
  G4VSolid* endPieceContainerSolid;
  G4LogicalVolume* coilLeftLV;     
  G4LogicalVolume* coilRightLV;    
  G4LogicalVolume* endPieceCoilLV; 
  G4LogicalVolume* endPieceContainerLV; 
  BDSSimpleComponent* endPiece;    
  
  std::vector<G4TwoVector> leftPoints;    
  std::vector<G4TwoVector> rightPoints;   
  std::vector<G4TwoVector> endPiecePoints;
 
  virtual void CleanUp();
 
  void CleanUpPolesBase();
 
  virtual BDSMagnetOuter* CommonConstructor(const G4String& name,
                                            G4double        length,
                                            BDSBeamPipe*    beamPipe,
                                            G4int           order,
                                            G4double        magnetContainerLength,
                                            const BDSMagnetOuterInfo* recipe);
  
  virtual void CalculatePoleAndYoke(G4double     horizontalWidth,
                                    BDSBeamPipe* beamPipe,
                                    G4int        order);
  
  virtual void CreatePoleSolid(const G4String& name,                 // name
                               G4double        length,               // length [mm]
                               G4int           order);               // Nx2 poles
 
  virtual void CreateCoilSolids(const G4String& name,
                                G4double        length);
  
  virtual void CreateCoilPoints();
  
  virtual void CreateYokeAndContainerSolid(const G4String& name,
                                           G4double        length,
                                           G4int           order,
                                           G4double        magnetContainerLength,
                                           G4double        magnetContainerRadiusIn); // so as not to clash with member name
 
  virtual void IntersectPoleWithYoke(const G4String& name,
                                     G4double        length,
                                     G4int           order);
 
  virtual void CreateLogicalVolumes(const G4String& name,
                                    G4Colour*       colour,
                                    G4Material*     outerMaterial);
 
  virtual void CreateLogicalVolumesCoil(const G4String& name);
 
  virtual void CreateEndPiece(const G4String& name);
  
  virtual void PlaceComponents(const G4String& name,
                               G4int           order);
 
  virtual void PlaceComponentsCoils(const G4String& name,
                                    G4int           order);
 
  void TestCoilFractions(G4double& coilWidthFraction,
                         G4double& coilHeightFraction);
  
  void DipoleCommonPreConstruction(const G4String& name,
                                   G4double        angleIn,
                                   G4double        angleOut,
                                   G4double        length,
                                   G4double&       horizontalWidth,
                                   G4Material*&    material,
                                   G4double&       vhRatio);
 
  void DipoleCalculations(G4bool    hStyle,
                          G4bool    buildVertically,
                          const BDSBeamPipe* beamPipe,
                          G4double  length,
                          G4double  horizontalWidth,
                          G4double  angleIn,
                          G4double  angleOut,
                          G4double  yokeThicknessFraction,
                          G4double  vhRatio,
                          G4double  coilWidthFraction,
                          G4double  coilHeightFraction,
                          G4double& cShapeOuterEdge,
                          G4double& poleHalfGap,
                          G4double& poleWidth,
                          G4double& poleHeight,
                          G4double& yokeWidth,
                          G4double& yokeHalfHeight,
                          G4double& yokeThickness,
                          G4double& yokeOverHang,
                          G4double& coilWidth,
                          G4double& coilHeightIn, // to avoid shadowing member variable
                          G4double& coilToYokeGap,
                          G4double& coilToPoleGap,
                          G4double& sLength,
                          G4double& containerSLength,
                          G4double& intersectionRadius);
 
  std::vector<G4ThreeVector> CalculateCoilDisplacements(G4double  poleHalfWidthIn,
                                                        G4double  poleHalfGapIn,
                                                        G4double  coilWidthIn,
                                                        G4double  coilHeightIn,
                                                        G4double  cDY,
                                                        G4double& coilDY);
    
  BDSMagnetOuter* CreateDipoleC(const G4String&           name,
                                G4double                  length,
                                const BDSBeamPipe*        beamPipe,
                                G4double                  containerLength,
                                const BDSMagnetOuterInfo* recipe,
                                G4bool                    buildVertically);
 
  BDSMagnetOuter* CreateDipoleH(const G4String&           name,
                                G4double                  length,
                                const BDSBeamPipe*        beamPipe,
                                G4double                  containerLength,
                                const BDSMagnetOuterInfo* recipe,
                                G4bool                    buildVertically);
 
  BDSMagnetOuter* DipoleCommonConstruction(const G4String& name,
                                           G4double    horizontalWidth,
                                           G4bool      buildEndPiece,
                                           G4double    coilWidth,
                                           G4double    length,
                                           G4double    containerLength,
                                           G4double    sLength,
                                           G4double    angleIn,
                                           G4double    angleOut,
                                           G4Colour*   colour,
                                           G4Material* material,
                                           std::vector<G4ThreeVector>& coilDisps,
                                           G4bool      buildVertically,
                                           BDSExtent&  ext,
                                           G4double    poleHalfWidth,
                                           G4double    poleHalfGap,
                                           G4double    cDY,
                                           G4double    coilDY,
                                           G4double    intersectionRadius);
 
  BDSMagnetOuterFactoryBase* cylindrical; 
};
 
#endif