BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
BDSApertureInfo.hh
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2022.
4
5This file is part of BDSIM.
6
7BDSIM is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published
9by the Free Software Foundation version 3 of the License.
10
11BDSIM is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
18*/
19#ifndef BDSAPERTUREINFO_H
20#define BDSAPERTUREINFO_H
21
22#include "BDSApertureType.hh"
23
24#include "globals.hh" // geant4 types / globals
25#include "G4ThreeVector.hh"
26
27class BDSExtent;
28class G4Material;
29
37{
38public:
40 BDSApertureInfo(BDSApertureType apertureTypeIn,
41 G4double aper1In,
42 G4double aper2In,
43 G4double aper3In,
44 G4double aper4In,
45 G4String nameForError = "");
46
48 BDSApertureInfo(G4String apertureTypeIn,
49 G4double aper1In,
50 G4double aper2In,
51 G4double aper3In,
52 G4double aper4In,
53 G4String nameForError = "");
54
58 G4String apertureTypeIn,
59 G4double aper1In,
60 G4double aper2In,
61 G4double aper3In,
62 G4double aper4In,
63 G4String nameForError = "");
64
67 void CheckApertureInfo(const G4String& nameForError);
68
71 BDSExtent Extent() const;
72
74 G4double IndicativeRadius() const;
75
78 G4double aper1;
79 G4double aper2;
80 G4double aper3;
81 G4double aper4;
83
84private:
86 BDSApertureInfo() = delete;
87
92 void CheckRequiredParametersSet(G4bool setAper1, G4bool setAper2,
93 G4bool setAper3, G4bool setAper4);
94
96 void InfoOKForCircular();
97
100
103
105 void InfoOKForLHC();
106
109
112
114 void InfoOKForRaceTrack();
115
117 void InfoOKForOctagonal();
118
120 void InfoOKForClicPCL();
121};
122
123#endif
Holder class for all information required to describe an aperture.
void InfoOKForRectangular()
Aperture info check for rectangular aperture.
void CheckApertureInfo(const G4String &nameForError)
void InfoOKForRectEllipse()
Aperture info check for rectellipse aperture.
void InfoOKForLHCDetailed()
Aperture info check for lhc detailed aperture.
G4double IndicativeRadius() const
Return an indicative extent of the beam pipe - typically the maximum of x or y extent.
G4double aper1
Public member for direct access.
void InfoOKForRaceTrack()
Aperture info check for racetrack aperture.
void InfoOKForElliptical()
Aperture info check for elliptical aperture.
G4double aper2
Public member for direct access.
BDSExtent Extent() const
G4double aper3
Public member for direct access.
G4double aper4
Public member for direct access.
BDSApertureInfo()=delete
Private default constructor to ensure one of supplied constructors is used.
void CheckRequiredParametersSet(G4bool setAper1, G4bool setAper2, G4bool setAper3, G4bool setAper4)
void InfoOKForClicPCL()
Aperture info check for CLIC PCL aperture.
void InfoOKForOctagonal()
Aperture info check for octagonal aperture.
void InfoOKForLHC()
Aperture info check for lhc aperture.
void InfoOKForCircular()
Aperture info check for circular aperture.
BDSApertureType apertureType
Public member for direct access.
Holder for +- extents in 3 dimensions.
Definition: BDSExtent.hh:39