include/Geant4/G4MolecularDissociationTable.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 // Contact: Mathieu Karamitros (kara (AT) cenbg . in2p3 . fr)
0027 //
0028 // WARNING : This class is released as a prototype.
0029 // It might strongly evolve or even disapear in the next releases.
0030 //
0031 // The code is developed in the framework of the ESA AO7146
0032 //
0033 // We would be very happy hearing from you, send us your feedback! :)
0034 //
0035 // In order for Geant4-DNA to be maintained and still open-source,
0036 // article citations are crucial.
0037 // If you use Geant4-DNA chemistry and you publish papers about your software,
0038 // in addition to the general paper on Geant4-DNA:
0039 //
0040 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0041 //
0042 // we ask that you please cite the following reference papers on chemistry:
0043 //
0044 // J. Comput. Phys. 274 (2014) 841-882
0045 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0046 //
0047 // ----------------------------------------------------------------
0048 //      GEANT 4 class header file
0049 //
0050 //      History: first implementation, Alfonso Mantero 4 Mar 2009
0051 // ----------------------------------------------------------------
0052 //
0053
0054 #ifndef G4MolecularDecayTable_h
0055 #define G4MolecularDecayTable_h 1
0056
0057 #include <map>
0058 #include <vector>
0059 #include "globals.hh"
0060
0061 class G4MolecularDissociationChannel;
0062 class G4MolecularConfiguration;
0063
0064 //______________________________________________________________________________
0065
0066 namespace G4DNA
0067 {
0068 using ChannelMap = std::map<const G4MolecularConfiguration *, std::vector<const G4MolecularDissociationChannel *>>;
0069 }
0070 //______________________________________________________________________________
0071
0072 /** Class Description
0073  *  G4MolecularDecayTable operates as a container of deexcitation modes
0074  *  for excited or ionized molecules
0075  */
0076
0077 class G4MolecularDissociationTable
0078 {
0079
0080 public:
0081
0082   G4MolecularDissociationTable();
0083   ~G4MolecularDissociationTable();
0084   G4MolecularDissociationTable(const G4MolecularDissociationTable&);
0085   G4MolecularDissociationTable & operator=(const G4MolecularDissociationTable &right);
0086
0087 public:
0088
0089   //____________________________________________________________________________
0090   // Create the table
0091   // methods to construct the table "interactively"
0092
0093   void AddChannel(const G4MolecularConfiguration* molConf,
0094                   const G4MolecularDissociationChannel* channel);
0095
0096   void CheckDataConsistency() const;
0097   // Checks that probabilities sum up to 100% for each excited state
0098
0099   //____________________________________________________________________________
0100   // Get methods to retrieve data
0101
0102   const std::vector<const G4MolecularDissociationChannel*>*
0103     GetDecayChannels(const G4MolecularConfiguration*) const;
0104   const std::vector<const G4MolecularDissociationChannel*>*
0105     GetDecayChannels(const G4String& excitedStateLabel) const;
0106
0107   void Serialize(std::ostream&);
0108
0109 private:
0110   G4DNA::ChannelMap fDissociationChannels;
0111 };
0112
0113 #endif
0114