BDSBeamPipeInfo.cc

/* 
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/>.
*/
#include "BDSBeamPipeInfo.hh"
#include "BDSBeamPipeType.hh"
#include "BDSDebug.hh"
#include "BDSException.hh"
#include "BDSExtent.hh"
#include "BDSMaterials.hh"
#include "BDSUtilities.hh"
 
#include "globals.hh" // geant4 types / globals
#include "G4Material.hh"
 
#include <algorithm>
#include <array>
 
BDSBeamPipeInfo::BDSBeamPipeInfo(BDSBeamPipeType      beamPipeTypeIn,
                                 G4double             aper1In,
                                 G4double             aper2In,
                                 G4double             aper3In,
                                 G4double             aper4In,
                                 G4Material*          vacuumMaterialIn,
                                 G4double             beamPipeThicknessIn,
                                 G4Material*          beamPipeMaterialIn,
                                 const G4ThreeVector& inputFaceNormalIn,
                                 const G4ThreeVector& outputFaceNormalIn,
                                 const G4String&      pointsFileNameIn,
                                 const G4String&      pointsUnitIn):
  beamPipeType(beamPipeTypeIn),
  aper1(aper1In), aper2(aper2In), aper3(aper3In), aper4(aper4In),
  aperOffsetX(0), aperOffsetY(0),
  vacuumMaterial(vacuumMaterialIn),
  beamPipeThickness(beamPipeThicknessIn),
  beamPipeMaterial(beamPipeMaterialIn),
  inputFaceNormal(inputFaceNormalIn),
  outputFaceNormal(outputFaceNormalIn),
  pointsFileName(pointsFileNameIn),
  pointsUnit(pointsUnitIn)
{
  CheckApertureInfo();
}
 
BDSBeamPipeInfo::BDSBeamPipeInfo(const G4String&      beamPipeTypeIn,
                                 G4double             aper1In,
                                 G4double             aper2In,
                                 G4double             aper3In,
                                 G4double             aper4In,
                                 const G4String&      vacuumMaterialIn,
                                 G4double             beamPipeThicknessIn,
                                 const G4String&      beamPipeMaterialIn,
                                 const G4ThreeVector& inputFaceNormalIn,
                                 const G4ThreeVector& outputFaceNormalIn):
  aper1(aper1In), aper2(aper2In), aper3(aper3In), aper4(aper4In),
  aperOffsetX(0), aperOffsetY(0),
  beamPipeThickness(beamPipeThicknessIn),
  inputFaceNormal(inputFaceNormalIn),
  outputFaceNormal(outputFaceNormalIn),
  pointsFileName(""),
  pointsUnit("mm")
{
  beamPipeType     = BDS::DetermineBeamPipeType(beamPipeTypeIn);
  vacuumMaterial   = BDSMaterials::Instance()->GetMaterial(vacuumMaterialIn);
  beamPipeMaterial = BDSMaterials::Instance()->GetMaterial(beamPipeMaterialIn);
 
  if (beamPipeType == BDSBeamPipeType::pointsfile)
    {CheckAndSetPointsInfo(beamPipeTypeIn);}
  CheckApertureInfo();
}
  
BDSBeamPipeInfo::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,
                                 const G4ThreeVector& outputFaceNormalIn):
  aperOffsetX(0), aperOffsetY(0),
  inputFaceNormal(inputFaceNormalIn),
  outputFaceNormal(outputFaceNormalIn)
{
  if (beamPipeTypeIn.empty())
    {
      beamPipeType   = defaultInfo->beamPipeType;
      pointsFileName = defaultInfo->pointsFileName; // copy even if empty
      pointsUnit     = defaultInfo->pointsUnit;
    }
  else 
    {
      beamPipeType = BDS::DetermineBeamPipeType(beamPipeTypeIn);
      if (beamPipeType == BDSBeamPipeType::pointsfile)
        {CheckAndSetPointsInfo(beamPipeTypeIn);}
    }
 
  if (!BDS::IsFinite(aper1In))
    {aper1 = defaultInfo->aper1;}
  else
    {aper1 = aper1In;}
  if (!BDS::IsFinite(aper2In))
    {aper2 = defaultInfo->aper2;}
  else
    {aper2 = aper2In;}
  if (!BDS::IsFinite(aper3In))
    {aper3 = defaultInfo->aper3;}
  else
    {aper3 = aper3In;}
  if (!BDS::IsFinite(aper4In))
    {aper4 = defaultInfo->aper4;}
  else
    {aper4 = aper4In;}
  if (!BDS::IsFinite(beamPipeThicknessIn))
    {beamPipeThickness = defaultInfo->beamPipeThickness;}
  else
    {beamPipeThickness = beamPipeThicknessIn;}
  
  if (vacuumMaterialIn.empty())
    {vacuumMaterial = defaultInfo->vacuumMaterial;}
  else
    {vacuumMaterial = BDSMaterials::Instance()->GetMaterial(vacuumMaterialIn);}
  if (beamPipeMaterialIn.empty())
    {beamPipeMaterial = defaultInfo->beamPipeMaterial;}
  else
    {beamPipeMaterial = BDSMaterials::Instance()->GetMaterial(beamPipeMaterialIn);}
  
  CheckApertureInfo();
}
 
 
void BDSBeamPipeInfo::CheckAndSetPointsInfo(const G4String& beamPipeTypeIn)
{
  auto typeAndFileName = BDS::SplitOnColon(beamPipeTypeIn); // find first colon
  G4String fname = typeAndFileName.second;
  if (BDS::StrContains(fname, ":"))
    {// optional second colon with units after it
      auto fileNameAndUnit = BDS::SplitOnColon(fname);
      pointsFileName = fileNameAndUnit.first;
      pointsUnit = fileNameAndUnit.second;
    }
  else
    {
      pointsFileName = fname;
      pointsUnit = "mm";
    }
}
 
 
BDSBeamPipeInfo BDSBeamPipeInfo::ShrinkBy(G4double margin) const
{
  BDSBeamPipeInfo result(*this); // make a copy
 
  std::array<G4double*, 4> apers {&result.aper1, &result.aper2, &result.aper3, &result.aper4};
  for (auto var : apers)
  {
      if (*var > 0)
        { *var -= margin;}
  }
  return result;
}
 
void BDSBeamPipeInfo::CheckApertureInfo()
{
  switch (beamPipeType.underlying())
    {
    case BDSBeamPipeType::circular:
      {InfoOKForCircular();    break;}
    case BDSBeamPipeType::elliptical:
      {InfoOKForElliptical();  break;}
    case BDSBeamPipeType::rectangular:
      {InfoOKForRectangular(); break;}
    case BDSBeamPipeType::lhc:
      {InfoOKForLHC();         break;}
    case BDSBeamPipeType::lhcdetailed:
      {InfoOKForLHCDetailed(); break;}
    case BDSBeamPipeType::rectellipse:
      {InfoOKForRectEllipse(); break;}
    case BDSBeamPipeType::racetrack:
      {InfoOKForRaceTrack();   break;}
    case BDSBeamPipeType::octagonal:
      {InfoOKForOctagonal();   break;}
    case BDSBeamPipeType::clicpcl:
      {InfoOKForClicPCL();     break;}
    case BDSBeamPipeType::rhombus:
      {InfoOKForRhombus();     break;}
    default:
      {InfoOKForCircular();    break;}
    }
}
 
BDSExtent BDSBeamPipeInfo::ExtentInner() const
{
  G4double extX = 0;
  G4double extY = 0;
  switch (beamPipeType.underlying())
    {
      case BDSBeamPipeType::circular:
      case BDSBeamPipeType::circularvacuum:
        {
          extX = aper1;
          extY = aper1;
          break;
        }
      case BDSBeamPipeType::elliptical:
      case BDSBeamPipeType::rectangular:
      case BDSBeamPipeType::octagonal:
      case BDSBeamPipeType::rhombus:
        {
          extX = aper1;
          extY = aper2;
          break;
        }
      case BDSBeamPipeType::lhc:
      case BDSBeamPipeType::lhcdetailed:
      case BDSBeamPipeType::rectellipse:
        {
          extX = std::min(aper1, aper3);
          extY = std::min(aper2, aper3);
          break;
        }
      case BDSBeamPipeType::racetrack:
        {
          extX = aper1 + aper3;
          extY = aper2 + aper3;
          break;
        }
    case BDSBeamPipeType::clicpcl:
      {// this one is asymmetric so done separately
        G4double extentX     = aper1 + beamPipeThickness;
        G4double extentYLow  = -(std::abs(aper3) + beamPipeThickness);
        G4double extentYHigh = aper2 + aper4 + beamPipeThickness;
        BDSExtent ext = BDSExtent(-extentX,     extentX,
                                  extentYLow,   extentYHigh,
                                  0,0);
        return ext;
        break;
      }
    default:break;
    }
  BDSExtent ext = BDSExtent(extX, extY, 0);
  return ext;
}
 
BDSExtent BDSBeamPipeInfo::Extent() const
{
  BDSExtent extentInner = ExtentInner();
  G4double extX = extentInner.XPos(); // +ve values
  G4double extY = extentInner.YPos();
  extX += beamPipeThickness;
  extY += beamPipeThickness;
  return BDSExtent(extX, extY, 0);
}
 
G4double BDSBeamPipeInfo::IndicativeRadius() const
{
  BDSExtent ext = Extent();
  return ext.MaximumAbsTransverse();
}
 
G4double BDSBeamPipeInfo::IndicativeRadiusInner() const
{
  BDSExtent ext = ExtentInner();
  return ext.MinimumAbsTransverse();
}
 
void BDSBeamPipeInfo::CheckRequiredParametersSet(G4bool setAper1,
                                                 G4bool setAper2,
                                                 G4bool setAper3,
                                                 G4bool setAper4)
{
  G4bool shouldExit = false;
  if (setAper1)
    {
      if (!BDS::IsFinite(aper1))
        {G4cerr << "\"aper1\" not set, but required to be" << G4endl; shouldExit = true;}
    }
 
  if (setAper2)
    {
      if (!BDS::IsFinite(aper2))
        {G4cerr << "\"aper2\" not set, but required to be" << G4endl; shouldExit = true;}
    }
 
  if (setAper3)
    {
      if (!BDS::IsFinite(aper3))
        {G4cerr << "\"aper3\" not set, but required to be" << G4endl; shouldExit = true;}
    }
 
  if (setAper4)
    {
      if (!BDS::IsFinite(aper4))
        {G4cerr << "\"aper4\" not set, but required to be" << G4endl; shouldExit = true;}
    }
 
  if (shouldExit)
    {throw BDSException(__METHOD_NAME__, "aperture parameter missing");}
}
 
void BDSBeamPipeInfo::InfoOKForCircular()
{
  CheckRequiredParametersSet(true, false, false, false);
}
 
void BDSBeamPipeInfo::InfoOKForElliptical()
{
  CheckRequiredParametersSet(true, true, false, false);
}
 
void BDSBeamPipeInfo::InfoOKForRectangular()
{
  CheckRequiredParametersSet(true, true, false, false);
}
 
void BDSBeamPipeInfo::InfoOKForLHC()
{
  CheckRequiredParametersSet(true, true, true, false);
 
  if ((aper3 > aper1) && (aper2 < aper3))
    {throw BDSException(__METHOD_NAME__, "\"aper3\" > \"aper1\" (or \"beamPipeRadius\") for lhc aperture model - will not produce desired shape");}
 
  if ((aper3 > aper2) && (aper1 < aper3))
    {throw BDSException(__METHOD_NAME__, "\"aper3\" > \"aper2\" (or \"beamPipeRadius\") for lhc aperture model - will not produce desired shape");}
}
 
void BDSBeamPipeInfo::InfoOKForLHCDetailed()
{
  InfoOKForLHC();
}
 
void BDSBeamPipeInfo::InfoOKForRectEllipse()
{
  CheckRequiredParametersSet(true, true, true, true);
 
  // TODO
}
 
void BDSBeamPipeInfo::InfoOKForRaceTrack()
{
  CheckRequiredParametersSet(true, true, true, false);
}
 
void BDSBeamPipeInfo::InfoOKForOctagonal()
{
  CheckRequiredParametersSet(true, true, true, true);
 
  if (aper3 >= aper1)
    {throw BDSException(__METHOD_NAME__, "aper3 is >= aper1 - invalid for an octagonal aperture");}
  if (aper4 >= aper2)
    {throw BDSException(__METHOD_NAME__, "aper4 is >= aper2 - invalid for an octagonal aperture");}
}
 
void BDSBeamPipeInfo::InfoOKForClicPCL()
{
  CheckRequiredParametersSet(true, true, true, false);
}
 
void BDSBeamPipeInfo::InfoOKForRhombus()
{
  CheckRequiredParametersSet(true, true, false, false);
 
  if (aper1 <= 0)
    {throw BDSException(__METHOD_NAME__, "aper1 is <= 0 - invalid for a rhombus aperture");}
  if (aper2 <= 0)
    {throw BDSException(__METHOD_NAME__, "aper2 is <= 0 - invalid for a rhombus aperture");}
  if (aper3 < 0)
    {throw BDSException(__METHOD_NAME__, "aper3 is < 0 - invalid for a rhombus aperture");}
  if (aper3 > 1.1*aper1)
    {throw BDSException(__METHOD_NAME__, "aper3 is > 1.1 x aper1 - invalid for a rhombus aperture");}
  if (aper3 > 1.1*aper2)
    {throw BDSException(__METHOD_NAME__, "aper3 is > 1.1 x aper2 - invalid for a rhombus aperture");}
}