include/Geant4/G4VScoreWriter.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4VScoreWriter
0027 //
0028 // Class description:
0029 //
0030 // This class represents storing the scored quantity into a file.
0031 //
0032 // Author: Makoto Asai
0033 // --------------------------------------------------------------------
0034 #ifndef G4VScoreWriter_h
0035 #define G4VScoreWriter_h 1
0036
0037 #include "globals.hh"
0038
0039 class G4VScoringMesh;
0040
0041 class G4VScoreWriter
0042 {
0043  public:
0044
0045   G4VScoreWriter() = default;
0046   virtual ~G4VScoreWriter() = default;
0047
0048   // store a quantity into a file
0049   virtual void DumpQuantityToFile(const G4String& psName,
0050                                   const G4String& fileName,
0051                                   const G4String& option);
0052   // store all quantities into a file
0053   virtual void DumpAllQuantitiesToFile(const G4String& fileName,
0054                                        const G4String& option);
0055
0056   // set a socring mesh to retrieve its quantities
0057   void SetScoringMesh(G4VScoringMesh* sm);
0058   // set a verbose level
0059   inline void SetVerboseLevel(G4int vl) { verboseLevel = vl; }
0060   inline void SetFactor(G4double val = 1.0) { fact = val; }
0061   inline G4double GetFactor() const { return fact; }
0062
0063  protected:
0064
0065   // get an index from (x,y,z)
0066   G4int GetIndex(G4int x, G4int y, G4int z) const;
0067
0068  protected:
0069
0070   G4int fNMeshSegments[3] = {0, 0, 0};  // number of segments of the mesh
0071   G4VScoringMesh* fScoringMesh = nullptr;
0072   G4int verboseLevel = 0;
0073   G4double fact = 1.0;
0074 };
0075
0076 #endif