QUESO::Constant1D1DFunction Class Reference

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

#include <1D1DFunction.h>

Inheritance diagram for QUESO::Constant1D1DFunction:

Collaboration diagram for QUESO::Constant1D1DFunction:

Public Member Functions
Constructor/Destructor methods
	Constant1D1DFunction (double minDomainValue, double maxDomainValue, double constantValue)
	Default constructor. More...
	~Constant1D1DFunction ()
	Destructor. More...
Mathematical methods
double	value (double domainValue) const
	Returns the value of the constant function at point domainValue. More...
double	deriv (double domainValue) const
	Returns the value of the derivative of the constant 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_constantValue
Protected Attributes inherited from QUESO::Base1D1DFunction
double	m_minDomainValue
double	m_maxDomainValue

Detailed Description

Class for constant one-dimensional functions.

This class implements constant one-dimensional functions.

Definition at line 140 of file 1D1DFunction.h.

Constructor & Destructor Documentation

QUESO::Constant1D1DFunction::Constant1D1DFunction	(	double	minDomainValue,
		double	maxDomainValue,
		double	constantValue
	)

Default constructor.

Definition at line 131 of file 1D1DFunction.C.

  :
  Base1D1DFunction(minDomainValue,maxDomainValue),
  m_constantValue        (constantValue)
{
}

QUESO::Constant1D1DFunction::~Constant1D1DFunction

(

)

Destructor.

Definition at line 141 of file 1D1DFunction.C.

{
}

Member Function Documentation

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

virtual

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

This function checks if point domainValue belongs to the domain of this function, and in affirmative case, it returns 0 (derivative of a constant function.

Implements QUESO::Base1D1DFunction.

Definition at line 163 of file 1D1DFunction.C.

References QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, and queso_require_msg.

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

  queso_require_msg(!((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)), "x out of range");

  return 0.;
}

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

virtual

Returns the value of the constant 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, which is the constant value constantValue passed to the constructor of this class.

Implements QUESO::Base1D1DFunction.

Definition at line 146 of file 1D1DFunction.C.

References m_constantValue, QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, and queso_require_msg.

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

  queso_require_msg(!((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)), "x out of range");

  return m_constantValue;
}

Member Data Documentation

double QUESO::Constant1D1DFunction::m_constantValue

protected

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