include/Geant4/G4SmartVoxelStat.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 // G4SmartVoxelStat
0027 //
0028 // Class description:
0029 //
0030 // Stores information on the performance of the smart voxel algorithm
0031 // for an individual logical volume.
0032
0033 // Author: D.C.Williams, UCSC (davidw@scipp.ucsc.edu)
0034 // --------------------------------------------------------------------
0035 #ifndef G4SmartVoxelStat_hh
0036 #define G4SmartVoxelStat_hh
0037
0038 #include "G4Types.hh"
0039
0040 class G4LogicalVolume;
0041 class G4SmartVoxelHeader;
0042
0043 class G4SmartVoxelStat
0044 {
0045   public:  // with description
0046
0047     G4SmartVoxelStat( const G4LogicalVolume* theVolume,
0048                       const G4SmartVoxelHeader* theVoxel,
0049                             G4double theSysTime,
0050                             G4double theUserTime );
0051       // Construct information on one volume's voxels
0052
0053     const G4LogicalVolume* GetVolume() const;
0054       // Return a pointer to the logical volume
0055
0056     const G4SmartVoxelHeader* GetVoxel() const;
0057       // Return a pointer to the voxel header
0058
0059     G4double GetSysTime() const;
0060       // Get amount of system CPU time needed to build voxels
0061
0062     G4double GetUserTime() const;
0063       // Get amount of user CPU time needed to build voxels
0064
0065     G4double GetTotalTime() const;
0066       // Get total amount of CPU time needed to build voxels
0067
0068     G4long GetNumberHeads() const;
0069       // Get number of voxel headers used in the volume
0070
0071     G4long GetNumberNodes() const;
0072       // Get number of voxel slices used in the volume
0073
0074     G4long GetNumberPointers() const;
0075       // Get number of voxel proxy pointers used in the volume
0076
0077     G4long GetMemoryUse() const;
0078       // Get number of bytes needed to store voxel information
0079
0080
0081   protected:
0082
0083     void CountHeadsAndNodes( const G4SmartVoxelHeader* head );
0084
0085     const G4LogicalVolume* volume;
0086     const G4SmartVoxelHeader* voxel;
0087
0088     G4double sysTime;
0089     G4double userTime;
0090
0091     G4long heads = 1;
0092     G4long nodes = 0;
0093     G4long pointers = 0;
0094 };
0095
0096 #endif