| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 /// \file processes/phonon/include/G4LatticeReader.hh
27 /// \brief Definition of the G4LatticeReader class
28 //
29 // NOTE: This reader class for logical lattices should be moved to
30 // materials/ after the 10.0 release (and this comment removed).
31 //
32 // 20131115 Move ctor, dtor implementations to .cc file.
33
34 #ifndef G4LatticeReader_h
35 #define G4LatticeReader_h 1
36
37 #include "globals.hh"
38 #include <iosfwd>
39
40 class G4LatticeLogical;
41
42 class G4LatticeReader {
43 public:
44 G4LatticeReader(G4int vb=0);
45 ~G4LatticeReader();
46
47 void SetVerboseLevel(G4int vb) { verboseLevel = vb; }
48
49 G4LatticeLogical* MakeLattice(const G4String& filepath);
50
51 protected:
52 G4bool OpenFile(const G4String& filepath);
53 G4bool ProcessToken();
54 G4bool ProcessValue(const G4String& name); // Numerical parameters
55 G4bool ProcessConstants(); // Four dynamical constants
56 G4bool ProcessMap(); // Velocity magnitudes file
57 G4bool ProcessNMap(); // Direction vectors file
58 G4bool ReadMapInfo(); // Get map file parameters
59 G4bool SkipComments(); // Everything after '#'
60 void CloseFile();
61
62 private:
63 G4int verboseLevel; // For reporting progress, also use G4VERBOSE
64
65 std::ifstream* psLatfile; // Configuration file being read
66 G4LatticeLogical* pLattice; // Lattice under construction (not owned)
67
68 G4String fMapPath; // Path to config file to find velocity maps
69 G4String fToken; // Reusable buffers for reading file
70 G4double fValue; // ... floating point data values
71 G4String fMap, fsPol; // ... map filename and polarization code
72 G4int fPol, fNX, fNY; // ... map binning in each direction
73
74 static const G4String fDataDir; // Directory path ($G4LATTICEDATA)
75 };
76
77 #endif /* G4LatticeReader_h */
78