tension_spline.hpp

Go to the documentation of this file.

/*****************************************************************************
** Ifdefs
*****************************************************************************/

#ifndef ECL_GEOMETRY_TENSION_SPLINE_HPP_
#define ECL_GEOMETRY_TENSION_SPLINE_HPP_

/*****************************************************************************
** Includes
*****************************************************************************/

#include "tension_function.hpp"
#include <ecl/config/macros.hpp>
#include <ecl/concepts/macros.hpp>
#include <ecl/concepts/streams.hpp>
#include <ecl/concepts/containers.hpp>
#include <ecl/containers/array.hpp>
#include <ecl/exceptions/standard_exception.hpp>
#include <ecl/utilities/blueprints.hpp>
#include "macros.hpp"

/*****************************************************************************
** Namespaces
*****************************************************************************/

namespace ecl {

/*****************************************************************************
** Forward Declarations
*****************************************************************************/

class TensionSpline;

namespace blueprints {

class C2TensionSpline;

} // namespace blueprints

/*****************************************************************************
** BluePrintFactory
*****************************************************************************/
template<>
class ECL_PUBLIC BluePrintFactory< TensionSpline > {
public:
        static blueprints::C2TensionSpline Natural(const Array<double>& x_set, const Array<double>& y_set,
                        const double &tau) ecl_assert_throw_decl(StandardException);

        virtual ~BluePrintFactory() {};
};

/*****************************************************************************
** Interface [TensionSpline]
*****************************************************************************/
class ecl_geometry_PUBLIC TensionSpline : public BluePrintFactory< TensionSpline > {
    public:
        /******************************************
        ** Typedefs
        *******************************************/
        typedef BluePrintFactory< TensionSpline > Factory; 
        /******************************************
        ** Constructors
        *******************************************/
        TensionSpline () {};
        virtual ~TensionSpline() {};
        template<typename Derived>
        TensionSpline(const BluePrint< Derived > &blueprint) {
            blueprint.implementApply(*this);
        }

        /******************************************
        ** Access
        *******************************************/
        friend class blueprints::C2TensionSpline;

        double operator()(const double &x) const ecl_assert_throw_decl(StandardException);
        double derivative(const double &x) const ecl_assert_throw_decl(StandardException);
        double dderivative(const double &x) const ecl_assert_throw_decl(StandardException);

        const Array<double>& domain() const { return discretised_domain; }

        /******************************************
        ** Streaming
        *******************************************/
        template <typename OutputStream>
        friend OutputStream& operator << (OutputStream &ostream, const TensionSpline &tension_spline);

    private:
        Array<double> discretised_domain;           // N+1 x_i's
        Array<TensionFunction> functions;   // N tension_functions
        double tension;
};

/*****************************************************************************
** Interface [Minimum/Maximum][TensionSpline]
*****************************************************************************/

/*****************************************************************************
** Implementation [TensionSpline][Streaming]
*****************************************************************************/

template <typename OutputStream>
OutputStream& operator << (OutputStream &ostream, const TensionSpline &tension_spline) {

        ecl_compile_time_concept_check(ecl::StreamConcept<OutputStream>);

    for ( unsigned int i = 0; i < tension_spline.functions.size(); ++i ) {
        ostream << tension_spline.functions[i] << "\n";
    }
    ostream.flush();
    return ostream;
}

/*****************************************************************************
** BluePrints
*****************************************************************************/

namespace blueprints {

/*****************************************************************************
** Interface [C2TensionSpline]
*****************************************************************************/

class ecl_geometry_PUBLIC C2TensionSpline : public ecl::BluePrint<C2TensionSpline> {
    public:
        typedef ecl::TensionSpline base_type;
        C2TensionSpline() {};
        ~C2TensionSpline() {};

        C2TensionSpline(const ecl::Array<double>& x_set, const ecl::Array<double>& y_set, const double &tau) ecl_assert_throw_decl(ecl::StandardException);

        base_type instantiate();

        void apply(base_type& spline) const;

    private:
        ecl::Array<double> x_data;
        ecl::Array<double> y_data;
        ecl::Array<double> yddot_data;
        double tension;
};

} // namespace blueprints
} // namespace ecl

#endif /* ECL_GEOMETRY_TENSION_SPLINE_HPP_ */