BDSPhysicsUtilities.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
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 BDSPHYSICSUTILITIES_H
#define BDSPHYSICSUTILITIES_H
 
#include "globals.hh"
#include "G4Version.hh"
 
#include "parser/fastlist.h"
#include "parser/physicsbiasing.h"
 
#include <set>
#include <string>
#include <utility>
 
class BDSParticleDefinition;
class G4DynamicParticle;
class G4GenericBiasingPhysics;
class G4ParticleDefinition;
class G4VModularPhysicsList;
 
#if G4VERSION_NUMBER > 1049
// lots of extra code to disable bad particle killing in Geant4.10.5 series
#include <utility>
class G4CoupledTransportation;
class G4Transportation;
#endif
 
namespace GMAD
{
  class Beam;
}
 
namespace BDS
{
  G4bool IsIon(const G4ParticleDefinition* particle);
 
  G4bool IsIon(const G4DynamicParticle* paritlce);
  
  G4VModularPhysicsList* BuildPhysics(const G4String& physicsList, G4int verbosity = 1);
 
  G4int NBeamParametersSet(const GMAD::Beam&            beamDefinition,
                           const std::set<std::string>& keys);
 
  void ConflictingParametersSet(const GMAD::Beam&            beamDefinition,
                                const std::set<std::string>& keys,
                                G4int                        nSet,
                                G4bool                       warnZeroParamsSet = true,
                                const G4String&              unitString = "");
 
  void ConstructDesignAndBeamParticle(const GMAD::Beam& beamDefinition,
                                      G4double ffact,
                                      BDSParticleDefinition*& designParticle,
                                      BDSParticleDefinition*& beamParticle,
                                      G4bool& beamDifferentFromDesignParticle);
  
  BDSParticleDefinition* ConstructParticleDefinition(const G4String& particleNameIn,
                                                     G4double totalEnergyIn,
                                                     G4double kineticEnergyIn,
                                                     G4double momentumIn,
                                                     G4double ffact = 1);
 
  void ConstructBeamParticleG4(const G4String& name);
  
  void ConstructMinimumParticleSet();
  
  void ConstructExtendedParticleSet();
 
  void PrintPrimaryParticleProcesses(const G4String& primaryParticleName);
 
  void PrintDefinedParticles();
  
  G4GenericBiasingPhysics* BuildAndAttachBiasWrapper(const GMAD::FastList<GMAD::PhysicsBiasing>& biases);
 
  void BuildMuonBiasing(G4VModularPhysicsList* physicsList);
 
#if G4VERSION_NUMBER > 1039
  G4VModularPhysicsList* ChannellingPhysicsComplete(G4bool useEMD  = false,
                                                    G4bool regular = false,
                                                    G4bool em4     = false,
                                                    G4bool emss    = false);
#endif
 
  void SetRangeCuts(G4VModularPhysicsList* physicsList, G4int verbosity = 1);
 
  void CheckAndSetEnergyValidityRange();
 
#if G4VERSION_NUMBER > 1049
  void FixGeant105ThreshholdsForBeamParticle(const BDSParticleDefinition* particleDefinition);
 
  void FixGeant105ThreshholdsForParticle(const G4ParticleDefinition* particleDefinition);
 
  void ChangeLooperParameters(const G4ParticleDefinition* particleDef);
 
  std::pair<G4Transportation*, G4CoupledTransportation*> FindTransportation(const G4ParticleDefinition* particleDef);
#endif
}
 
#endif