RootFunctor-derived object for enforcing energy conservation in N-N. More...

Inheritance diagram for G4INCL::InteractionAvatar::ViolationEMomentumFunctor:

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...

	ViolationEMomentumFunctor (Nucleus *const nucleus, ParticleList const &modAndCre, const G4double totalEnergyBeforeInteraction, ThreeVector const &boost, const G4bool localE)
	Prepare for calling the () operator and scaleParticleMomenta. More...

virtual	~ViolationEMomentumFunctor ()

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

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

Private Member Functions
void	scaleParticleMomenta (const G4double alpha) const
	Scale the momenta of the modified and created particles. More...

Private Attributes
ThreeVector const &	boostVector
	Pointer to the boost vector. More...

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

G4double	initialEnergy
	Total energy before the interaction. More...

std::vector< ThreeVector >	particleMomenta
	CM particle momenta, as determined by the channel. More...

const G4bool	shouldUseLocalEnergy
	True if we should use local energy. More...

Nucleus *	theNucleus
	Pointer to the nucleus. More...

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

Detailed Description

RootFunctor-derived object for enforcing energy conservation in N-N.

Definition at line 116 of file G4INCLInteractionAvatar.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

◆ ViolationEMomentumFunctor()

G4INCL::InteractionAvatar::ViolationEMomentumFunctor::ViolationEMomentumFunctor	(	Nucleus *const	nucleus,
		ParticleList const &	modAndCre,
		const G4double	totalEnergyBeforeInteraction,
		ThreeVector const &	boost,
		const G4bool	localE
	)

Prepare for calling the () operator and scaleParticleMomenta.

The constructor sets the private class members.

Definition at line 391 of file G4INCLInteractionAvatar.cc.

                                                                                                                                                                                                                          :
    RootFunctor(0., 1E6),
    finalParticles(modAndCre),
    initialEnergy(totalEnergyBeforeInteraction),
    theNucleus(nucleus),
    boostVector(boost),
    shouldUseLocalEnergy(localE)
  {
    // Store the particle momenta (necessary for the calls to
    // scaleParticleMomenta() to work)
    for(ParticleIter i=finalParticles.begin(), e=finalParticles.end(); i!=e; ++i) {
      (*i)->boost(boostVector);
      particleMomenta.push_back((*i)->getMomentum());
    }
  }

References boostVector, finalParticles, and particleMomenta.

◆ ~ViolationEMomentumFunctor()

G4INCL::InteractionAvatar::ViolationEMomentumFunctor::~ViolationEMomentumFunctor ( )

virtual

Definition at line 407 of file G4INCLInteractionAvatar.cc.

                                                                         {
    particleMomenta.clear();
  }

Member Function Documentation

◆ cleanUp()

void G4INCL::InteractionAvatar::ViolationEMomentumFunctor::cleanUp ( const G4bool success ) const

virtual

Clean up after root finding.

Implements G4INCL::RootFunctor.

Definition at line 475 of file G4INCLInteractionAvatar.cc.

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

◆ 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::InteractionAvatar::ViolationEMomentumFunctor::operator() ( const G4double x ) const

virtual

Compute the energy-conservation violation.

Parameters

x	scale factor for the particle momenta

Returns: the energy-conservation violation

Implements G4INCL::IFunction1D.

Definition at line 411 of file G4INCLInteractionAvatar.cc.

                                                                                            {
    scaleParticleMomenta(alpha);
 
    G4double deltaE = 0.0;
    for(ParticleIter i=finalParticles.begin(), e=finalParticles.end(); i!=e; ++i)
      deltaE += (*i)->getEnergy() - (*i)->getPotentialEnergy();
    deltaE -= initialEnergy;
    return deltaE;
  }

References alpha.

◆ 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.

◆ scaleParticleMomenta()

void G4INCL::InteractionAvatar::ViolationEMomentumFunctor::scaleParticleMomenta ( const G4double alpha ) const

private

Scale the momenta of the modified and created particles.

Set the momenta of the modified and created particles to alpha times their original momenta (stored in particleMomenta). You must call init() before using this method.

Parameters

alpha scale factor

Definition at line 421 of file G4INCLInteractionAvatar.cc.

                                                                                                  {
 
    std::vector<ThreeVector>::const_iterator iP = particleMomenta.begin();
    for(ParticleIter i=finalParticles.begin(), e=finalParticles.end(); i!=e; ++i, ++iP) {
      (*i)->setMomentum((*iP)*alpha);
      (*i)->adjustEnergyFromMomentum();
      (*i)->rpCorrelate();
      (*i)->boost(-boostVector);
      if(theNucleus){
        theNucleus->updatePotentialEnergy(*i);
      } else {
        (*i)->setPotentialEnergy(0.);
      }
//jcd      if(shouldUseLocalEnergy && !(*i)->isPion()) { // This translates AECSVT's loops 1, 3 and 4
        if(shouldUseLocalEnergy && !(*i)->isPion() && !(*i)->isEta() && !(*i)->isOmega() &&
           !(*i)->isKaon() && !(*i)->isAntiKaon()  && !(*i)->isSigma() && !(*i)->isLambda()) { // This translates AECSVT's loops 1, 3 and 4
// assert(theNucleus); // Local energy without a nucleus doesn't make sense
         const G4double energy = (*i)->getEnergy(); // Store the energy of the particle
         G4double locE = KinematicsUtils::getLocalEnergy(theNucleus, *i); // Initial value of local energy
         G4double locEOld;
         G4double deltaLocE = InteractionAvatar::locEAccuracy + 1E3;
         for(G4int iterLocE=0;
            deltaLocE>InteractionAvatar::locEAccuracy && iterLocE<InteractionAvatar::maxIterLocE;
            ++iterLocE) {
          locEOld = locE;
          (*i)->setEnergy(energy + locE); // Update the energy of the particle...
          (*i)->adjustMomentumFromEnergy();
          theNucleus->updatePotentialEnergy(*i); // ...update its potential energy...
          locE = KinematicsUtils::getLocalEnergy(theNucleus, *i); // ...and recompute locE.
          deltaLocE = std::abs(locE-locEOld);
         }
        }
 
//jlrs  For lambdas and nuclei with masses higher than 19 also local energy
        if(shouldUseLocalEnergy && (*i)->isLambda() && theNucleus->getA()>19) {
// assert(theNucleus); // Local energy without a nucleus doesn't make sense
         const G4double energy = (*i)->getEnergy(); // Store the energy of the particle
         G4double locE = KinematicsUtils::getLocalEnergy(theNucleus, *i); // Initial value of local energy
         G4double locEOld;
         G4double deltaLocE = InteractionAvatar::locEAccuracy + 1E3;
         for(G4int iterLocE=0;
            deltaLocE>InteractionAvatar::locEAccuracy && iterLocE<InteractionAvatar::maxIterLocE;
            ++iterLocE) {
          locEOld = locE;
          (*i)->setEnergy(energy + locE); // Update the energy of the particle...
          (*i)->adjustMomentumFromEnergy();
          theNucleus->updatePotentialEnergy(*i); // ...update its potential energy...
          locE = KinematicsUtils::getLocalEnergy(theNucleus, *i); // ...and recompute locE.
          deltaLocE = std::abs(locE-locEOld);
         }
        }
    }
  }

References alpha, G4INCL::InteractionAvatar::boostVector, G4INCL::KinematicsUtils::energy(), G4INCL::Particle::getA(), G4INCL::KinematicsUtils::getLocalEnergy(), G4INCL::InteractionAvatar::locEAccuracy, G4INCL::InteractionAvatar::maxIterLocE, G4INCL::InteractionAvatar::shouldUseLocalEnergy(), G4INCL::InteractionAvatar::theNucleus, and G4INCL::Nucleus::updatePotentialEnergy().

Field Documentation

◆ boostVector

ThreeVector const& G4INCL::InteractionAvatar::ViolationEMomentumFunctor::boostVector

private

Pointer to the boost vector.

Definition at line 145 of file G4INCLInteractionAvatar.hh.

Referenced by ViolationEMomentumFunctor().

◆ finalParticles

ParticleList G4INCL::InteractionAvatar::ViolationEMomentumFunctor::finalParticles

private

List of final-state particles.

Definition at line 137 of file G4INCLInteractionAvatar.hh.

Referenced by ViolationEMomentumFunctor().

◆ initialEnergy

G4double G4INCL::InteractionAvatar::ViolationEMomentumFunctor::initialEnergy

private

Total energy before the interaction.

Definition at line 141 of file G4INCLInteractionAvatar.hh.

◆ 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().

◆ particleMomenta

std::vector<ThreeVector> G4INCL::InteractionAvatar::ViolationEMomentumFunctor::particleMomenta

private

CM particle momenta, as determined by the channel.

Definition at line 139 of file G4INCLInteractionAvatar.hh.

Referenced by ViolationEMomentumFunctor().

◆ shouldUseLocalEnergy

const G4bool G4INCL::InteractionAvatar::ViolationEMomentumFunctor::shouldUseLocalEnergy

private

True if we should use local energy.

Definition at line 148 of file G4INCLInteractionAvatar.hh.

◆ theNucleus

Nucleus* G4INCL::InteractionAvatar::ViolationEMomentumFunctor::theNucleus

private

Pointer to the nucleus.

Definition at line 143 of file G4INCLInteractionAvatar.hh.

◆ 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 files:

source/processes/hadronic/models/inclxx/incl_physics/include/G4INCLInteractionAvatar.hh
source/processes/hadronic/models/inclxx/incl_physics/src/G4INCLInteractionAvatar.cc

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ManipulatorFunc

Constructor & Destructor Documentation

◆ ViolationEMomentumFunctor()

◆ ~ViolationEMomentumFunctor()

Member Function Documentation

◆ cleanUp()

◆ getXMaximum()

◆ getXMinimum()

◆ integrate()

◆ inverseCDFTable()

◆ operator()()

◆ primitive()

◆ scaleParticleMomenta()

Field Documentation

◆ boostVector

◆ finalParticles

◆ initialEnergy

◆ integrationCoefficients

◆ particleMomenta

◆ shouldUseLocalEnergy

◆ theNucleus

◆ xMax

◆ xMin