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

#include <1D1DFunction.h>

Inheritance diagram for QUESO::Linear1D1DFunction:

Collaboration diagram for QUESO::Linear1D1DFunction:

Public Member Functions
Constructor/Destructor methods
	Linear1D1DFunction (double minDomainValue, double maxDomainValue, double referenceDomainValue, double referenceImageValue, double rateValue)
	Default constructor. More...

	~Linear1D1DFunction ()
	Destructor. More...

Mathematical methods
double	value (double domainValue) const
	Returns the value of the linear function at point `domainValue`. More...

double	deriv (double domainValue) const
	Returns the value of the derivative of the linear 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_referenceDomainValue
	Reference value in the function domain; in . More...

double	m_referenceImageValue
	Reference value in the function image; in . More...

double	m_rateValue
	Rate value; in . More...

Protected Attributes inherited from QUESO::Base1D1DFunction
double	m_minDomainValue

double	m_maxDomainValue

Detailed Description

Class for linear one-dimensional functions.

This class implements linear one-dimensional functions. A common linear function is the the equation of a line:

$f(x) = y_1 + m (x - x_1),$

which is a linear function with slope (or rate) $ m $ and passing through the point $(x_1,y_1)$ .

This class implements a linear function such as the one describe above where the rate is given by rateValue, and the point is (referenceDomainValue,referenceImageValue).

Definition at line 186 of file 1D1DFunction.h.

Constructor & Destructor Documentation

QUESO::Linear1D1DFunction::Linear1D1DFunction	(	double	minDomainValue,
		double	maxDomainValue,
		double	referenceDomainValue,
		double	referenceImageValue,
		double	rateValue
	)

Default constructor.

Constructs a linear function of constant rate of change rateValue which passes through the point (x,y)=(referenceDomainValue,referenceImageValue).

Definition at line 200 of file 1D1DFunction.C.

   :
   Base1D1DFunction(minDomainValue,maxDomainValue),
   m_referenceDomainValue (referenceDomainValue),
   m_referenceImageValue  (referenceImageValue),
   m_rateValue            (rateValue)
 {
 }

QUESO::Linear1D1DFunction::~Linear1D1DFunction ( )

Destructor.

Definition at line 214 of file 1D1DFunction.C.

215 {

216 }

Member Function Documentation

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

virtual

Returns the value of the derivative of the linear 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 (namely m_rateValue).

Implements QUESO::Base1D1DFunction.

Definition at line 241 of file 1D1DFunction.C.

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

 {
   if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
     std::cerr << "In Linear1D1DFunction::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,
                       "Linear1D1DFunction::deriv()",
                       "x out of range");
 
   return m_rateValue;
 }

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

virtual

Returns the value of the linear 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 219 of file 1D1DFunction.C.

References QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, m_rateValue, m_referenceDomainValue, m_referenceImageValue, UQ_FATAL_TEST_MACRO, and QUESO::UQ_UNAVAILABLE_RANK.

 {
   if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
     std::cerr << "In Linear1D1DFunction::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,
                       "Linear1D1DFunction::value()",
                       "x out of range");
 
   double imageValue = m_referenceImageValue + m_rateValue*(domainValue - m_referenceDomainValue);
 
   return imageValue;
 }

Member Data Documentation

double QUESO::Linear1D1DFunction::m_rateValue

protected

Rate value; $ m$ in $f(x) = y_1 + m (x - x_1)$ .

Definition at line 226 of file 1D1DFunction.h.

Referenced by deriv(), and value().

double QUESO::Linear1D1DFunction::m_referenceDomainValue

protected

Reference value in the function domain; $ x_1 $ in $ f(x) = y_1 + m (x - x_1)$ .

Definition at line 220 of file 1D1DFunction.h.

Referenced by value().

double QUESO::Linear1D1DFunction::m_referenceImageValue

protected

Reference value in the function image; $ y_1 $ in $ f(x) = y_1 + m (x - x_1)$ .

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation