BDSCollimator.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 BDSCOLLIMATOR_H
#define BDSCOLLIMATOR_H
 
#include "BDSAcceleratorComponent.hh"
 
#include "globals.hh" // geant4 types / globals
 
class G4Colour;
class G4Material;
class G4UserLimits;
class G4VSolid;
 
class BDSCollimator: public BDSAcceleratorComponent
{
public:
  BDSCollimator() = delete;
  BDSCollimator(const G4String& name,
                G4double        length,
                G4double        horizontalWidth,
                const G4String& type,
                G4Material* collimatorMaterial,
                G4Material* vacuumMaterial,
                G4double    xApertureIn    = 0,
                G4double    yApertureIn    = 0,
                G4double    xApertureOutIn = 0,
                G4double    yApertureOutIn = 0,
                G4Colour*   colourIn       = nullptr,
                G4bool      circularOuterIn = false);
  BDSCollimator& operator=(const BDSCollimator&) = delete;
  BDSCollimator(BDSCollimator&) = delete;
  virtual ~BDSCollimator();
 
  virtual G4String Material() const;
  virtual G4double XApertureIn()  const {return xAperture;}
  virtual G4double XApertureOut() const {return xApertureOut;}
  virtual G4double YApertureIn()  const {return yAperture;}
  virtual G4double YApertureOut() const {return yApertureOut;}
 
  virtual void SetMinimumKineticEnergy(G4double minimimumKineticEnergyIn) {minKineticEnergy = minimimumKineticEnergyIn;}
 
protected:
  virtual void CheckParameters();
  
  virtual void Build();
 
  virtual void BuildContainerLogicalVolume();
  
  virtual void BuildInnerCollimator() = 0;
 
  G4UserLimits* CollimatorUserLimits();
 
  G4VSolid* collimatorSolid;
  G4VSolid* innerSolid;
  G4VSolid* vacuumSolid;
  G4double    horizontalWidth;    
  G4Material* collimatorMaterial; 
  G4Material* vacuumMaterial;     
  G4double    xAperture;          
  G4double    yAperture;          
  G4double    xApertureOut;       
  G4double    yApertureOut;       
  G4bool      tapered;            
  G4Colour*   colour;             
  G4double    minKineticEnergy;   
  G4bool      circularOuter;      
  G4bool      collimatorTypeSensitivity; 
};
 
#endif