afl::Interpolator Class Reference

#include <interpolator.h>

Inheritance diagram for afl::Interpolator:

afl::AnalyticInterpolator afl::Interpolator_1 afl::Interpolator_2 afl::Interpolator_3 afl::Interpolator_4 afl::BasisInterpolator_1 afl::HermiteCubic_1 afl::LagrangeLinear_1 afl::LagrangeQuadratic_1 afl::BasisInterpolator_2 afl::DelaunayLinear_2 afl::BasisInterpolator_3 afl::DelaunayLinear_3 afl::BasisInterpolator_4 afl::DelaunayLinear_4 List of all members.

Public Member Functions

virtual ~Interpolator ()
virtual Value interpolate (const Point &x) const =0
virtual void toXML (std::ostream &doc) const
virtual Interpolatorclone ()=0
virtual void boundary (const Boundary *boundary, const Field *parent)
virtual void invalidateTriangulation ()
virtual const std::string & getImplementation () const =0
virtual const std::string & getMethod () const =0
void setParentField (const Field *parent)

Protected Member Functions

 Interpolator (const Field *f, const Parameters &params)
 Interpolator ()

Protected Attributes

const ddf::PropertySet_pset
const Field_parent
const Boundary_boundary
bool _validTriangulation

Detailed Description

class Interpolator


Constructor & Destructor Documentation

virtual afl::Interpolator::~Interpolator  )  [inline, virtual]
 

Public methods:

afl::Interpolator::Interpolator const Field f,
const Parameters params
[protected]
 

assigs the DDF properties of the field

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

afl::Interpolator::Interpolator  )  [protected]
 

empty constructor, for use by analytic interpolators that don't use properties


Member Function Documentation

virtual void afl::Interpolator::boundary const Boundary boundary,
const Field parent
[virtual]
 

sets the boundary that this interpolator would use

Parameters:
boundary the boundary to use
parent the parent field of this interpolator

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

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

Implemented in afl::AnalyticInterpolator, afl::BasisInterpolator_1, afl::BasisInterpolator_2, afl::BasisInterpolator_3, afl::BasisInterpolator_4, afl::DelaunayLinear_2, afl::DelaunayLinear_3, afl::DelaunayLinear_4, afl::HermiteCubic_1, afl::LagrangeLinear_1, and afl::LagrangeQuadratic_1.

virtual const std::string& afl::Interpolator::getImplementation  )  const [pure virtual]
 

Returns:
the name of the implementation

Implemented in afl::AnalyticInterpolator, afl::BasisInterpolator_1, afl::BasisInterpolator_2, afl::BasisInterpolator_3, afl::BasisInterpolator_4, afl::DelaunayLinear_2, afl::DelaunayLinear_3, afl::DelaunayLinear_4, afl::HermiteCubic_1, and afl::LagrangeLinear_1.

virtual const std::string& afl::Interpolator::getMethod  )  const [pure virtual]
 

Returns:
the name of the method this interpolator implements

Implemented in afl::AnalyticInterpolator, afl::BasisInterpolator_1, afl::BasisInterpolator_2, afl::BasisInterpolator_3, afl::BasisInterpolator_4, afl::DelaunayLinear_2, afl::DelaunayLinear_3, afl::DelaunayLinear_4, afl::HermiteCubic_1, and afl::LagrangeLinear_1.

virtual Value afl::Interpolator::interpolate const Point x  )  const [pure virtual]
 

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

Implemented in afl::AnalyticInterpolator, afl::BasisInterpolator_1, afl::BasisInterpolator_2, afl::BasisInterpolator_3, afl::BasisInterpolator_4, afl::DelaunayLinear_2, afl::DelaunayLinear_3, afl::DelaunayLinear_4, afl::HermiteCubic_1, afl::LagrangeLinear_1, and afl::LagrangeQuadratic_1.

virtual void afl::Interpolator::invalidateTriangulation  )  [virtual]
 

invalidates the triangulation

void afl::Interpolator::setParentField const Field parent  ) 
 

sets the parent field of this interpolation

Parameters:
parent the field that this interpolation should operator on

virtual void afl::Interpolator::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 in afl::AnalyticInterpolator, afl::BasisInterpolator_1, afl::BasisInterpolator_2, afl::BasisInterpolator_3, and afl::BasisInterpolator_4.


Member Data Documentation

const Boundary* afl::Interpolator::_boundary [protected]
 

the boundary of the field this interpolator interpolates over

const Field* afl::Interpolator::_parent [protected]
 

the field this interpolator interpolates over

const ddf::PropertySet* afl::Interpolator::_pset [protected]
 

the value property that defined a numerical field

bool afl::Interpolator::_validTriangulation [mutable, protected]
 

whether the last triangulation is still valid or not


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