G4ITReactionChange.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
// Author: Mathieu Karamitros
 
// The code is developed in the framework of the ESA AO7146
//
// We would be very happy hearing from you, send us your feedback! :)
//
// In order for Geant4-DNA to be maintained and still open-source,
// article citations are crucial. 
// If you use Geant4-DNA chemistry and you publish papers about your software, 
// in addition to the general paper on Geant4-DNA:
//
// Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
//
// we would be very happy if you could please also cite the following
// reference papers on chemistry:
//
// J. Comput. Phys. 274 (2014) 841-882
// Prog. Nucl. Sci. Tec. 2 (2011) 503-508 
 
#ifndef G4ITReactionChange_H
#define G4ITReactionChange_H
 
#include "globals.hh"
#include "G4ParticleChange.hh"
#include <vector>
 
/**
 * Similar to G4ParticleChange, but deal with two tracks
 * rather than one.
 */
 
class G4ITReactionChange
{
public:
  /** Default constructor */
  G4ITReactionChange();
  /** Default destructor */
  virtual ~G4ITReactionChange();
 
  //_____________________________________________________
  // To be used by reaction processes
  void Initialize(const G4Track&,
                  const G4Track&,
                  G4VParticleChange* particleChangeA = nullptr,
                  G4VParticleChange* particleChangeB = nullptr);
  void AddSecondary(G4Track* aSecondary);
  inline void KillParents(G4bool);
 
  // If both parents are not killed therefore
  // we can used the particle change
  // you will have to give the pointers
  // of your particleChange while initializing
  // but it might tell you that energy is not
  // conserved for instance
  G4VParticleChange* GetParticleChange(const G4Track*);
 
  //_____________________________________________________
  // Not to be used in reaction processes
  void UpdateStepInfo(G4Step*, G4Step*);
  G4Track* GetSecondary(G4int) const;
  std::vector<G4Track*>* GetfSecondary();
 
  G4int GetNumberOfSecondaries() const;
  G4bool WereParentsKilled() const;
 
  const G4Track* GetTrackA();
  const G4Track* GetTrackB();
 
protected:
  /** Copy constructor
   *  \param other Object to copy from
   */
  G4ITReactionChange(const G4ITReactionChange& other);
  /** Assignment operator
   *  \param other Object to assign from
   *  \return A reference to this
   */
  G4ITReactionChange& operator=(const G4ITReactionChange& other);
  // equal/unequal operator
  G4bool operator==(const G4ITReactionChange &right) const;
  G4bool operator!=(const G4ITReactionChange &right) const;
  // "equal" means that the objects have the same pointer.
protected:
  std::map<const G4Track*, G4VParticleChange*> fParticleChange;
  std::vector<G4Track*>* fSecondaries{nullptr};
  G4int fNumberOfSecondaries{0};
  G4bool fKillParents{false};
  G4bool fParticleChangeIsSet{false};
};
 
inline G4Track* G4ITReactionChange::GetSecondary(G4int anIndex) const
{
  if (fSecondaries != nullptr) return (*fSecondaries)[anIndex];
  return nullptr;
}
 
inline G4int G4ITReactionChange::GetNumberOfSecondaries() const
{
  return fNumberOfSecondaries;
}
 
inline void G4ITReactionChange::KillParents(G4bool kill)
{
  fKillParents = kill;
}
 
inline G4bool G4ITReactionChange::WereParentsKilled() const
{
  return fKillParents;
}
 
inline std::vector<G4Track*>* G4ITReactionChange::GetfSecondary()
{
  return fSecondaries;
}
 
#endif // G4ITReactionChange_H