afl::BasisInterpolator_3 Class Reference

#include <basisinterpolator_3.h>

Inheritance diagram for afl::BasisInterpolator_3:

afl::Interpolator_3 afl::Interpolator List of all members.

Public Member Functions

 BasisInterpolator_3 (const Field *f, const Parameters &params)
virtual ~BasisInterpolator_3 ()
Value interpolate (const Point &x) const
virtual void toXML (std::ostream &doc) const
virtual Interpolatorclone ()
virtual data_t getKsi (const Point &x, size_t u) const
virtual Value getValue (const Point &x, size_t u) const
virtual const std::string & getImplementation () const
virtual const std::string & getMethod () const

Detailed Description

class BasisInterpolator_3 A customised interpolator


Constructor & Destructor Documentation

afl::BasisInterpolator_3::BasisInterpolator_3 const Field f,
const Parameters params
 

creates a new interpolation object

Parameters:
f the field this interpolation is over
params any parameters to pass to the interpolator

virtual afl::BasisInterpolator_3::~BasisInterpolator_3  )  [virtual]
 

destructor


Member Function Documentation

virtual Interpolator* afl::BasisInterpolator_3::clone  )  [virtual]
 

Returns:
a true copy of the object. The object is becomes the responsibility of the calling function

Implements afl::Interpolator.

virtual const std::string& afl::BasisInterpolator_3::getImplementation  )  const [virtual]
 

Returns:
the name of the implementation

Implements afl::Interpolator.

virtual data_t afl::BasisInterpolator_3::getKsi const Point x,
size_t  u
const [virtual]
 

Returns:
the value of Ksi for a given point. NaN if the point is outside the convex hull of the points
Parameters:
x the point to compute Ksi at
u (can be either 1, 2 or 3) the Ksi agains which point of the element to find Ksi1, Ksi2 or Ksi3
Exceptions:
ddf::InvalidArgumentException if u is not 1, 2 or 3

virtual const std::string& afl::BasisInterpolator_3::getMethod  )  const [virtual]
 

Returns:
the name of the method this interpolator implements

Implements afl::Interpolator.

virtual Value afl::BasisInterpolator_3::getValue const Point x,
size_t  u
const [virtual]
 

Returns:
a the value at a known point
Parameters:
x the point that is in the element that is queried
u (can be either 1, 2 or 3) which point of the element to find U1, U2 or U3
Exceptions:
ddf::InvalidArgumentException if u is not 1, 2 or 3

Value afl::BasisInterpolator_3::interpolate const Point x  )  const [virtual]
 

Parameters:
x the location to interpolate for
Returns:
the interpolated value at x

Implements afl::Interpolator.

virtual void afl::BasisInterpolator_3::toXML std::ostream &  doc  )  const [virtual]
 

represents the interpolator as an AFL document

Parameters:
doc the output stream that the xml will be appended to

Reimplemented from afl::Interpolator.


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 07:17:51 2006 for afl by  doxygen 1.4.6