BDSBunchUserFile.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 BDSBUNCHUSERFILE_H
#define BDSBUNCHUSERFILE_H 
 
#include "BDSBunchFileBased.hh"
 
#include <fstream>
#include <list>
#include <regex>
#include <set>
#include <sstream>
#include <string>
 
#ifdef USE_GZSTREAM
#include "src-external/gzstream/gzstream.h"
#endif
 
class BDSParticleCoordsFull;
class BDSParticleCoordsFullGlobal;
 
template <class T>
class BDSBunchUserFile: public BDSBunchFileBased
{
public: 
  BDSBunchUserFile();
  virtual ~BDSBunchUserFile();
  virtual void SetOptions(const BDSParticleDefinition* beamParticle,
                          const GMAD::Beam& beam,
                          const BDSBunchType& distrType,
                          G4Transform3D beamlineTransformIn = G4Transform3D::Identity,
                          const G4double beamlineS = 0);
  virtual void CheckParameters();
 
  virtual void RecreateAdvanceToEvent(G4int eventOffset);
 
  virtual BDSParticleCoordsFullGlobal GetNextParticleValid(G4int maxTries);
  
  virtual G4bool DistributionIsFinished() const {return endOfFileReached;}
 
  virtual BDSParticleCoordsFull GetNextParticleLocal();
  
  virtual G4bool ExpectChangingParticleType() const {return true;}
  
private:
  G4String distrFile;     
  G4String distrFilePath; 
  G4String bunchFormat;   
  G4long   nlinesIgnore;  
  G4long   nlinesSkip;    
  G4long   nLinesValidData;
  G4double particleMass;  
  G4int    lineCounter;   
  G4bool   printedOutFirstTime;    
  G4bool   anEnergyCoordinateInUse;
  G4bool   changingParticleType;   
  G4bool   endOfFileReached;
 
  void ParseFileFormat(); 
  void OpenBunchFile();   
  
  void SkipNLinesIgnoreIntoFile(G4bool usualPrintOut=true);
  
  void SkipNLinesSkip(G4bool usualPrintOut=true);
  
  void CloseBunchFile();  
 
  void skip(std::stringstream& stream, G4int nvalues);
 
  T InputBunchFile;
 
  template <typename Type> void ReadValue(std::stringstream& stream, Type& value);
 
  struct Doublet {
    G4String name;
    G4double unit; 
  };
 
  std::list<Doublet> fields;
  
  G4bool SkippableLine(const std::string& line) const;
 
  void CheckConflictingParameters(const std::set<G4String>& s) const;
 
  template <typename U>
  void CheckAndParseUnits(const G4String& name, const G4String& rest, U unitParser);
 
  G4long CountNLinesValidDataInFile();
  
  virtual void Initialise();
 
  void EndOfFileAction();
 
  G4double ffact; 
  std::regex comment;
  G4bool   matchDistrFileLength;
};
 
namespace BDS
{
  G4double ParseEnergyUnit(const G4String& fmt);
  G4double ParseLengthUnit(const G4String& fmt);
  G4double ParseAngleUnit(const G4String& fmt);
  G4double ParseTimeUnit(const G4String& fmt);
}
#endif