include/Geant4/G4DNAMolecularDissociation.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 //
0027 // Author: Mathieu Karamitros
0028
0029 // The code is developed in the framework of the ESA AO7146
0030 //
0031 // We would be very happy hearing from you, send us your feedback! :)
0032 //
0033 // In order for Geant4-DNA to be maintained and still open-source,
0034 // article citations are crucial.
0035 // If you use Geant4-DNA chemistry and you publish papers about your software,
0036 // in addition to the general paper on Geant4-DNA:
0037 //
0038 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0039 //
0040 // we would be very happy if you could please also cite the following
0041 // reference papers on chemistry:
0042 //
0043 // J. Comput. Phys. 274 (2014) 841-882
0044 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0045
0046
0047 #pragma once
0048
0049 #include "G4VITRestDiscreteProcess.hh"
0050 #include <map>
0051
0052 class G4ParticleChange;
0053 class G4VMolecularDissociationDisplacer;
0054 class G4MoleculeDefinition;
0055 class G4VUserBrownianAction;
0056 /**
0057   * G4DNAMolecularDissociation should be called only for molecules.
0058   * It will dissociate the molecules using the decay associated to
0059   * this molecule and if a displacement scheme has been registered,
0060   * it will place the products to the expected position.
0061   */
0062
0063 class G4DNAMolecularDissociation : public G4VITRestDiscreteProcess
0064 {
0065 public:
0066     G4DNAMolecularDissociation(const G4String& processName = "DNAMolecularDecay",
0067                                G4ProcessType type = fDecay);
0068     G4DNAMolecularDissociation() = delete;
0069     G4DNAMolecularDissociation(const G4DNAMolecularDissociation& right) = delete;
0070     G4DNAMolecularDissociation& operator=(const G4DNAMolecularDissociation& right) = delete;
0071     ~G4DNAMolecularDissociation() override;
0072
0073     using Species = const G4MoleculeDefinition;
0074     using Displacer = G4VMolecularDissociationDisplacer;
0075
0076     G4bool IsApplicable(const G4ParticleDefinition&) override;
0077
0078     G4double PostStepGetPhysicalInteractionLength(const G4Track& track,
0079                                                   G4double previousStepSize,
0080                                                   G4ForceCondition* condition) override;
0081
0082     G4double AtRestGetPhysicalInteractionLength(const G4Track& track,
0083                                                 G4ForceCondition* condition) override;
0084
0085     G4VParticleChange* AtRestDoIt(const G4Track& track, const G4Step& step) override;
0086
0087     G4VParticleChange* PostStepDoIt(const G4Track& track, const G4Step& step) override;
0088
0089     void SetVerbose(G4int);
0090
0091     inline void SetUserBrownianAction(G4VUserBrownianAction* pBrownianAction)
0092     {
0093       fpBrownianAction = pBrownianAction;
0094     }
0095
0096     void SetDisplacer(Species*, Displacer*);
0097     Displacer* GetDisplacer(Species*);
0098
0099 protected:
0100     virtual G4VParticleChange* DecayIt(const G4Track&, const G4Step&);
0101
0102     G4double GetMeanLifeTime(const G4Track&, G4ForceCondition*) override;
0103
0104     G4double GetMeanFreePath(const G4Track&,
0105                              G4double,
0106                              G4ForceCondition*) override;
0107
0108 private:
0109     using DisplacementMap = std::map<Species*, std::unique_ptr<Displacer>>;
0110     G4VUserBrownianAction* fpBrownianAction = nullptr;
0111     G4bool fDecayAtFixedTime;
0112     DisplacementMap fDisplacementMap;
0113     G4int fVerbose;
0114 };
0115