BDSTunnelFactoryBase.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2024.
 
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 BDSTUNNELFACTORYBASE_H
#define BDSTUNNELFACTORYBASE_H
 
#include "BDSFactoryBase.hh"
#include "BDSTunnelSection.hh"
 
#include "globals.hh"  // geant4 globals / types
#include "G4ThreeVector.hh"
 
#include <set>
 
class G4LogicalVolume;
class G4Material;
class G4VisAttributes;
class G4VSolid;
 
class BDSGeometryComponent;
class BDSTunnelInfo;
 
class BDSTunnelFactoryBase: public BDSFactoryBase
{
public:
  virtual BDSTunnelSection* CreateTunnelSection(G4String      name,
                                                G4double      length,
                                                G4double      tunnelThickness,
                                                G4double      tunnelSoilThickness,
                                                G4Material*   tunnelMaterial,
                                                G4Material*   tunnelSoilMaterial,
                                                G4bool        tunnelFloor,
                                                G4double      tunnelFloorOffset,
                                                G4double      tunnel1,
                                                G4double      tunnel2,
                                                G4bool        visible) = 0;
 
  virtual BDSTunnelSection* CreateTunnelSectionAngledIn(G4String      name,
                                                        G4double      length,
                                                        G4double      angleIn,
                                                        G4double      tunnelThickness,
                                                        G4double      tunnelSoilThickness,
                                                        G4Material*   tunnelMaterial,
                                                        G4Material*   tunnelSoilMaterial,
                                                        G4bool        tunnelFloor,
                                                        G4double      tunnelFloorOffset,
                                                        G4double      tunnel1,
                                                        G4double      tunnel2,
                                                        G4bool        visible);
 
  virtual BDSTunnelSection* CreateTunnelSectionAngledOut(G4String      name,
                                                         G4double      length,
                                                         G4double      angleOut,
                                                         G4double      tunnelThickness,
                                                         G4double      tunnelSoilThickness,
                                                         G4Material*   tunnelMaterial,
                                                         G4Material*   tunnelSoilMaterial,
                                                         G4bool        tunnelFloor,
                                                         G4double      tunnelFloorOffset,
                                                         G4double      tunnel1,
                                                         G4double      tunnel2,
                                                         G4bool        visible);
 
  virtual BDSTunnelSection* CreateTunnelSectionAngledInOut(G4String      name,
                                                           G4double      length,
                                                           G4double      angleIn,
                                                           G4double      angleOut,
                                                           G4double      tunnelThickness,
                                                           G4double      tunnelSoilThickness,
                                                           G4Material*   tunnelMaterial,
                                                           G4Material*   tunnelSoilMaterial,
                                                           G4bool        tunnelFloor,
                                                           G4double      tunnelFloorOffset,
                                                           G4double      tunnel1,
                                                           G4double      tunnel2,
                                                           G4bool        visible);
 
  virtual BDSTunnelSection* CreateTunnelSectionAngled(G4String       name,
                                                      G4double       length,
                                                      G4ThreeVector  inputFaceIn,
                                                      G4ThreeVector  outputFaceIn,
                                                      G4double       tunnelThickness,
                                                      G4double       tunnelSoilThickness,
                                                      G4Material*    tunnelMaterial,
                                                      G4Material*    tunnelSoilMaterial,
                                                      G4bool         tunnelFloor,
                                                      G4double       tunnelFloorOffset,
                                                      G4double       tunnel1,
                                                      G4double       tunnel2,
                                                      G4bool         visible) = 0;
 
  virtual ~BDSTunnelFactoryBase() {;}
 
protected:
  BDSTunnelFactoryBase();
 
  void CommontTestInputParameters(G4double&    length,
                                  G4double&    tunnelThickness,
                                  G4double&    tunnelSoilThickness,
                                  G4Material*& tunnelMaterial,
                                  G4Material*& tunnelSoilMaterial);
  
  virtual void CommonConstruction(G4String    name,
                                  G4Material* tunnelMaterial,
                                  G4Material* tunnelSoilMaterial,
                                  G4double    length,
                                  G4double    containerXRadius,
                                  G4double    contianerYRadius,
                                  G4bool      visible);
 
  virtual void BuildLogicalVolumes(G4String    name,
                                   G4Material* tunnelMaterial,
                                   G4Material* tunnelSoilMaterial);
 
  virtual void SetVisAttributes(G4bool visible);
  
  virtual void SetUserLimits();
  
  virtual void PrepareGeometryComponent(G4double containerXRadius,
                                        G4double containerYRadius,
                                        G4double containerZRadius);
 
  virtual void PrepareTunnelSection(G4String name,
                                    G4double chordLength);
 
  virtual void SetSensitiveVolumes();
  
  virtual void PlaceComponents(G4String name);
 
  virtual void CleanUp();
    
  BDSGeometryComponent* tunnelComponent;
  BDSTunnelSection*     tunnelSection;
  
  G4VSolid*        containerSolid;
  G4VSolid*        tunnelSolid;
  G4VSolid*        soilSolid;
  G4VSolid*        floorSolid;
  G4VSolid*        intersectionSolid;
  G4LogicalVolume* containerLV;
  G4LogicalVolume* tunnelLV;
  G4LogicalVolume* soilLV;
  G4LogicalVolume* floorLV;
  G4ThreeVector    floorDisplacement;
  BDSTunnelInfo*   defaultModel;
 
  G4double         cumulativeAngle;
};
 
#endif