Import Geant4 11.4.0 source tree

source/geometry/magneticfield/include/G4MagneticField.hh

@@ -29,7 +29,7 @@
 //
 // Magnetic Field abstract class, implements inquiry function interface.
 
-// Created: J.Apostolakis, CERN - 13.01.1996
+// Author: John Apostolakis (CERN), 13.01.1996
 // --------------------------------------------------------------------
 #ifndef G4MAGNETIC_FIELD_HH
 #define G4MAGNETIC_FIELD_HH
@@ -41,19 +41,37 @@ class G4MagneticField : public G4Field
 {
   public:
 
+    /**
+     * Default Constructor and Destructor.
+     */
     G4MagneticField();
-   ~G4MagneticField() override;
-      // Constructor and destructor. No actions.
+    ~G4MagneticField() override = default;
 
+    /**
+     * Copy constructor and assignment operator.
+     */
     G4MagneticField(const G4MagneticField& r);
     G4MagneticField& operator= (const G4MagneticField& p);
-      // Copy constructor & assignment operator.
 
+    /**
+     * Since a pure magnetic field does not change track energy, returns false.
+     */
     inline G4bool DoesFieldChangeEnergy() const override { return false; }
-      // Since a pure magnetic field does not change track energy
 
+    /**
+     * Given the position time vector 'Point', returns the value of the
+     * field in the array 'Bfield'.
+     *  @param[in] Point The position time vector.
+     *  @param[out] Bfield The field array in output.
+     */
     void GetFieldValue( const G4double Point[4],
                               G4double* Bfield ) const override = 0;
+
+    /**
+     * Returns the field type-ID, "kMagnetic".
+     * This should be overriden in derived classes.
+     */
+    inline G4FieldType GetFieldType() const override { return kMagnetic; }
 };
 
 #endif