QUESO::Base1D1DFunction Class Reference

Class for one-dimensional functions. More...

#include <1D1DFunction.h>

Inheritance diagram for QUESO::Base1D1DFunction:

Public Member Functions
Constructor/Destructor methods
	Base1D1DFunction (double minDomainValue, double maxDomainValue)
	Default constructor. More...
virtual	~Base1D1DFunction ()
	Destructor. More...
Mathematical methods
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	value (double domainValue) const =0
	Returns the value of the (one-dimensional) function. See template specialization. More...
virtual double	deriv (double domainValue) const =0
	Returns the value of the derivative of the function. See template specialization. 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_minDomainValue
double	m_maxDomainValue

Detailed Description

Class for one-dimensional functions.

Base class for one-dimensional functions.

Definition at line 53 of file 1D1DFunction.h.

Constructor & Destructor Documentation

QUESO::Base1D1DFunction::Base1D1DFunction	(	double	minDomainValue,
		double	maxDomainValue
	)

Default constructor.

Definition at line 33 of file 1D1DFunction.C.

References m_maxDomainValue, m_minDomainValue, UQ_FATAL_TEST_MACRO, and QUESO::UQ_UNAVAILABLE_RANK.

  :
  m_minDomainValue(minDomainValue),
  m_maxDomainValue(maxDomainValue)
{
  UQ_FATAL_TEST_MACRO(m_minDomainValue >= m_maxDomainValue,
                      UQ_UNAVAILABLE_RANK,
                      "Base1D1DFunction::constructor()",
                      "min >= max");
}

QUESO::Base1D1DFunction::~Base1D1DFunction ( )

virtual

Destructor.

Definition at line 46 of file 1D1DFunction.C.

{
}

Member Function Documentation

virtual double QUESO::Base1D1DFunction::deriv ( double  domainValue ) const

pure virtual

Returns the value of the derivative of the function. See template specialization.

Implemented in QUESO::LagrangeBasis1D1DFunction, QUESO::LagrangePolynomial1D1DFunction, QUESO::FuncPlusFunc1D1DFunction, QUESO::FuncTimesFunc1D1DFunction, QUESO::ScalarTimesFunc1D1DFunction, QUESO::Sampled1D1DFunction, QUESO::PiecewiseLinear1D1DFunction, QUESO::Linear1D1DFunction, QUESO::Constant1D1DFunction, and QUESO::Generic1D1DFunction.

double QUESO::Base1D1DFunction::maxDomainValue

(

)

const

Returns the maximum value of the domain of the (one-dimensional) function.

Definition at line 57 of file 1D1DFunction.C.

References m_maxDomainValue.

{
  return m_maxDomainValue;
}

double QUESO::Base1D1DFunction::minDomainValue

(

)

const

Returns the minimum value of the domain of the (one-dimensional) function.

Definition at line 51 of file 1D1DFunction.C.

References m_minDomainValue.

{
  return m_minDomainValue;
}

double QUESO::Base1D1DFunction::multiplyAndIntegrate ( const Base1D1DFunction &  func, unsigned int  quadratureOrder, double *  resultWithMultiplicationByTAsWell  ) const

virtual

TODO: Multiplies this function with function, and integrates it numerically. See template specialization.

Todo:

: Please, implement me!

Definition at line 63 of file 1D1DFunction.C.

References UQ_FATAL_TEST_MACRO, QUESO::UQ_UNAVAILABLE_RANK, and value().

{
  double value = 0.;

  UQ_FATAL_TEST_MACRO(true,
                      UQ_UNAVAILABLE_RANK,
                      "Base1D1DFunction::multiplyAndIntegrate()",
                      "not implemented yet");

  if (resultWithMultiplicationByTAsWell) { // Just to eliminate INTEL compiler warnings
    func.value((double) quadratureOrder);
  }

  return value;
}

virtual double QUESO::Base1D1DFunction::value ( double  domainValue ) const

pure virtual

Returns the value of the (one-dimensional) function. See template specialization.

Implemented in QUESO::LagrangeBasis1D1DFunction, QUESO::LagrangePolynomial1D1DFunction, QUESO::FuncPlusFunc1D1DFunction, QUESO::FuncTimesFunc1D1DFunction, QUESO::ScalarTimesFunc1D1DFunction, QUESO::Sampled1D1DFunction, QUESO::PiecewiseLinear1D1DFunction, QUESO::Linear1D1DFunction, QUESO::Constant1D1DFunction, and QUESO::Generic1D1DFunction.

Referenced by multiplyAndIntegrate(), QUESO::SubF1F2Gaussian2dKdeIntegral(), QUESO::ScalarTimesFunc1D1DFunction::value(), QUESO::FuncTimesFunc1D1DFunction::value(), and QUESO::FuncPlusFunc1D1DFunction::value().

Member Data Documentation

double QUESO::Base1D1DFunction::m_maxDomainValue

protected

Definition at line 86 of file 1D1DFunction.h.

Referenced by Base1D1DFunction(), QUESO::Generic1D1DFunction::deriv(), QUESO::Constant1D1DFunction::deriv(), QUESO::Linear1D1DFunction::deriv(), QUESO::PiecewiseLinear1D1DFunction::deriv(), QUESO::Sampled1D1DFunction::deriv(), QUESO::ScalarTimesFunc1D1DFunction::deriv(), QUESO::FuncTimesFunc1D1DFunction::deriv(), QUESO::FuncPlusFunc1D1DFunction::deriv(), QUESO::LagrangePolynomial1D1DFunction::deriv(), QUESO::LagrangeBasis1D1DFunction::deriv(), maxDomainValue(), QUESO::Sampled1D1DFunction::set(), QUESO::Generic1D1DFunction::value(), QUESO::Constant1D1DFunction::value(), QUESO::Linear1D1DFunction::value(), QUESO::PiecewiseLinear1D1DFunction::value(), and QUESO::Sampled1D1DFunction::value().

double QUESO::Base1D1DFunction::m_minDomainValue

protected

Definition at line 85 of file 1D1DFunction.h.

Referenced by Base1D1DFunction(), QUESO::Generic1D1DFunction::deriv(), QUESO::Constant1D1DFunction::deriv(), QUESO::Linear1D1DFunction::deriv(), QUESO::PiecewiseLinear1D1DFunction::deriv(), QUESO::Sampled1D1DFunction::deriv(), QUESO::ScalarTimesFunc1D1DFunction::deriv(), QUESO::FuncTimesFunc1D1DFunction::deriv(), QUESO::FuncPlusFunc1D1DFunction::deriv(), QUESO::LagrangePolynomial1D1DFunction::deriv(), QUESO::LagrangeBasis1D1DFunction::deriv(), minDomainValue(), QUESO::Sampled1D1DFunction::set(), QUESO::Generic1D1DFunction::value(), QUESO::Constant1D1DFunction::value(), QUESO::Linear1D1DFunction::value(), QUESO::PiecewiseLinear1D1DFunction::value(), and QUESO::Sampled1D1DFunction::value().

---

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

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