Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/magneticfield/include/G4CachedMagneticField.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

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