#include <G4INCLIFunction1D.hh>

Inheritance diagram for G4INCL::IFunction1D:

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

Public Member Functions
	IFunction1D ()

	IFunction1D (const G4double x0, const G4double x1)

virtual	~IFunction1D ()

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

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

virtual G4double	operator() (const G4double x) const =0
	Compute the value of the function.

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

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

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

Protected Attributes
G4double	xMin
	Minimum value of the independent variable.

G4double	xMax
	Maximum value of the independent variable.

Detailed Description

1D function interface

Definition at line 58 of file G4INCLIFunction1D.hh.

Member Typedef Documentation

◆ ManipulatorFunc

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

Typedef to simplify the syntax of inverseCDFTable.

Definition at line 93 of file G4INCLIFunction1D.hh.

Constructor & Destructor Documentation

◆ IFunction1D() [1/2]

G4INCL::IFunction1D::IFunction1D ( )

inline

Definition at line 60 of file G4INCLIFunction1D.hh.

                    :
        xMin(0.),
        xMax(0.)
    {};

◆ IFunction1D() [2/2]

G4INCL::IFunction1D::IFunction1D	(	const G4double	x0,
		const G4double	x1 )

inline

Definition at line 64 of file G4INCLIFunction1D.hh.

◆ ~IFunction1D()

virtual G4INCL::IFunction1D::~IFunction1D ( )

inlinevirtual

Definition at line 69 of file G4INCLIFunction1D.hh.

69{};

Member Function Documentation

◆ getXMaximum()

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

inlinevirtual

Return the maximum allowed value of the independent variable.

Definition at line 75 of file G4INCLIFunction1D.hh.

75{ return xMax; }

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

◆ getXMinimum()

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

inlinevirtual

Return the minimum allowed value of the independent variable.

Definition at line 72 of file G4INCLIFunction1D.hh.

72{ return xMin; }

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

◆ integrate()

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

virtual

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;
 
  }

Referenced by primitive().

◆ inverseCDFTable()

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

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;
  }

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

◆ operator()()

virtual G4double G4INCL::IFunction1D::operator() ( const G4double x ) const

pure virtual

Compute the value of the function.

Implemented in G4INCL::InterpolationTable, G4INCL::NuclearDensityFunctions::Gaussian, G4INCL::NuclearDensityFunctions::GaussianRP, G4INCL::NuclearDensityFunctions::HardSphere, G4INCL::NuclearDensityFunctions::ModifiedHarmonicOscillator, G4INCL::NuclearDensityFunctions::ModifiedHarmonicOscillatorRP, G4INCL::NuclearDensityFunctions::ParisP, G4INCL::NuclearDensityFunctions::ParisR, G4INCL::NuclearDensityFunctions::WoodsSaxon, and G4INCL::NuclearDensityFunctions::WoodsSaxonRP.

Referenced by integrate().

◆ primitive()

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

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;
  }

Member Data Documentation

◆ xMax

G4double G4INCL::IFunction1D::xMax

protected

Maximum value of the independent variable.

Definition at line 106 of file G4INCLIFunction1D.hh.

Referenced by getXMaximum(), and integrate().

◆ xMin

G4double G4INCL::IFunction1D::xMin

protected

Minimum value of the independent variable.

Definition at line 104 of file G4INCLIFunction1D.hh.

Referenced by getXMinimum(), and integrate().

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ManipulatorFunc

Constructor & Destructor Documentation

◆ IFunction1D() [1/2]

◆ IFunction1D() [2/2]

◆ ~IFunction1D()

Member Function Documentation

◆ getXMaximum()

◆ getXMinimum()

◆ integrate()

◆ inverseCDFTable()

◆ operator()()

◆ primitive()

Member Data Documentation

◆ xMax

◆ xMin