RootFunctor-derived object for enforcing energy conservation in delta production. More...

Inheritance diagram for G4INCL::InteractionAvatar::ViolationEEnergyFunctor:

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

void	setParticleEnergy (const G4double energy) const
	Set the energy of the particle. More...

	ViolationEEnergyFunctor (Nucleus const nucleus, Particle const aParticle, const G4double totalEnergyBeforeInteraction, const G4bool localE)
	Prepare for calling the () operator and setParticleEnergy. More...

virtual	~ViolationEEnergyFunctor ()

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

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

Private Attributes
G4double	energyThreshold
	Threshold for the energy of the particle. More...

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

const G4bool	shouldUseLocalEnergy
	Whether we should use local energy. More...

G4double	theEnergy
	The initial energy of the particle. More...

ThreeVector	theMomentum
	The initial momentum of the particle. More...

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

Particle *	theParticle
	The final-state particle. More...

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

Detailed Description

RootFunctor-derived object for enforcing energy conservation in delta production.

Definition at line 163 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

◆ ViolationEEnergyFunctor()

G4INCL::InteractionAvatar::ViolationEEnergyFunctor::ViolationEEnergyFunctor	(	Nucleus *const	nucleus,
		Particle *const	aParticle,
		const G4double	totalEnergyBeforeInteraction,
		const G4bool	localE
	)

Prepare for calling the () operator and setParticleEnergy.

The constructor sets the private class members.

Definition at line 484 of file G4INCLInteractionAvatar.cc.

                                                                                                                                                                                         :
    RootFunctor(0., 1E6),
    initialEnergy(totalEnergyBeforeInteraction),
    theNucleus(nucleus),
    theParticle(aParticle),
    theEnergy(theParticle->getEnergy()),
    theMomentum(theParticle->getMomentum()),
    energyThreshold(KinematicsUtils::energy(theMomentum,ParticleTable::minDeltaMass)),
    shouldUseLocalEnergy(localE)
  {
// assert(theParticle->isDelta());
  }

◆ ~ViolationEEnergyFunctor()

virtual G4INCL::InteractionAvatar::ViolationEEnergyFunctor::~ViolationEEnergyFunctor ( )

inlinevirtual

Definition at line 170 of file G4INCLInteractionAvatar.hh.

170{}

Member Function Documentation

◆ cleanUp()

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

virtual

Clean up after root finding.

Implements G4INCL::RootFunctor.

Definition at line 540 of file G4INCLInteractionAvatar.cc.

                                                                                   {
    if(!success)
      setParticleEnergy(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::ViolationEEnergyFunctor::operator() ( const G4double x ) const

virtual

Compute the energy-conservation violation.

Parameters

x	scale factor for the particle energy

Returns: the energy-conservation violation

Implements G4INCL::IFunction1D.

Definition at line 497 of file G4INCLInteractionAvatar.cc.

                                                                                          {
    setParticleEnergy(alpha);
    return theParticle->getEnergy() - theParticle->getPotentialEnergy() - initialEnergy;
  }

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.

◆ setParticleEnergy()

void G4INCL::InteractionAvatar::ViolationEEnergyFunctor::setParticleEnergy ( const G4double energy ) const

Set the energy of the particle.

Parameters

energy

Definition at line 502 of file G4INCLInteractionAvatar.cc.

                                                                                             {
 
    G4double locE;
    if(shouldUseLocalEnergy) {
// assert(theNucleus); // Local energy without a nucleus doesn't make sense
      locE = KinematicsUtils::getLocalEnergy(theNucleus, theParticle); // Initial value of local energy
    } else
      locE = 0.;
    G4double locEOld;
    G4double deltaLocE = InteractionAvatar::locEAccuracy + 1E3;
    for(G4int iterLocE=0;
        deltaLocE>InteractionAvatar::locEAccuracy && iterLocE<InteractionAvatar::maxIterLocE;
        ++iterLocE) {
      locEOld = locE;
      G4double particleEnergy = energyThreshold + locE + alpha*(theEnergy-energyThreshold);
      const G4double theMass2 = std::pow(particleEnergy,2.)-theMomentum.mag2();
      G4double theMass;
      if(theMass2>ParticleTable::minDeltaMass2)
        theMass = std::sqrt(theMass2);
      else {
        theMass = ParticleTable::minDeltaMass;
        particleEnergy = energyThreshold;
      }
      theParticle->setMass(theMass);
      theParticle->setEnergy(particleEnergy); // Update the energy of the particle...
      if(theNucleus) {
        theNucleus->updatePotentialEnergy(theParticle); // ...update its potential energy...
        if(shouldUseLocalEnergy)
          locE = KinematicsUtils::getLocalEnergy(theNucleus, theParticle); // ...and recompute locE.
        else
          locE = 0.;
      } else
        locE = 0.;
      deltaLocE = std::abs(locE-locEOld);
    }
 
  }

References alpha, G4INCL::KinematicsUtils::getLocalEnergy(), G4INCL::InteractionAvatar::locEAccuracy, G4INCL::InteractionAvatar::maxIterLocE, G4INCL::ParticleTable::minDeltaMass, G4INCL::ParticleTable::minDeltaMass2, G4INCL::InteractionAvatar::shouldUseLocalEnergy(), G4INCL::InteractionAvatar::theNucleus, and G4INCL::Nucleus::updatePotentialEnergy().

Field Documentation

◆ energyThreshold

G4double G4INCL::InteractionAvatar::ViolationEEnergyFunctor::energyThreshold

private

Threshold for the energy of the particle.

The particle (a delta) cannot have less than this energy.

Definition at line 203 of file G4INCLInteractionAvatar.hh.

◆ initialEnergy

G4double G4INCL::InteractionAvatar::ViolationEEnergyFunctor::initialEnergy

private

Total energy before the interaction.

Definition at line 190 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().

◆ shouldUseLocalEnergy

const G4bool G4INCL::InteractionAvatar::ViolationEEnergyFunctor::shouldUseLocalEnergy

private

Whether we should use local energy.

Definition at line 205 of file G4INCLInteractionAvatar.hh.

◆ theEnergy

G4double G4INCL::InteractionAvatar::ViolationEEnergyFunctor::theEnergy

private

The initial energy of the particle.

Definition at line 196 of file G4INCLInteractionAvatar.hh.

◆ theMomentum

ThreeVector G4INCL::InteractionAvatar::ViolationEEnergyFunctor::theMomentum

private

The initial momentum of the particle.

Definition at line 198 of file G4INCLInteractionAvatar.hh.

◆ theNucleus

Nucleus* G4INCL::InteractionAvatar::ViolationEEnergyFunctor::theNucleus

private

Pointer to the nucleus.

Definition at line 192 of file G4INCLInteractionAvatar.hh.

◆ theParticle

Particle* G4INCL::InteractionAvatar::ViolationEEnergyFunctor::theParticle

private

The final-state particle.

Definition at line 194 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 Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ManipulatorFunc

Constructor & Destructor Documentation

◆ ViolationEEnergyFunctor()

◆ ~ViolationEEnergyFunctor()

Member Function Documentation

◆ cleanUp()

◆ getXMaximum()

◆ getXMinimum()

◆ integrate()

◆ inverseCDFTable()

◆ operator()()

◆ primitive()

◆ setParticleEnergy()

Field Documentation

◆ energyThreshold

◆ initialEnergy

◆ integrationCoefficients

◆ shouldUseLocalEnergy

◆ theEnergy

◆ theMomentum

◆ theNucleus

◆ theParticle

◆ xMax

◆ xMin