BDSBeamPipeInfo.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 BDSBEAMPIPEINFO_H
#define BDSBEAMPIPEINFO_H
 
#include "BDSBeamPipeType.hh"
 
#include "globals.hh"         // geant4 types / globals
#include "G4ThreeVector.hh"
 
class BDSExtent;
class G4Material;
 
class BDSBeamPipeInfo
{
public:
  BDSBeamPipeInfo() = delete;
  BDSBeamPipeInfo(BDSBeamPipeType beamPipeTypeIn,
                  G4double        aper1In,
                  G4double        aper2In,
                  G4double        aper3In,
                  G4double        aper4In,
                  G4Material*     vacuumMaterialIn,
                  G4double        beamPipeThicknessIn,
                  G4Material*     beamPipeMaterialIn,
                  const G4ThreeVector& inputFaceNormalIn  = G4ThreeVector(0,0,-1),
                  const G4ThreeVector& outputFaceNormalIn = G4ThreeVector(0,0,1),
      const G4String& pointsFileNameIn = "",
      const G4String& pointsUnitIn = "mm");
 
  BDSBeamPipeInfo(const G4String&      beamPipeTypeIn,
                  G4double             aper1In,
                  G4double             aper2In,
                  G4double             aper3In,
                  G4double             aper4In,
                  const G4String&      vacuumMaterialIn,
                  G4double             beamPipeThicknessIn,
                  const G4String&      beamPipeMaterialIn,
                  const G4ThreeVector& inputFaceNormalIn  = G4ThreeVector(0,0,-1),
                  const G4ThreeVector& outputFaceNormalIn = G4ThreeVector(0,0,1));
 
  BDSBeamPipeInfo(const BDSBeamPipeInfo* defaultInfo,
                  const G4String&      beamPipeTypeIn,
                  G4double             aper1In,
                  G4double             aper2In,
                  G4double             aper3In,
                  G4double             aper4In,
                  const G4String&      vacuumMaterialIn,
                  G4double             beamPipeThicknessIn,
                  const G4String&      beamPipeMaterialIn,
                  const G4ThreeVector& inputFaceNormalIn  = G4ThreeVector(0,0,-1),
                  const G4ThreeVector& outputFaceNormalIn = G4ThreeVector(0,0,1));
 
  void CheckApertureInfo();
 
  BDSExtent Extent() const;
 
  BDSExtent ExtentInner() const;
 
  G4double IndicativeRadius() const;
 
  G4double IndicativeRadiusInner() const;
 
  BDSBeamPipeInfo ShrinkBy(G4double margin) const;
 
  BDSBeamPipeType beamPipeType;
  G4double        aper1;
  G4double        aper2;
  G4double        aper3;
  G4double        aper4;
  G4double        aperOffsetX;
  G4double        aperOffsetY;
  G4Material*     vacuumMaterial;
  G4double        beamPipeThickness;
  G4Material*     beamPipeMaterial;
  G4ThreeVector   inputFaceNormal;
  G4ThreeVector   outputFaceNormal;
  G4String        pointsFileName;
  G4String        pointsUnit;
  
private:
  void CheckAndSetPointsInfo(const G4String& beamPipeTypeIn);
  
  void CheckRequiredParametersSet(G4bool setAper1, G4bool setAper2,
                                  G4bool setAper3, G4bool setAper4);
  
  void InfoOKForCircular();
 
  void InfoOKForElliptical();
 
  void InfoOKForRectangular();
 
  void InfoOKForLHC();
 
  void InfoOKForLHCDetailed();
 
  void InfoOKForRectEllipse();
 
  void InfoOKForRaceTrack();
 
  void InfoOKForOctagonal();
 
  void InfoOKForClicPCL();
 
  void InfoOKForRhombus();
};
 
#endif