include/Geant4/G4DriverReporter.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 // G4DriverReporter
0027 //
0028 // Class description:
0029 //
0030 // Auxiliary class to print information from integration drivers.
0031 // Can be used by different types of drivers.
0032
0033 // Author: John Apostolakis (CERN), January/March 2020
0034 // -------------------------------------------------------------------
0035 #ifndef G4DRIVERREPORTER_HH
0036 #define G4DRIVERREPORTER_HH
0037
0038 #include "G4FieldTrack.hh"
0039
0040 /**
0041  * @brief G4DriverReporter is an auxiliary utility class to print information
0042  * from integration drivers. It can be used by different types of drivers.
0043  */
0044
0045 class G4DriverReporter
0046 {
0047   public:
0048
0049     static void PrintStatus(const G4double* StartArr,
0050                             G4double xstart,
0051                             const G4double* CurrentArr,
0052                             G4double xcurrent,
0053                             G4double requestStep,
0054                             unsigned int subStepNo,
0055                             unsigned int noIntegrationVariables);
0056
0057     static void PrintStatus(const G4FieldTrack& StartFT,
0058                             const G4FieldTrack& CurrentFT,
0059                             G4double requestStep,
0060                             unsigned int subStepNo);
0061
0062     static void PrintStat_Aux(const G4FieldTrack& aFieldTrack,
0063                               G4double requestStep,
0064                               G4double actualStep,
0065                               G4int subStepNo,
0066                               G4double subStepSize,
0067                               G4double dotVelocities);
0068 };
0069 #endif