Class to adjust remnant recoil. More...

Inheritance diagram for G4INCL::INCL::RecoilFunctor:

Public Types
typedef G4double(*const	ManipulatorFunc) (const G4double)
	Typedef to simplify the syntax of inverseCDFTable. More...

Public Member Functions
void	cleanUp (const G4bool success) const
	Clean up after root finding. More...

virtual G4double	getXMaximum () const
	Return the maximum allowed value of the independent variable. More...

virtual G4double	getXMinimum () const
	Return the minimum allowed value of the independent variable. More...

virtual G4double	integrate (const G4double x0, const G4double x1, const G4double step=-1.) const
	Integrate the function between two values. More...

InterpolationTable *	inverseCDFTable (ManipulatorFunc fWrap=0, const G4int nNodes=60) const
	Return a pointer to the inverse of the CDF of this function. More...

G4double	operator() (const G4double x) const
	Compute the energy-conservation violation. More...

IFunction1D *	primitive () const
	Return a pointer to the (numerical) primitive to this function. More...

	RecoilFunctor (Nucleus *const n, const EventInfo &ei)
	Prepare for calling the () operator and scaleParticleEnergies. More...

virtual	~RecoilFunctor ()

Protected Attributes
G4double	xMax
	Maximum value of the independent variable. More...

G4double	xMin
	Minimum value of the independent variable. More...

Private Member Functions
void	scaleParticleEnergies (const G4double rescale) const
	Scale the kinetic energies of the outgoing particles. More...

Private Attributes
Nucleus *	nucleus
	Pointer to the nucleus. More...

ParticleList	outgoingParticles
	List of final-state particles. More...

std::list< G4double >	particleKineticEnergies
	Initial kinetic energies of the outgoing particles. More...

std::list< ThreeVector >	particleMomenta
	Initial momenta of the outgoing particles. More...

EventInfo const &	theEventInfo

Static Private Attributes
static const G4double	integrationCoefficients []
	Coefficients for numerical integration. More...

Detailed Description

Class to adjust remnant recoil.

Definition at line 107 of file G4INCLCascade.hh.

Member Typedef Documentation

◆ ManipulatorFunc

typedef G4double(*const G4INCL::IFunction1D::ManipulatorFunc) (const G4double)

inherited

Typedef to simplify the syntax of inverseCDFTable.

Definition at line 93 of file G4INCLIFunction1D.hh.

Constructor & Destructor Documentation

◆ RecoilFunctor()

G4INCL::INCL::RecoilFunctor::RecoilFunctor	(	Nucleus *const	n,
		const EventInfo &	ei
	)

inline

Prepare for calling the () operator and scaleParticleEnergies.

The constructor sets the private class members.

Definition at line 113 of file G4INCLCascade.hh.

                                                                :
            RootFunctor(0., 1E6),
            nucleus(n),
            outgoingParticles(n->getStore()->getOutgoingParticles()),
            theEventInfo(ei) {
              for(ParticleIter p=outgoingParticles.begin(), e=outgoingParticles.end(); p!=e; ++p) {
                particleMomenta.push_back((*p)->getMomentum());
                particleKineticEnergies.push_back((*p)->getKineticEnergy());
              }
              ProjectileRemnant * const aPR = n->getProjectileRemnant();
              if(aPR && aPR->getA()>0) {
                particleMomenta.push_back(aPR->getMomentum());
                particleKineticEnergies.push_back(aPR->getKineticEnergy());
                outgoingParticles.push_back(aPR);
              }
            }

References G4INCL::Particle::getA(), G4INCL::Particle::getKineticEnergy(), G4INCL::Particle::getMomentum(), CLHEP::detail::n, outgoingParticles, particleKineticEnergies, and particleMomenta.

◆ ~RecoilFunctor()

virtual G4INCL::INCL::RecoilFunctor::~RecoilFunctor ( )

inlinevirtual

Definition at line 129 of file G4INCLCascade.hh.

129{}

Member Function Documentation

◆ cleanUp()

void G4INCL::INCL::RecoilFunctor::cleanUp ( const G4bool success ) const

inlinevirtual

Clean up after root finding.

Implements G4INCL::RootFunctor.

Definition at line 142 of file G4INCLCascade.hh.

                                                   {
            if(!success)
              scaleParticleEnergies(1.);
          }

References scaleParticleEnergies().

◆ getXMaximum()

virtual G4double G4INCL::IFunction1D::getXMaximum ( ) const

inlinevirtualinherited

Return the maximum allowed value of the independent variable.

Definition at line 75 of file G4INCLIFunction1D.hh.

75{ return xMax; }

G4INCL::IFunction1D::xMax

G4double xMax

Maximum value of the independent variable.

Definition: G4INCLIFunction1D.hh:106

References G4INCL::IFunction1D::xMax.

Referenced by G4INCL::IFunction1D::inverseCDFTable(), G4INCL::InvFInterpolationTable::InvFInterpolationTable(), and G4INCL::IFunction1D::primitive().

◆ getXMinimum()

virtual G4double G4INCL::IFunction1D::getXMinimum ( ) const

inlinevirtualinherited

Return the minimum allowed value of the independent variable.

Definition at line 72 of file G4INCLIFunction1D.hh.

72{ return xMin; }

G4INCL::IFunction1D::xMin

G4double xMin

Minimum value of the independent variable.

Definition: G4INCLIFunction1D.hh:104

References G4INCL::IFunction1D::xMin.

Referenced by G4INCL::IFunction1D::inverseCDFTable(), G4INCL::InvFInterpolationTable::InvFInterpolationTable(), and G4INCL::IFunction1D::primitive().

◆ integrate()

G4double G4INCL::IFunction1D::integrate	(	const G4double	x0,
		const G4double	x1,
		const G4double	step = `-1.`
	)		const

virtualinherited

Integrate the function between two values.

Parameters

x0	lower integration bound
x1	upper integration bound
step	largest integration step size; if <0, 45 steps will be used

Returns: $\int_{x_0}^{x_1} f(x) dx$

Definition at line 66 of file G4INCLIFunction1D.cc.

                                                                                                 {
    G4double xi = std::max(x0, xMin);
    G4double xa = std::min(x1, xMax);
    G4double sign;
 
    if(x1 <= x0) {
      sign = -1.0;
      std::swap(xi, xa);
    } else
      sign = 1.0;
 
    const G4double interval = xa - xi;
 
    G4int nIntervals;
    if(step<0.) {
      nIntervals = 45;
    } else {
      nIntervals = G4int(interval/step);
 
      // Round up nIntervals to the closest multiple of 9
      G4int remainder = nIntervals % 9;
      if (remainder != 0)
        nIntervals += 9 - remainder;
 
      nIntervals = std::max(nIntervals, 9);
    }
 
    const G4double dx = interval/nIntervals;
    G4double result = (operator()(xi) + operator()(xa)) * integrationCoefficients[0]/2;
    for(G4int j = 1; j<nIntervals; ++j) {
      const G4double x = xi + interval*G4double(j)/G4double(nIntervals);
      const unsigned index = j%9;
      result += operator()(x) * integrationCoefficients[index];
    }
 
    return result*dx*sign;
 
  }

References G4INCL::IFunction1D::integrationCoefficients, G4INCL::Math::max(), G4INCL::Math::min(), G4INCL::IFunction1D::operator()(), G4INCL::Math::sign(), G4INCL::IFunction1D::xMax, and G4INCL::IFunction1D::xMin.

◆ inverseCDFTable()

InterpolationTable * G4INCL::IFunction1D::inverseCDFTable	(	IFunction1D::ManipulatorFunc	fWrap = `0`,
		const G4int	nNodes = `60`
	)		const

inherited

Return a pointer to the inverse of the CDF of this function.

The function parameter fWrap is wrapped around the return value of operator(). If fWrap=NULL (default), fWrap=identity.

Definition at line 123 of file G4INCLIFunction1D.cc.

                                                                                                             {
    class InverseCDF : public IFunction1D {
      public:
        InverseCDF(IFunction1D const * const f, ManipulatorFunc fw) :
          IFunction1D(f->getXMinimum(), f->getXMaximum()),
          theFunction(f),
          normalisation(1./theFunction->integrate(xMin,xMax)),
          fWrap(fw)
      {}
 
        G4double operator()(const G4double x) const {
          if(fWrap)
            return fWrap(std::min(1., normalisation * theFunction->integrate(xMin,x)));
          else
            return std::min(1., normalisation * theFunction->integrate(xMin,x));
        }
      private:
        IFunction1D const * const theFunction;
        const G4double normalisation;
        ManipulatorFunc fWrap;
    } *theInverseCDF = new InverseCDF(this, fWrap);
 
    InterpolationTable *theTable = new InvFInterpolationTable(*theInverseCDF, nNodes);
    delete theInverseCDF;
    return theTable;
  }

References G4INCL::IFunction1D::getXMaximum(), G4INCL::IFunction1D::getXMinimum(), G4INCL::IFunction1D::IFunction1D(), G4INCL::Math::min(), G4INCL::IFunction1D::operator()(), G4INCL::IFunction1D::xMax, and G4INCL::IFunction1D::xMin.

Referenced by G4INCL::NuclearDensityFactory::createPCDFTable(), G4INCL::NuclearDensityFactory::createRCDFTable(), and G4INCL::NuclearDensityFactory::createRPCorrelationTable().

◆ operator()()

G4double G4INCL::INCL::RecoilFunctor::operator() ( const G4double x ) const

inlinevirtual

Compute the energy-conservation violation.

Parameters

x	scale factor for the particle energies

Returns: the energy-conservation violation

Implements G4INCL::IFunction1D.

Definition at line 136 of file G4INCLCascade.hh.

                                                      {
            scaleParticleEnergies(x);
            return nucleus->getConservationBalance(theEventInfo,true).energy;
          }

References G4INCL::Nucleus::ConservationBalance::energy, G4INCL::Nucleus::getConservationBalance(), nucleus, scaleParticleEnergies(), and theEventInfo.

◆ primitive()

IFunction1D * G4INCL::IFunction1D::primitive ( ) const

inherited

Return a pointer to the (numerical) primitive to this function.

Definition at line 105 of file G4INCLIFunction1D.cc.

                                            {
    class Primitive : public IFunction1D {
      public:
        Primitive(IFunction1D const * const f) :
          IFunction1D(f->getXMinimum(), f->getXMaximum()),
          theFunction(f)
      {}
 
        G4double operator()(const G4double x) const {
          return theFunction->integrate(xMin,x);
        }
      private:
        IFunction1D const * const theFunction;
    } *thePrimitive = new Primitive(this);
 
    return thePrimitive;
  }

References G4INCL::IFunction1D::getXMaximum(), G4INCL::IFunction1D::getXMinimum(), G4INCL::IFunction1D::IFunction1D(), G4INCL::IFunction1D::operator()(), Primitive, and G4INCL::IFunction1D::xMin.

◆ scaleParticleEnergies()

void G4INCL::INCL::RecoilFunctor::scaleParticleEnergies ( const G4double rescale ) const

inlineprivate

Scale the kinetic energies of the outgoing particles.

Parameters

rescale scale factor

Definition at line 163 of file G4INCLCascade.hh.

                                                                   {
            // Rescale the energies (and the momenta) of the outgoing particles.
            ThreeVector pBalance = nucleus->getIncomingMomentum();
            std::list<ThreeVector>::const_iterator iP = particleMomenta.begin();
            std::list<G4double>::const_iterator iE = particleKineticEnergies.begin();
            for( ParticleIter i = outgoingParticles.begin(), e = outgoingParticles.end(); i!=e; ++i, ++iP, ++iE)
            {
              const G4double mass = (*i)->getMass();
              const G4double newKineticEnergy = (*iE) * rescale;
 
              (*i)->setMomentum(*iP);
              (*i)->setEnergy(mass + newKineticEnergy);
              (*i)->adjustMomentumFromEnergy();
 
              pBalance -= (*i)->getMomentum();
            }
 
            nucleus->setMomentum(pBalance);
            const G4double remnantMass = ParticleTable::getTableMass(nucleus->getA(),nucleus->getZ(),nucleus->getS()) + nucleus->getExcitationEnergy();
            const G4double pRem2 = pBalance.mag2();
            const G4double recoilEnergy = pRem2/
              (std::sqrt(pRem2+remnantMass*remnantMass) + remnantMass);
            nucleus->setEnergy(remnantMass + recoilEnergy);
          }

References G4INCL::Particle::getA(), G4INCL::Nucleus::getExcitationEnergy(), G4INCL::Nucleus::getIncomingMomentum(), G4INCL::Particle::getS(), G4INCL::ParticleTable::getTableMass, G4INCL::Particle::getZ(), G4INCL::ThreeVector::mag2(), nucleus, outgoingParticles, particleKineticEnergies, particleMomenta, G4INCL::Particle::setEnergy(), and G4INCL::Particle::setMomentum().

Referenced by cleanUp(), and operator()().

Field Documentation

◆ integrationCoefficients

const G4double G4INCL::IFunction1D::integrationCoefficients

staticprivateinherited

Initial value:

= {
*95.0/288.0,
0/240.0,
0/30.0,
0/720.0,
0/160.0,
0/160.0,
0/720.0,
0/30.0,
0/240.0,
  }

Coefficients for numerical integration.

Definition at line 110 of file G4INCLIFunction1D.hh.

Referenced by G4INCL::IFunction1D::integrate().

◆ nucleus

Nucleus* G4INCL::INCL::RecoilFunctor::nucleus

private

Pointer to the nucleus.

Definition at line 149 of file G4INCLCascade.hh.

Referenced by operator()(), and scaleParticleEnergies().

◆ outgoingParticles

ParticleList G4INCL::INCL::RecoilFunctor::outgoingParticles

private

List of final-state particles.

Definition at line 151 of file G4INCLCascade.hh.

Referenced by RecoilFunctor(), and scaleParticleEnergies().

◆ particleKineticEnergies

std::list<G4double> G4INCL::INCL::RecoilFunctor::particleKineticEnergies

private

Initial kinetic energies of the outgoing particles.

Definition at line 157 of file G4INCLCascade.hh.

Referenced by RecoilFunctor(), and scaleParticleEnergies().

◆ particleMomenta

std::list<ThreeVector> G4INCL::INCL::RecoilFunctor::particleMomenta

private

Initial momenta of the outgoing particles.

Definition at line 155 of file G4INCLCascade.hh.

Referenced by RecoilFunctor(), and scaleParticleEnergies().

◆ theEventInfo

EventInfo const& G4INCL::INCL::RecoilFunctor::theEventInfo

private

Definition at line 153 of file G4INCLCascade.hh.

Referenced by operator()().

◆ xMax

G4double G4INCL::IFunction1D::xMax

protectedinherited

Maximum value of the independent variable.

Definition at line 106 of file G4INCLIFunction1D.hh.

Referenced by G4INCL::IFunction1D::getXMaximum(), G4INCL::IFunction1D::integrate(), and G4INCL::IFunction1D::inverseCDFTable().

◆ xMin

G4double G4INCL::IFunction1D::xMin

protectedinherited

Minimum value of the independent variable.

Definition at line 104 of file G4INCLIFunction1D.hh.

Referenced by G4INCL::IFunction1D::getXMinimum(), G4INCL::IFunction1D::integrate(), G4INCL::IFunction1D::inverseCDFTable(), and G4INCL::IFunction1D::primitive().

The documentation for this class was generated from the following file:

source/processes/hadronic/models/inclxx/incl_physics/include/G4INCLCascade.hh

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ManipulatorFunc

Constructor & Destructor Documentation

◆ RecoilFunctor()

◆ ~RecoilFunctor()

Member Function Documentation

◆ cleanUp()

◆ getXMaximum()

◆ getXMinimum()

◆ integrate()

◆ inverseCDFTable()

◆ operator()()

◆ primitive()

◆ scaleParticleEnergies()

Field Documentation

◆ integrationCoefficients

◆ nucleus

◆ outgoingParticles

◆ particleKineticEnergies

◆ particleMomenta

◆ theEventInfo

◆ xMax

◆ xMin