BDSFieldQuery.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2022.
 
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 BDSFIELDQUERY_H
#define BDSFIELDQUERY_H
#include "BDSFieldQueryInfo.hh"
 
#include "G4AffineTransform.hh"
#include "G4ThreeVector.hh"
#include "G4Types.hh"
 
#include <fstream>
#include <vector>
 
class G4Navigator;
class G4VPhysicalVolume;
 
 
class BDSFieldQuery
{
public:
  BDSFieldQuery();
  virtual ~BDSFieldQuery();
  
  virtual void QueryField(const BDSFieldQueryInfo* query);
  void QueryFields(const std::vector<BDSFieldQueryInfo*>& fieldQueries);
  
  static void AttachWorldVolumeToNavigator(G4VPhysicalVolume* worldPVIn);
  
  virtual void CleanUp();
 
protected:
  virtual void GetFieldValue(const G4ThreeVector& globalXYZ,
                             const G4ThreeVector& globalDirection,
                             G4double tGlobal,
                             G4double fieldValue[6]);
 
  virtual void CheckIfFieldObjectSpecified(const BDSFieldQueryInfo* query) const;
  
private:
  void CheckNStepsAndRange(const BDSFieldQueryInfo::QueryDimensionInfo& dimensionInfo,
                           const G4String& dimensionName,
                           const G4String& queryName) const;
  
  void QuerySpecificPoints(const BDSFieldQueryInfo* query);
 
  virtual void PrintBAndEInfo(const BDSFieldQueryInfo* query) const;
  
  virtual void OpenFiles(const BDSFieldQueryInfo* query);
  
  virtual void WriteHeader(std::ofstream& out, const BDSFieldQueryInfo* query) const;
  
  virtual void CloseFiles();
  
  G4ThreeVector LocalToGlobalPoint(const G4AffineTransform& localToGlobalTransform,
                                   G4double xLocal,
                                   G4double yLocal,
                                   G4double zLocal) const;
 
  void GlobalToLocalAxisField(const G4AffineTransform& globalToLocalTransform,
                              const G4double globalBEField[6],
                              G4double localBEField[6]);
  
  virtual void WriteFieldValue(const G4ThreeVector& xyzGlobal,
                               G4double tGlobal,
                               const G4double fieldValue[6]);
  
  std::ofstream oFileMagnetic;
  std::ofstream oFileElectric;
  G4bool queryMagnetic;
  G4bool queryElectric;
  G4bool writeX;
  G4bool writeY;
  G4bool writeZ;
  G4bool writeT;
  
  static G4Navigator* navigator;
};
 
#endif