BDSBeamPipeFactoryBase.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 BDSBEAMPIPEFACTORYBASE_H
#define BDSBEAMPIPEFACTORYBASE_H
 
#include "BDSBeamPipe.hh"
#include "BDSFactoryBase.hh"
 
#include "globals.hh"         // geant4 globals / types
#include "G4RotationMatrix.hh"
 
#include <set>
 
class G4LogicalVolume;
class G4Material;
class G4PVPlacement;
class G4UserLimits;
class G4VSolid;
 
class BDSBeamPipeFactoryBase: public BDSFactoryBase
{
public:
  virtual BDSBeamPipe* CreateBeamPipe(const G4String& nameIn,                  // name
                                      G4double    lengthIn,                    // length [mm]
                                      G4double    aper1 = 0,                   // aperture parameter 1
                                      G4double    aper2 = 0,                   // aperture parameter 2
                                      G4double    aper3 = 0,                   // aperture parameter 3
                                      G4double    aper4 = 0,                   // aperture parameter 4
                                      G4Material* vacuumMaterialIn = nullptr,  // vacuum material
                                      G4double    beamPipeThicknessIn = 0,     // beampipe thickness [mm]
                                      G4Material* beamPipeMaterialIn = nullptr,// beampipe material
                                      const G4String& pointsFileIn = "",
                                      const G4String& pointsUnitIn = ""
                                      ) = 0;
 
  virtual BDSBeamPipe* CreateBeamPipe(const G4String&      nameIn,
                                      G4double             lengthIn,
                                      const G4ThreeVector& inputFaceNormalIn,
                                      const G4ThreeVector& outputFaceNormalIn,
                                      G4double      aper1               = 0,
                                      G4double      aper2               = 0,
                                      G4double      aper3               = 0,
                                      G4double      aper4               = 0,
                                      G4Material*   vacuumMaterialIn    = nullptr,
                                      G4double      beamPipeThicknessIn = 0,
                                      G4Material*   beamPipeMaterialIn  = nullptr,
                                      const G4String& pointsFileIn      = "",
                                      const G4String& pointsUnitIn      = "") = 0;
 
  virtual ~BDSBeamPipeFactoryBase(){;}
 
protected:
  BDSBeamPipeFactoryBase();
 
  void CleanUpBase();
 
  virtual void CleanUp();
  
  void CommonConstruction(const G4String& nameIn,
                          G4Material* vacuumMaterialIn,
                          G4Material* beamPipeMaterialIn,
                          G4double    length);
 
  BDSBeamPipe* BuildBeamPipeAndRegisterVolumes(BDSExtent extent,
                                               G4double  containerRadius,
                                               G4bool    containerIsCircular = false);
 
  static void CheckAngledVolumeCanBeBuilt(G4double length,
                                          const G4ThreeVector &inputfaceAngle,
                                          const G4ThreeVector &outputfaceAngle,
                                          G4double horizontalWidth,
                                          const G4String& name);
 
  // methods called by CommonConstruction, can be implemented by derived classes
  
  virtual void BuildLogicalVolumes(const G4String& nameIn,
                                   G4Material* vacuumMaterialIn,
                                   G4Material* beamPipeMaterialIn);
  virtual void SetVisAttributes(G4Material* beamPipeMaterialIn,
                                G4Material* vacuumMaterialIn);
 
  virtual void SetUserLimits(G4double length);
 
  virtual void PlaceComponents(const G4String& nameIn);
  
  G4bool           sensitiveBeamPipe;    
  G4bool           sensitiveVacuum;      
  G4bool           storeApertureImpacts; 
  G4VSolid*        vacuumSolid;
  G4VSolid*        beamPipeSolid;
  G4VSolid*        containerSolid;
  G4VSolid*        containerSubtractionSolid; 
  G4LogicalVolume* vacuumLV;
  G4LogicalVolume* beamPipeLV;
  G4LogicalVolume* containerLV;
  G4PVPlacement*   vacuumPV;
  G4PVPlacement*   beamPipePV;
  
  G4ThreeVector inputFaceNormal;
  G4ThreeVector outputFaceNormal;
};
 
#endif