QUESO::Generic1D1DFunction Class Reference

Class for generic one-dimensional functions. More...

#include <1D1DFunction.h>

Inheritance diagram for QUESO::Generic1D1DFunction:

Collaboration diagram for QUESO::Generic1D1DFunction:

Public Member Functions
Constructor/Destructor methods
	Generic1D1DFunction (double minDomainValue, double maxDomainValue, double(*valueRoutinePtr)(double domainValue, const void *routinesDataPtr), double(*derivRoutinePtr)(double domainValue, const void *routinesDataPtr), const void *routinesDataPtr)
	Default constructor. More...
	~Generic1D1DFunction ()
	Destructor. More...
Mathematical methods
double	value (double domainValue) const
	Returns the value of the (one-dimensional) function at point domainValue. More...
double	deriv (double domainValue) const
	Returns the value of the derivative of the function at point domainValue. More...
Public Member Functions inherited from QUESO::Base1D1DFunction
	Base1D1DFunction (double minDomainValue, double maxDomainValue)
	Default constructor. More...
virtual	~Base1D1DFunction ()
	Destructor. More...
double	minDomainValue () const
	Returns the minimum value of the domain of the (one-dimensional) function. More...
double	maxDomainValue () const
	Returns the maximum value of the domain of the (one-dimensional) function. More...
virtual double	multiplyAndIntegrate (const Base1D1DFunction &func, unsigned int quadratureOrder, double *resultWithMultiplicationByTAsWell) const
	TODO: Multiplies this function with function, and integrates it numerically. See template specialization. More...

Protected Attributes
double(*	m_valueRoutinePtr )(double domainValue, const void *routinesDataPtr)
double(*	m_derivRoutinePtr )(double domainValue, const void *routinesDataPtr)
const void *	m_routinesDataPtr
Protected Attributes inherited from QUESO::Base1D1DFunction
double	m_minDomainValue
double	m_maxDomainValue

Detailed Description

Class for generic one-dimensional functions.

This class implements generic one-dimensional functions.

Definition at line 97 of file 1D1DFunction.h.

Constructor & Destructor Documentation

QUESO::Generic1D1DFunction::Generic1D1DFunction	(	double	minDomainValue,
		double	maxDomainValue,
		double(*)(double domainValue, const void *routinesDataPtr)	valueRoutinePtr,
		double(*)(double domainValue, const void *routinesDataPtr)	derivRoutinePtr,
		const void *	routinesDataPtr
	)

Default constructor.

Definition at line 82 of file 1D1DFunction.C.

  :
  Base1D1DFunction(minDomainValue,maxDomainValue),
  m_valueRoutinePtr      (valueRoutinePtr),
  m_derivRoutinePtr      (derivRoutinePtr),
  m_routinesDataPtr      (routinesDataPtr)
{
}

QUESO::Generic1D1DFunction::~Generic1D1DFunction

(

)

Destructor.

Definition at line 96 of file 1D1DFunction.C.

{
}

Member Function Documentation

double QUESO::Generic1D1DFunction::deriv ( double  domainValue ) const

virtual

Returns the value of the derivative of the function at point domainValue.

This function checks if point domainValue belongs to the domain of this function, and in affirmative case, it returns the value of the derivative at such point.

Implements QUESO::Base1D1DFunction.

Definition at line 121 of file 1D1DFunction.C.

References m_derivRoutinePtr, QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, m_routinesDataPtr, UQ_FATAL_TEST_MACRO, and QUESO::UQ_UNAVAILABLE_RANK.

{
  if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
    std::cerr << "In Generic1D1DFunction::deriv()"
              << ": requested x ("            << domainValue
              << ") is out of the interval (" << m_minDomainValue
              << ", "                         << m_maxDomainValue
              << ")"
              << std::endl;
  }

  UQ_FATAL_TEST_MACRO(((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)),
                      UQ_UNAVAILABLE_RANK,
                      "Generic1D1DFunction::deriv()",
                      "x out of range");

  return (*m_derivRoutinePtr)(domainValue,m_routinesDataPtr);
}

double QUESO::Generic1D1DFunction::value ( double  domainValue ) const

virtual

Returns the value of the (one-dimensional) function at point domainValue.

This function checks if point domainValue belongs to the domain of this function, and in affirmative case, it evaluates the function at such point.

Implements QUESO::Base1D1DFunction.

Definition at line 101 of file 1D1DFunction.C.

References QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, m_routinesDataPtr, m_valueRoutinePtr, UQ_FATAL_TEST_MACRO, and QUESO::UQ_UNAVAILABLE_RANK.

{
  if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
    std::cerr << "In Generic1D1DFunction::value()"
              << ": requested x ("            << domainValue
              << ") is out of the interval (" << m_minDomainValue
              << ", "                         << m_maxDomainValue
              << ")"
              << std::endl;
  }

  UQ_FATAL_TEST_MACRO(((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)),
                      UQ_UNAVAILABLE_RANK,
                      "Generic1D1DFunction::value()",
                      "x out of range");

  return (*m_valueRoutinePtr)(domainValue,m_routinesDataPtr);
}

Member Data Documentation

double(* QUESO::Generic1D1DFunction::m_derivRoutinePtr)(double domainValue, const void *routinesDataPtr)

protected

Definition at line 128 of file 1D1DFunction.h.

Referenced by deriv().

const void* QUESO::Generic1D1DFunction::m_routinesDataPtr

protected

Definition at line 129 of file 1D1DFunction.h.

Referenced by deriv(), and value().

double(* QUESO::Generic1D1DFunction::m_valueRoutinePtr)(double domainValue, const void *routinesDataPtr)

protected

Definition at line 127 of file 1D1DFunction.h.

Referenced by value().

---

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

• src/misc/inc/1D1DFunction.h
• src/misc/src/1D1DFunction.C