PARTONS/NumA++  
Numerical Analysis C++ routines
Public Member Functions | Protected Member Functions | List of all members
NumA::TrapezoidalLogIntegrator1D Class Reference

Trapezoidal integration with logarithmic step. More...

Inheritance diagram for NumA::TrapezoidalLogIntegrator1D:
NumA::QuadratureIntegrator1D NumA::Integrator1D

Public Member Functions

 TrapezoidalLogIntegrator1D (unsigned int N=40)
 Constructor. More...
 
virtual ~TrapezoidalLogIntegrator1D ()
 Default destructor. More...
 
virtual TrapezoidalLogIntegrator1Dclone () const
 
virtual void configure (const ElemUtils::Parameters &parameters)
 Provides a generic method to configure all types of integrations by passing a Parameters object. More...
 
virtual void setN (unsigned int n)
 
virtual double integrate (FunctionType1D *pFunction, double a, double b, std::vector< double > &parameters)
 Integration routine. More...
 
- Public Member Functions inherited from NumA::QuadratureIntegrator1D
 QuadratureIntegrator1D (unsigned int N=0)
 Constructor. More...
 
virtual ~QuadratureIntegrator1D ()
 Default destructor. More...
 
unsigned int getN () const
 
const std::vector< double > & getNodes () const
 
const std::vector< double > & getWeights () const
 
- Public Member Functions inherited from NumA::Integrator1D
 Integrator1D ()
 Default constructor. More...
 
virtual ~Integrator1D ()
 Default destructor. More...
 
const TolerancesgetTolerances () const
 
void setTolerances (const Tolerances &tolerances)
 
const ErrorsgetErrors () const
 
void setErrors (const Errors &errors)
 

Protected Member Functions

 TrapezoidalLogIntegrator1D (const TrapezoidalLogIntegrator1D &other)
 Copy constructor. More...
 
- Protected Member Functions inherited from NumA::QuadratureIntegrator1D
 QuadratureIntegrator1D (const QuadratureIntegrator1D &other)
 Copy constructor. More...
 
- Protected Member Functions inherited from NumA::Integrator1D
 Integrator1D (const Integrator1D &other)
 Copy constructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from NumA::Integrator1D
template<typename PointerToObj , typename PointerToMemFn >
static Functor1D< PointerToObj, PointerToMemFn > * newIntegrationFunctor (PointerToObj *object, PointerToMemFn function)
 Use FunctorUtils::newFunctor1D instead. More...
 
static Integrator1DnewIntegrator (const IntegratorType1D::Type &oneDimIntegratorType)
 Instantiates an Integrator object. More...
 
- Static Public Attributes inherited from NumA::QuadratureIntegrator1D
static const std::string PARAM_NAME_N = "numberOfNodes"
 Parameter used in the configure() to set the order of the quadrature. More...
 
- Static Public Attributes inherited from NumA::Integrator1D
static const std::string PARAM_NAME_ABSOLUTE_TOLERANCE
 Parameter used in the configure() to set the absolute tolerance. More...
 
static const std::string PARAM_NAME_RELATIVE_TOLERANCE
 Parameter used in the configure() to set the relative tolerance. More...
 
- Protected Attributes inherited from NumA::QuadratureIntegrator1D
unsigned int m_N
 Order of the quadrature (number of nodes). More...
 
std::vector< double > m_nodes
 Nodes of the quadrature. More...
 
std::vector< double > m_weights
 Weights of the quadrature. More...
 
- Protected Attributes inherited from NumA::Integrator1D
Tolerances m_tolerances
 Absolute and relative tolerances. More...
 
Errors m_errors
 Absolute and relative errors estimations. More...
 

Detailed Description

Trapezoidal integration with logarithmic step.

See Integrator1D documentation for an example.

Constructor & Destructor Documentation

◆ TrapezoidalLogIntegrator1D() [1/2]

NumA::TrapezoidalLogIntegrator1D::TrapezoidalLogIntegrator1D ( unsigned int  N = 40)

Constructor.

Parameters
NOrder of the quadrature (number of nodes).

◆ ~TrapezoidalLogIntegrator1D()

NumA::TrapezoidalLogIntegrator1D::~TrapezoidalLogIntegrator1D ( )
virtual

Default destructor.

◆ TrapezoidalLogIntegrator1D() [2/2]

NumA::TrapezoidalLogIntegrator1D::TrapezoidalLogIntegrator1D ( const TrapezoidalLogIntegrator1D other)
protected

Copy constructor.

Called by clone().

Parameters
otherTrapezoidalLogIntegrator1D object to copy.

Member Function Documentation

◆ clone()

TrapezoidalLogIntegrator1D * NumA::TrapezoidalLogIntegrator1D::clone ( ) const
virtual

◆ configure()

void NumA::TrapezoidalLogIntegrator1D::configure ( const ElemUtils::Parameters &  parameters)
virtual

Provides a generic method to configure all types of integrations by passing a Parameters object.

Parameters class represents a list of couples key/value (see Parameters class documentation for more info).

Parameters
parametersElemUtils::Parameters object.

Reimplemented from NumA::QuadratureIntegrator1D.

◆ integrate()

double NumA::TrapezoidalLogIntegrator1D::integrate ( FunctionType1D pFunction,
double  a,
double  b,
std::vector< double > &  parameters 
)
virtual

Integration routine.

Parameters
pFunctionFunctor representing the one-dimensional function to integrate.
aLower bound.
bUpper bound.
parametersParameters that can be passed to the function.
Returns
Integral.

Reimplemented from NumA::QuadratureIntegrator1D.

◆ setN()

void NumA::TrapezoidalLogIntegrator1D::setN ( unsigned int  n)
virtual
Parameters
nOrder of the quadrature (number of nodes).

Implements NumA::QuadratureIntegrator1D.


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