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

Blueprint for generating a linear function from slope and point pair. More...

#include <polynomial.hpp>

Inheritance diagram for ecl::blueprints::LinearPointSlopeForm:
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...
 
 LinearPointSlopeForm (const double x_f, const double y_f, const double s)
 Constructor that properly configures/initialises the blueprint. More...
 
virtual ~LinearPointSlopeForm ()
 
- Public Member Functions inherited from ecl::BluePrint< LinearPointSlopeForm >
 BluePrint ()
 
void implementApply (BaseType &object) const
 
BaseType implementInstantiate ()
 
virtual ~BluePrint ()
 

Private Attributes

double slope
 
double x_final
 
double y_final
 

Detailed Description

Blueprint for generating a linear function from slope and point pair.

That is, the resulting linear function y(x) should satisfy the following conditions:

(y(x_f)-y(x)) = slope*(x_f-x)
y(x_f) = y_f
See also
ecl::LinearFunction.

Definition at line 562 of file polynomial.hpp.

Member Typedef Documentation

◆ base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 569 of file polynomial.hpp.

Constructor & Destructor Documentation

◆ LinearPointSlopeForm()

ecl::blueprints::LinearPointSlopeForm::LinearPointSlopeForm ( const double  x_f,
const double  y_f,
const double  s 
)
inline

Constructor that properly configures/initialises the blueprint.

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

Parameters
x_f: final domain value.
y_f: final polynomial value.
s: slope

Definition at line 579 of file polynomial.hpp.

◆ ~LinearPointSlopeForm()

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

Definition at line 585 of file polynomial.hpp.

Member Function Documentation

◆ apply()

void ecl::blueprints::LinearPointSlopeForm::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 input conditions.

Definition at line 70 of file polynomial_blueprints.cpp.

◆ instantiate()

ecl::LinearFunction ecl::blueprints::LinearPointSlopeForm::instantiate ( )

Instantiate a copy of the object that is blueprinted.

Instantiates a new linear function generated from the input conditions.

Returns
LinearFunction : a copy of the generated function.

Definition at line 64 of file polynomial_blueprints.cpp.

Member Data Documentation

◆ slope

double ecl::blueprints::LinearPointSlopeForm::slope
private

Definition at line 605 of file polynomial.hpp.

◆ x_final

double ecl::blueprints::LinearPointSlopeForm::x_final
private

Definition at line 606 of file polynomial.hpp.

◆ y_final

double ecl::blueprints::LinearPointSlopeForm::y_final
private

Definition at line 606 of file polynomial.hpp.


The documentation for this class was generated from the following files:
ecl::blueprints::LinearPointSlopeForm::slope
double slope
Definition: polynomial.hpp:605


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