/scratch0/jsnuveri/BDSIM/BDSIMgit/bdsim/include/BDSMagnetOuterFactoryPolesBase.hh

#ifndef BDSMAGNETOUTERFACTORYPOLESBASE_H
#define BDSMAGNETOUTERFACTORYPOLESBASE_H

#include "BDSGeometryComponent.hh"
#include "BDSMagnetOuterFactoryBase.hh"
#include "BDSBeamPipe.hh"

#include "globals.hh"           // geant4 globals / types
#include "G4Colour.hh"
#include "G4Material.hh"
#include "G4VSolid.hh"

class BDSMagnetOuterFactoryPolesBase: public BDSMagnetOuterFactoryBase
{
public:
  //static BDSMagnetOuterFactoryPoles* Instance(); /// singleton pattern
  BDSMagnetOuterFactoryPolesBase();
  
  virtual BDSGeometryComponent* CreateSectorBend(G4String      name,                // name
                                                 G4double      length,              // length [mm]
                                                 BDSBeamPipe*  beamPipe,            // beampipe
                                                 G4double      boxSize,             // full width
                                                 G4double      angle,               // full bend angle [rad]
                                                 G4Material*   outerMaterial = NULL // material for outer volume
                                                 );

  virtual BDSGeometryComponent* CreateRectangularBend(G4String      name,                // name
                                                      G4double      length,              // length [mm]
                                                      BDSBeamPipe*  beamPipe,            // beampipe
                                                      G4double      boxSize,             // full width
                                                      G4double      angle,               // full bend angle [rad]
                                                      G4Material*   outerMaterial = NULL // material for outer volume
                                                      );
  
  virtual BDSGeometryComponent* CreateQuadrupole(G4String      name,                 // name
                                                 G4double      length,               // length [mm]
                                                 BDSBeamPipe*  beamPipe,             // beampipe
                                                 G4double      boxSize,              // full width
                                                 G4Material*   outerMaterial = NULL  // material for outer volume
                                                 );


  virtual BDSGeometryComponent* CreateSextupole(G4String      name,                 // name
                                                G4double      length,               // length [mm]
                                                BDSBeamPipe*  beamPipe,             // beampipe
                                                G4double      boxSize,              // full width
                                                G4Material*   outerMaterial = NULL  // material for outer volume
                                                );

  virtual BDSGeometryComponent* CreateOctupole(G4String      name,                  // name
                                               G4double      length,                // length [mm]
                                               BDSBeamPipe*  beamPipe,              // beampipe
                                               G4double      boxSize,               // full width
                                               G4Material*   outerMaterial = NULL   // material for outer volume
                                               );

  virtual BDSGeometryComponent* CreateDecapole(G4String      name,                  // name
                                               G4double      length,                // length [mm]
                                               BDSBeamPipe*  beamPipe,              // beampipe
                                               G4double      boxSize,               // full width
                                               G4Material*   outerMaterial = NULL   // material for outer volume
                                               );

  virtual BDSGeometryComponent* CreateSolenoid(G4String      name,                  // name
                                               G4double      length,                // length [mm]
                                               BDSBeamPipe*  beamPipe,              // beampipe
                                               G4double      boxSize,               // full width
                                               G4Material*   outerMaterial = NULL   // material for outer volume
                                               );

  virtual BDSGeometryComponent* CreateMultipole(G4String      name,                 // name
                                                G4double      length,               // length [mm]
                                                BDSBeamPipe*  beamPipe,             // beampipe
                                                G4double      boxSize,              // full width
                                                G4Material*   outerMaterial = NULL  // material for outer volume
                                                );

  virtual BDSGeometryComponent* CreateRfCavity(G4String      name,                  // name
                                               G4double      length,                // length [mm]
                                               BDSBeamPipe*  beamPipe,              // beampipe
                                               G4double      boxSize,               // full width
                                               G4Material*   outerMaterial = NULL   // material for outer volume
                                               );

  virtual BDSGeometryComponent* CreateMuSpoiler(G4String      name,                 // name
                                                G4double      length,               // length [mm]
                                                BDSBeamPipe*  beamPipe,             // beampipe
                                                G4double      boxSize,              // full width
                                                G4Material*   outerMaterial = NULL  // material for outer volume
                                                );

  virtual BDSGeometryComponent* CreateKicker(G4String      name,                  // name
                                             G4double      length,                // length [mm]
                                             BDSBeamPipe*  beamPipe,              // beampipe
                                             G4double      boxSize,               // full width
                                             G4bool        vertical = true,       // is it a vertical kicker?
                                             G4Material*   outerMaterial = NULL   // material for outer volume
                                             );
  
protected:
  // geometry parameters
  G4double poleFraction;

  G4double poleAngularFraction;

  G4double poleTipFraction;
  
  //length will be calculated in each derived class
  //will be less than outer radius but long enough so poles can be
  //boolean added to return yoke - this is different for each type
  G4double poleStartRadius;
  G4double poleFinishRadius;
  G4double yokeStartRadius;
  G4double yokeFinishRadius;

  // functions

  virtual void CleanUp();

  virtual void CalculatePoleAndYoke(G4double     outerDiameter,
                                    BDSBeamPipe* beamPipe,
                                    G4double     order);
  
  //NOTE the poles are not joined (boolean union) to the outer yoke - there is a
  //gap of length safety. This won't affect physics results and speeds up tracking
  //as the solid is not a boolean of order Npoles + 1
  
  virtual void CreatePoleSolid(G4String      name,                 // name
                               G4double      length,               // length [mm]
                               G4int         order);               // Nx2 poles
  
  virtual void CreateYokeAndContainerSolid(G4String      name,
                                           G4double      length,
                                           G4int         order);

  virtual void CreateLogicalVolumes(G4String    name,
                                    G4double    length,
                                    G4int       order,
                                    G4Material* outerMaterial);

  virtual void PlaceComponents(G4String name,
                               G4int    order);

  virtual BDSGeometryComponent* CommonConstructor(G4String     name,
                                                  G4double     length,
                                                  BDSBeamPipe* beamPipe,
                                                  G4int        order,
                                                  G4double     outerDiameter,
                                                  G4Material*  outerMaterial);
  
  void TestInputParameters(BDSBeamPipe* beamPipe,
                           G4double&    boxSizeIn,
                           G4Material*& outerMaterialIn);

  virtual BDSGeometryComponent* KickerConstructor(G4String     name,
                                                  G4double     length,
                                                  G4double     angle,
                                                  BDSBeamPipe* beamPipe,
                                                  G4double     outerDiameter,
                                                  G4Material*  outerMaterial,
                                                  G4bool       isVertical);
  
};

#endif

---