Public Types | Public Member Functions | Private Attributes | List of all members
ecl::blueprints::C2TensionSpline Class Reference

Blueprint for generating a tension spline satisfying C2 constraints. More...

#include <tension_spline.hpp>

Inheritance diagram for ecl::blueprints::C2TensionSpline:
Inheritance graph
[legend]

Public Types

typedef ecl::TensionSpline base_type
 Abstract representation of the class to be instantiated/configured. More...
 

Public Member Functions

void apply (base_type &spline) const
 Apply the blueprint to configure an existing object. More...
 
 C2TensionSpline ()
 Default constructor. More...
 
 C2TensionSpline (const ecl::Array< double > &x_set, const ecl::Array< double > &y_set, const double &tau)
 Constructor that properly configures/initialises the blueprint. More...
 
base_type instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
 ~C2TensionSpline ()
 
- Public Member Functions inherited from ecl::BluePrint< C2TensionSpline >
 BluePrint ()
 
void implementApply (BaseType &object) const
 
BaseType implementInstantiate ()
 
virtual ~BluePrint ()
 

Private Attributes

double tension
 
ecl::Array< double > x_data
 
ecl::Array< double > y_data
 
ecl::Array< double > yddot_data
 

Detailed Description

Blueprint for generating a tension spline satisfying C2 constraints.

Blueprint for generating a tension spline on a set of data given the constraint of continuity of y, y' and y''.

See also
TensionSpline.

Definition at line 260 of file tension_spline.hpp.

Member Typedef Documentation

◆ base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 269 of file tension_spline.hpp.

Constructor & Destructor Documentation

◆ C2TensionSpline() [1/2]

ecl::blueprints::C2TensionSpline::C2TensionSpline ( )
inline

Default constructor.

Default constructor (only utilised by the blueprint compile time assert).

Definition at line 275 of file tension_spline.hpp.

◆ ~C2TensionSpline()

ecl::blueprints::C2TensionSpline::~C2TensionSpline ( )
inline

Definition at line 276 of file tension_spline.hpp.

◆ C2TensionSpline() [2/2]

ecl::blueprints::C2TensionSpline::C2TensionSpline ( const ecl::Array< double > &  x_set,
const ecl::Array< double > &  y_set,
const double &  tau 
)

Constructor that properly configures/initialises the blueprint.

The constructor uses the input data sets along with the assumption of zero boundary conditions on the second derivatives to generate a full set of second derivatives at each via point that will guarantee c2 continuity of the spline.

Parameters
x_set: set of data on the domain axis.
y_set: set of values on the range axis.
tau: the tension parameter.
Exceptions
StandardException : throws if configuration arguments are not valid [debug mode only].

Definition at line 49 of file tension_spline_blueprints.cpp.

Member Function Documentation

◆ apply()

void ecl::blueprints::C2TensionSpline::apply ( base_type spline) const

Apply the blueprint to configure an existing object.

Apply the data set to generate the configuration required for the tension spline.

Parameters
spline: the spline to configure from the supplied data set.

Definition at line 112 of file tension_spline_blueprints.cpp.

◆ instantiate()

TensionSpline ecl::blueprints::C2TensionSpline::instantiate ( )

Instantiate a copy of the object that is blueprinted.

Instantiates a new tension spline generated from the supplied data set.

Returns
TensionSpline : a copy of the generated tension spline.

Definition at line 106 of file tension_spline_blueprints.cpp.

Member Data Documentation

◆ tension

double ecl::blueprints::C2TensionSpline::tension
private

Definition at line 315 of file tension_spline.hpp.

◆ x_data

ecl::Array<double> ecl::blueprints::C2TensionSpline::x_data
private

Definition at line 312 of file tension_spline.hpp.

◆ y_data

ecl::Array<double> ecl::blueprints::C2TensionSpline::y_data
private

Definition at line 313 of file tension_spline.hpp.

◆ yddot_data

ecl::Array<double> ecl::blueprints::C2TensionSpline::yddot_data
private

Definition at line 314 of file tension_spline.hpp.


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


ecl_geometry
Author(s): Daniel Stonier
autogenerated on Wed Mar 2 2022 00:16:40