Homec4science
Diffusion Guggisberg-Liardon - Numerical integration (master) Browse

R7917/IntegrationSolver.hpp
0f8ddfe1ee20master

Last Change
Raw File

IntegrationSolver.hpp
View Options

#ifndef PCSC_PROJET_INTEGRATIONSOLVER_HPP
#define PCSC_PROJET_INTEGRATIONSOLVER_HPP
#include "Function.hpp"
#include "DomainCartesian.hpp"
#include "Method.hpp"
template <typename FunctionT, typename DomainT, typename returnT>
class IntegrationSolver {
public:
// Constructor
IntegrationSolver<FunctionT, DomainT, returnT>(FunctionT function_, DomainT domain_, Method method_);
// Get result and compute method
virtual returnT GetResult();
virtual returnT Compute() = 0;
protected:
// Members variables
FunctionT function;
DomainT domain;
Method method;
returnT result;
};
// Implementation inside of the header file for compliance with the compiling process when using templates
// Constructor
template <typename FunctionT, typename DomainT, typename returnT>
IntegrationSolver<FunctionT, DomainT, returnT>::IntegrationSolver(FunctionT function_, DomainT domain_, Method method_) {
function = function_;
domain = domain_;
method = method_;
result = NAN;
}
// Get result method
template <typename FunctionT, typename DomainT, typename returnT>
returnT IntegrationSolver<FunctionT, DomainT, returnT>::GetResult() {
// If asking for result before it has been computed, calling for the compute
if (isnan(result) == 1) {
result = this->Compute();
}
return result;
}
#endif //PCSC_PROJET_INTEGRATIONSOLVER_HPP
/*! \class IntegrationSolver class.h "inc/class.h"
* \brief
*
* This template class allows to create an object that contains the element for computing an integration of a function
* of template type FunctionT, over a domain of template type DomainT, using a method given by a Method object.
*
* The integration result is stored into a public variable of type returnT. Integration solver object using this template
* have to specified the FunctionT, DomainT and ReturnT.
*/
/*! \fn IntegrationSolver<FunctionT, DomainT, returnT>::IntegrationSolver(FunctionT function_, DomainT domain_, Method method_)
* \brief Constructor for the template class.
*
* When called from a specialized class, true type of FunctionT, DomainT and ReturnT must be specified in the declaration
* and implementation of the constructor.
* \param function_ has a type of a function object, declared in a child class of Function. It allows to compute values
* of the function to be integrated.
* \param domain_ has a type of a domain object, declared in a child class of Domain. It describes the domain of integration.
* \param method_ is a Method object. It contains the type of integration method to use.
*/
/*! \fn IntegrationSolver<FunctionT, DomainT, returnT>::GetResult()
* \brief Method for returning the result of the integration.
*
* If the results has not been computed when calling this method, it calls the compute method from the specialized class.
* \returns a ReturnT type that is defined in the specialized class (most likely to be a double).
*/
/*! \fn IntegrationSolver< FunctionT, DomainT, returnT >::Compute ( )
* \brief Pure virtual method that aims to trigger the computing of the result.
* \returns a ReturnT type that is defined in the specialized class (most likely to be a double).
*/
c4science · Help