Geant4  10.03.p01
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
G4CachedMagneticField.hh
Go to the documentation of this file.
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 //
27 // $ Id: G4CachedMagneticField.hh,v 1.0 2009/07/20 18:53:00 japost Exp $
28 //
29 //
30 // class G4CachedMagneticField
31 //
32 // Class description:
33 //
34 // Caches Magnetic Field value, for field whose evaluation is expensive.
35 
36 // History:
37 // - Created. JA, July 20th, 2009.
38 // --------------------------------------------------------------------
39 
40 #ifndef G4CACHED_MAGNETIC_FIELD_DEF
41 #define G4CACHED_MAGNETIC_FIELD_DEF
42 
43 #include "G4Types.hh"
44 #include "G4ThreeVector.hh"
45 #include "G4MagneticField.hh"
46 
48 {
49  public: // with description
50 
52  virtual ~G4CachedMagneticField();
53  // Constructor and destructor. No actions.
54 
57  // Copy constructor & assignment operator.
58 
59  virtual void GetFieldValue( const G4double Point[4],
60  G4double *Bfield ) const;
61 
62  G4double GetConstDistance() const { return fDistanceConst; }
63  void SetConstDistance( G4double dist ){ fDistanceConst= dist;}
64 
65  G4int GetCountCalls() const { return fCountCalls; }
68  void ReportStatistics();
69 
70  virtual G4Field* Clone() const;
71 
72  private:
73  G4MagneticField *fpMagneticField;
74  // When the field is evaluated within this distance it will not change
75  G4double fDistanceConst;
76  // Caching state
77  mutable G4ThreeVector fLastLocation;
78  mutable G4ThreeVector fLastValue;
79 
80  protected:
82 };
83 
84 #endif /* G4CACHED_MAGNETIC_FIELD_DEF */
virtual void GetFieldValue(const G4double Point[4], G4double *Bfield) const
G4double GetConstDistance() const
void SetConstDistance(G4double dist)
const char * p
Definition: xmltok.h:285
virtual G4Field * Clone() const
int G4int
Definition: G4Types.hh:78
G4int GetCountEvaluations() const
G4CachedMagneticField(G4MagneticField *, G4double distanceConst)
G4CachedMagneticField & operator=(const G4CachedMagneticField &p)
double G4double
Definition: G4Types.hh:76