Public Member Functions | Static Public Member Functions | List of all members
ecl::BluePrintFactory< CubicSpline > Class Reference

Blueprint factory for cubic splines. More...

#include <cubic_spline.hpp>

Inheritance diagram for ecl::BluePrintFactory< CubicSpline >:
Inheritance graph
[legend]

Public Member Functions

virtual ~BluePrintFactory ()
 

Static Public Member Functions

static blueprints::C2CubicSpline ContinuousDerivatives (const Array< double > &x_set, const Array< double > &y_set, const double ydot_0, const double ydot_f)
 Cubic spline blueprint satisfying y, y' and y'' continuity requirements. More...
 
static blueprints::DerivativeHeuristicCubicSpline DerivativeHeuristic (const Array< double > &x_set, const Array< double > &y_set, const double ydot_0, const double ydot_f)
 Cubic spline blueprint derived from a y' heuristic. More...
 
static blueprints::C2CubicSpline Natural (const Array< double > &x_set, const Array< double > &y_set)
 Cubic spline blueprint satisfying y, y' and y'' continuity with y''_0 = y''_f = 0. More...
 

Detailed Description

Blueprint factory for cubic splines.

Generates various blueprints that instantiate or configure cubic splines from commonly used algorithms.

See also
CubicSpline.

Definition at line 65 of file cubic_spline.hpp.

Constructor & Destructor Documentation

◆ ~BluePrintFactory()

virtual ecl::BluePrintFactory< CubicSpline >::~BluePrintFactory ( )
inlinevirtual

Definition at line 111 of file cubic_spline.hpp.

Member Function Documentation

◆ ContinuousDerivatives()

C2CubicSpline ecl::BluePrintFactory< CubicSpline >::ContinuousDerivatives ( const Array< double > &  x_set,
const Array< double > &  y_set,
const double  ydot_0,
const double  ydot_f 
)
static

Cubic spline blueprint satisfying y, y' and y'' continuity requirements.

Generates a blueprint for creating cubic splines on a set of data satisfying the constraints of continuity for y, y' and y''.

Parameters
x_set: set of data on the domain axis.
y_set: set of values on the range axis.
ydot_0: initial derivative value (boundary constraint).
ydot_f: final derivative value (boundary constraint).
Returns
C2CubicSpline : the resulting blueprint.

Definition at line 195 of file cubic_spline_blueprints.cpp.

◆ DerivativeHeuristic()

DerivativeHeuristicCubicSpline ecl::BluePrintFactory< CubicSpline >::DerivativeHeuristic ( const Array< double > &  x_set,
const Array< double > &  y_set,
const double  ydot_0,
const double  ydot_f 
)
static

Cubic spline blueprint derived from a y' heuristic.

Generates a blueprint for creating cubic splines on a set of data satisfying a heuristic that automatically generates derivatives at the via points.

Parameters
x_set: set of data on the domain axis.
y_set: set of values on the range axis.
ydot_0: initial derivative value (boundary constraint).
ydot_f: final derivative value (boundary constraint).
Returns
DerivativeHeuristicCubicSpline : the resulting blueprint.

Definition at line 200 of file cubic_spline_blueprints.cpp.

◆ Natural()

C2CubicSpline ecl::BluePrintFactory< CubicSpline >::Natural ( const Array< double > &  x_set,
const Array< double > &  y_set 
)
static

Cubic spline blueprint satisfying y, y' and y'' continuity with y''_0 = y''_f = 0.

This is a special case of the ContinuousDerivatives blueprint that uses y''_0 = y''_f = 0 boundary conditions instead. It is more commonly referred to as the natural cubic spline.

Parameters
x_set: set of data on the domain axis.
y_set: set of values on the range axis.
Returns
C2CubicSpline : the resulting blueprint.

Definition at line 191 of file cubic_spline_blueprints.cpp.


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


ecl_geometry
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:16