BDSCollimatorBeamMask.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 BDSCOLLIMATORBEAMMASK_H
#define BDSCOLLIMATORBEAMMASK_H
 
#include "globals.hh"
 
#include "BDSAcceleratorComponent.hh"
 
class G4Colour;
class G4Material;
 
class BDSCollimatorBeamMask: public BDSAcceleratorComponent
{
public:
  BDSCollimatorBeamMask() = delete;
  BDSCollimatorBeamMask(const G4String&  name,
                        G4double         length,
                        BDSBeamPipeInfo* beamPipeInfoIn,
                        G4double         horizontalWidth,
                        G4Material*      collimatorMaterial,
                        G4Material*      vacuumMaterial,
                        G4double         xApertureIn     = 0,
                        G4double         yApertureIn     = 0,
                        G4double         xApertureSlitIn = 0,
                        G4double         yApertureSlitIn = 0,
                        G4double         xOffsetIn       = 0,
                        G4double         yOffsetIn       = 0,
                        G4double         xOffsetSlitIn   = 0,
                        G4double         yOffsetSlitIn   = 0,
                        G4double         tiltSlitIn      = 0,
                        G4Colour*        colourIn       = nullptr,
                        G4bool           circularOuterIn = false);
  BDSCollimatorBeamMask& operator=(const BDSCollimatorBeamMask&) = delete;
  BDSCollimatorBeamMask(BDSCollimatorBeamMask&) = delete;
  virtual ~BDSCollimatorBeamMask(){;};
 
  virtual G4String Material() const;
  virtual G4double XAperture()  const {return xAperture;}
  virtual G4double XApertureSlit() const {return xApertureSlit;}
  virtual G4double YAperture()  const {return yAperture;}
  virtual G4double YApertureSlit() const {return yApertureSlit;}
 
  virtual void SetMinimumKineticEnergy(G4double minimumKineticEnergyIn) {minKineticEnergy = minimumKineticEnergyIn;}
 
protected:
  virtual void CheckParameters();
 
  virtual void BuildContainerLogicalVolume();
  virtual void BuildInner();
  virtual void Build();
 
  G4UserLimits* CollimatorUserLimits();
 
  G4VSolid* collimatorSolid;
  G4VSolid* innerSolid;
  G4VSolid* vacuumSolid;
 
  G4double    horizontalWidth;    
  G4Material* collimatorMaterial; 
  G4Material* vacuumMaterial;     
  G4double    xAperture;          
  G4double    yAperture;          
  G4double    xApertureSlit;      
  G4double    yApertureSlit;      
  G4double    xOffset;            
  G4double    yOffset;            
  G4double    xOffsetSlit;        
  G4double    yOffsetSlit;        
  G4double    tiltSlit;           
  G4Colour*   colour;             
  G4double    minKineticEnergy;   
  G4bool      circularOuter;      
};
 
#endif