geant4/source/processes/hadronic/models/cascade/cascade/include/G4InuclParticle.hh

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// $Id: G4InuclParticle.hh 66241 2012-12-13 18:34:42Z gunter $
//
// 20100112  M. Kelsey -- Remove G4CascadeMomentum, use G4LorentzVector directly
// 20100409  M. Kelsey -- Drop unused string argument from ctors.
// 20100519  M. Kelsey -- Add public access to G4DynamicParticle content
// 20100715  M. Kelsey -- Add setKineticEnergy() function
// 20100915  M. Kelsey -- Add constructor to copy G4DynamicParticle input
// 20110214  M. Kelsey -- Replace integer "model" with enum
// 20110225  M. Kelsey -- Add equality operator (NOT sorting!)
// 20110721  M. Kelsey -- Add model ID as optional ctor argument (so subclasses
//		don't have to call SetModel()).
// 20110917  M. Kelsey -- Add coalesence to model ID list
// 20110919  M. Kelsey -- Move setDefinition code to .cc to allow null argument
// 20110922  M. Kelsey -- Add stream argument to printParticle() => print(),
//		add operator<<().
// 20140310  M. Kelsey -- Fix constness in G4PD* passing

#ifndef G4INUCL_PARTICLE_HH
#define G4INUCL_PARTICLE_HH

#include <iosfwd>
#include <CLHEP/Units/SystemOfUnits.h>

#include "globals.hh"
#include "G4LorentzVector.hh"
#include "G4DynamicParticle.hh"

class G4InuclParticle {
public:
  // used to indicate model that created instance of G4InuclParticle
  // 0 default
  // 1 bullet
  // 2 target
  // 3 G4ElementaryParticleCollider
  // 4 G4IntraNucleiCascader
  // 5 G4NonEquilibriumEvaporator
  // 6 G4EquilibriumEvaporator
  // 7 G4Fissioner
  // 8 G4BigBanger
  // 9 G4PreCompound
  // 10 G4CascadeCoalescence
  enum Model { DefaultModel, bullet, target, EPCollider, INCascader,
	       NonEquilib, Equilib, Fissioner, BigBanger, PreCompound,
	       Coalescence };

public:
  G4InuclParticle() : modelId(DefaultModel) {}

  G4InuclParticle(const G4DynamicParticle& dynPart, Model model=DefaultModel)
    : pDP(dynPart), modelId(model) {}

  G4InuclParticle(const G4LorentzVector& mom, Model model=DefaultModel)
    : modelId(model) { pDP.Set4Momentum(mom*CLHEP::GeV/CLHEP::MeV); }	// Bertini to G4 units

  virtual ~G4InuclParticle() {}

  // Copy and assignment constructors for use with std::vector<>
  G4InuclParticle(const G4InuclParticle& right)
    : pDP(right.pDP), modelId(right.modelId) {}

  G4InuclParticle& operator=(const G4InuclParticle& right);

  // Equality (comparison) operator -- NOT SORTING
  bool operator==(const G4InuclParticle& right) {
    return ( (&right == this) || (pDP == right.pDP) );	// Ignore model code
  }

  bool operator!=(const G4InuclParticle& right) {
    return !operator==(right);
  }

  // This is no longer required, as setMomentum() handles mass adjustment
  void setEnergy() { ; }

  // These are call-throughs to G4DynamicParticle
  void setMomentum(const G4LorentzVector& mom);

  void setKineticEnergy(G4double ekin) { pDP.SetKineticEnergy(ekin*CLHEP::GeV/CLHEP::MeV); }

  void setMass(G4double mass) { pDP.SetMass(mass*CLHEP::GeV/CLHEP::MeV); }

  G4double getMass() const {
    return pDP.GetMass()*CLHEP::MeV/CLHEP::GeV;	// From G4 to Bertini units
  }

  G4double getCharge() const {
    return pDP.GetCharge();
  }

  G4double getKineticEnergy() const {
    return pDP.GetKineticEnergy()*CLHEP::MeV/CLHEP::GeV; // From G4 to Bertini units
  }

  G4double getEnergy() const {
    return pDP.GetTotalEnergy()*CLHEP::MeV/CLHEP::GeV; // From G4 to Bertini units
  }

  G4double getMomModule() const {
    return pDP.GetTotalMomentum()*CLHEP::MeV/CLHEP::GeV; // From G4 to Bertini units
  }

  G4LorentzVector getMomentum() const {
    return pDP.Get4Momentum()*CLHEP::MeV/CLHEP::GeV; // From G4 to Bertini units
  }

  virtual void print(std::ostream& os) const;

  const G4ParticleDefinition* getDefinition() const {
    return pDP.GetDefinition();
  }

  const G4DynamicParticle& getDynamicParticle() const {
    return pDP;
  }

public:
  void setModel(Model model) { modelId = model; }
  Model getModel() const { return modelId; }

protected: 
  //  Special constructors for subclasses to set particle type correctly
  explicit G4InuclParticle(const G4ParticleDefinition* pd,
			   Model model=DefaultModel)
    : modelId(model) { setDefinition(pd); }

  // FIXME: Bertini code doesn't pass valid 4-vectors, so force mass value
  //	    from supplied PartDefn, with required unit conversions
  G4InuclParticle(const G4ParticleDefinition* pd, const G4LorentzVector& mom,
		  Model model=DefaultModel);

  // NOTE:  Momentum forced along Z direction
  G4InuclParticle(const G4ParticleDefinition* pd, G4double ekin,
		  Model model=DefaultModel)
    : pDP(pd,G4ThreeVector(0.,0.,1.),ekin*CLHEP::GeV/CLHEP::MeV), modelId(model) {}

  void setDefinition(const G4ParticleDefinition* pd);

private:
  G4DynamicParticle pDP;		// Carries all the kinematics and info
  Model modelId;
};        

// Proper stream output (just calls print())

std::ostream& operator<<(std::ostream& os, const G4InuclParticle& part);

#endif // G4INUCL_PARTICLE_HH