include/Geant4/G4QSSubstepStruct.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 // Structs used by G4QSStepper.
0027
0028 // Author: Mattias Portnoy (Univ. Buenos Aires), 2024
0029 // --------------------------------------------------------------------
0030 #ifndef G4QSS_SUBSTEPSTRUCT_HH
0031 #define G4QSS_SUBSTEPSTRUCT_HH
0032
0033 #include "G4FieldTrack.hh"
0034 #include "G4MagIntegratorStepper.hh"
0035 #include "G4qss_misc.hh"
0036
0037 #include <map>
0038 #include <cmath>
0039
0040 constexpr G4int MAX_QSS_ORDER=3;
0041 constexpr G4int NUMBER_OF_VARIABLES_QSS = 6;
0042
0043 typedef G4double QSStateVector[6];
0044
0045 /**
0046  * @brief Structs used by G4QSStepper.
0047  */
0048
0049 struct Substep
0050 {
0051   QSStateVector state_x[MAX_QSS_ORDER+1];
0052   QSStateVector state_q[MAX_QSS_ORDER];
0053   QSStateVector state_tx;
0054   QSStateVector state_tq;
0055   QSStateVector sync_t;
0056   G4double t{0.0};
0057   // simple id method so that substeps can have different orders in same step
0058   G4int extrapolation_method =0;  // To be overwritten in run (expect: 1,2 or 3)
0059   G4double b_field[3] = {0.0, 0.0, 0.0 };
0060
0061   inline Substep();
0062 };
0063
0064 // --------------------------------------------------------------------------------
0065
0066 struct Substeps
0067 {
0068   G4int _arrlength = 30;
0069   Substep* _substeps = nullptr;
0070   G4int current_substep_index = -1;
0071
0072   Substeps();
0073   ~Substeps();
0074
0075   /** Mimics the functionality of GNU method reallocarray. */
0076   void* safe_reallocarray(void* ptr, size_t numMembers, size_t size);
0077
0078   inline void resize();
0079
0080   inline Substep* create_substep();
0081
0082   inline void save_substep(Substep* substep);
0083
0084   inline void reset();
0085
0086 };
0087
0088 #include "G4QSSubstepStruct.icc"
0089
0090 #endif