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

Blueprint for interpolating a linear function connecting end point conditions. More...

#include <polynomial.hpp>

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

Public Types

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

Public Member Functions

void apply (ecl::LinearFunction &function) const
 Apply the blueprint to configure an existing object. More...
 
ecl::LinearFunction instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
 LinearInterpolation (const double x_i, const double y_i, const double x_f, const double y_f)
 Constructor that properly configures/initialises the blueprint. More...
 
virtual ~LinearInterpolation ()
 
- Public Member Functions inherited from ecl::BluePrint< LinearInterpolation >
 BluePrint ()
 
void implementApply (BaseType &object) const
 
BaseType implementInstantiate ()
 
virtual ~BluePrint ()
 

Private Attributes

double x_final
 
double x_initial
 
double y_final
 
double y_initial
 

Detailed Description

Blueprint for interpolating a linear function connecting end point conditions.

Blueprint for interpolating a linear function connecting two points. That is, the resulting linear function y(x) should satisfy the following conditions:

y(x_i) = y_i
y(x_f) = y_f
See also
ecl::LinearFunction.

Definition at line 499 of file polynomial.hpp.

Member Typedef Documentation

◆ base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 508 of file polynomial.hpp.

Constructor & Destructor Documentation

◆ LinearInterpolation()

ecl::blueprints::LinearInterpolation::LinearInterpolation ( const double  x_i,
const double  y_i,
const double  x_f,
const double  y_f 
)
inline

Constructor that properly configures/initialises the blueprint.

Constructor that accepts the boundary constraints used to generate the linear function.

Parameters
x_i: initial domain value.
y_i: initial polynomial value.
x_f: final domain value.
y_f: final polynomial value.

Definition at line 519 of file polynomial.hpp.

◆ ~LinearInterpolation()

virtual ecl::blueprints::LinearInterpolation::~LinearInterpolation ( )
inlinevirtual

Definition at line 526 of file polynomial.hpp.

Member Function Documentation

◆ apply()

void ecl::blueprints::LinearInterpolation::apply ( ecl::LinearFunction function) const

Apply the blueprint to configure an existing object.

Apply the boundary conditions to generate coefficients for the given polynomial.

Parameters
function: the linear function to configure from the supplied boundary conditions.

Definition at line 53 of file polynomial_blueprints.cpp.

◆ instantiate()

ecl::LinearFunction ecl::blueprints::LinearInterpolation::instantiate ( )

Instantiate a copy of the object that is blueprinted.

Instantiates a new linear function generated from the input boundary conditions.

Returns
LinearFunction : a copy of the generated function.

Definition at line 47 of file polynomial_blueprints.cpp.

Member Data Documentation

◆ x_final

double ecl::blueprints::LinearInterpolation::x_final
private

Definition at line 547 of file polynomial.hpp.

◆ x_initial

double ecl::blueprints::LinearInterpolation::x_initial
private

Definition at line 546 of file polynomial.hpp.

◆ y_final

double ecl::blueprints::LinearInterpolation::y_final
private

Definition at line 547 of file polynomial.hpp.

◆ y_initial

double ecl::blueprints::LinearInterpolation::y_initial
private

Definition at line 546 of file polynomial.hpp.


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