| 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 | // GEANT4 tag $Name: $ |
|---|
| 29 | // |
|---|
| 30 | // |
|---|
| 31 | // class G4CachedMagneticField |
|---|
| 32 | // |
|---|
| 33 | // Class description: |
|---|
| 34 | // |
|---|
| 35 | // Caches Magnetic Field value, for field whose evaluation is expensive. |
|---|
| 36 | |
|---|
| 37 | // History: |
|---|
| 38 | // - Created. JA, July 20th, 2009. |
|---|
| 39 | // -------------------------------------------------------------------- |
|---|
| 40 | |
|---|
| 41 | #ifndef G4CACHED_MAGNETIC_FIELD_DEF |
|---|
| 42 | #define G4CACHED_MAGNETIC_FIELD_DEF |
|---|
| 43 | |
|---|
| 44 | #include "G4Types.hh" |
|---|
| 45 | #include "G4ThreeVector.hh" |
|---|
| 46 | #include "G4MagneticField.hh" |
|---|
| 47 | |
|---|
| 48 | class G4CachedMagneticField : public G4MagneticField |
|---|
| 49 | { |
|---|
| 50 | public: // with description |
|---|
| 51 | |
|---|
| 52 | G4CachedMagneticField(G4MagneticField *, G4double distanceConst); |
|---|
| 53 | virtual ~G4CachedMagneticField(); |
|---|
| 54 | // Constructor and destructor. No actions. |
|---|
| 55 | |
|---|
| 56 | G4CachedMagneticField(const G4CachedMagneticField &r); |
|---|
| 57 | G4CachedMagneticField& operator = (const G4CachedMagneticField &p); |
|---|
| 58 | // Copy constructor & assignment operator. |
|---|
| 59 | |
|---|
| 60 | virtual void GetFieldValue( const G4double Point[4], |
|---|
| 61 | G4double *Bfield ) const; |
|---|
| 62 | |
|---|
| 63 | G4double GetConstDistance() const { return fDistanceConst; } |
|---|
| 64 | void SetConstDistance( G4double dist ){ fDistanceConst= dist;} |
|---|
| 65 | |
|---|
| 66 | G4int GetCountCalls() const { return fCountCalls; } |
|---|
| 67 | G4int GetCountEvaluations() const { return fCountEvaluations; } |
|---|
| 68 | void ClearCounts() { fCountCalls = 0; fCountEvaluations=0; } |
|---|
| 69 | void ReportStatistics(); |
|---|
| 70 | |
|---|
| 71 | private: |
|---|
| 72 | G4MagneticField *fpMagneticField; |
|---|
| 73 | // When the field is evaluated within this distance it will not change |
|---|
| 74 | G4double fDistanceConst; |
|---|
| 75 | // Caching state |
|---|
| 76 | mutable G4ThreeVector fLastLocation; |
|---|
| 77 | mutable G4ThreeVector fLastValue; |
|---|
| 78 | |
|---|
| 79 | protected: |
|---|
| 80 | mutable G4int fCountCalls, fCountEvaluations; |
|---|
| 81 | }; |
|---|
| 82 | |
|---|
| 83 | #endif /* G4CACHED_MAGNETIC_FIELD_DEF */ |
|---|
