include/Geant4/G4MagneticFieldModel.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 //
0027 //
0028 //
0029 // John Allison    17th August 2013
0030 // Michael Kelsey  31st January 2019 -- Move functionality to G4VFieldModel
0031 //
0032 // Class Description:
0033 //
0034 // Model that knows how to draw the magnetic field.
0035
0036 #ifndef G4MAGNETICFIELDMODEL_HH
0037 #define G4MAGNETICFIELDMODEL_HH
0038
0039 #include "G4VFieldModel.hh"
0040
0041
0042 class G4MagneticFieldModel: public G4VFieldModel {
0043 public:         // With description
0044
0045   // Constructor just passes through to base
0046   G4MagneticFieldModel
0047   (G4int nDataPointsPerHalfExtent = 3,
0048    Representation representation = Representation::fullArrow,
0049    G4int arrow3DLineSegmentsPerCircle = 6,
0050    const G4VisExtent& extentForField = G4VisExtent(),
0051    const std::vector<G4PhysicalVolumesSearchScene::Findings>& pvFindings
0052    = std::vector<G4PhysicalVolumesSearchScene::Findings>())
0053   : G4VFieldModel
0054   ("Magnetic","B", extentForField, pvFindings,
0055   nDataPointsPerHalfExtent, representation, arrow3DLineSegmentsPerCircle)
0056   {}
0057
0058   virtual ~G4MagneticFieldModel() {;}
0059
0060 protected:
0061   virtual void GetFieldAtLocation(const G4Field* field,
0062                   const G4Point3D& position, G4double time,
0063                   G4Point3D& result) const;
0064   // The appropriate output from GetFieldValue should be filled into result.
0065   // If (field==0), the function should do nothing; returning without error.
0066
0067 private:
0068   // Private copy contructor and assignment to forbid use...
0069   G4MagneticFieldModel(const G4MagneticFieldModel&);
0070   G4MagneticFieldModel& operator=(const G4MagneticFieldModel&);
0071 };
0072
0073 #endif