Itasca C++ Interface
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
block::IZoneInterpolate Class Referenceabstract

Interface for accessing the zone interpolation class. More...

#include <izoneinterpolate.h>

Public Types

enum  Method { ConstMethod , AverageMethod , IDWMethod , PolyMethod }
 Interpolation method enumeration. More...
 

Public Member Functions

virtual int getMethod () const =0
 Returns an integer corresponding to the active interpolation method.
 
virtual bool getMethodActive () const =0
 
virtual QStringList getMethodKeywords () const =0
 Returns a QStringList comprising the keywords corresponding to all interpolation methods, separated by commas.
 
virtual QStringList getMethodNames () const =0
 Returns a QStringList comprising names corresponding to all interpolation methods, separated by commas.
 
virtual double getRadRatio () const =0
 Returns the radii ratio used by the Inverse Distance Weighting method.
 
virtual double getPower () const =0
 Returns the power used by the Inverse Distance Weighting method.
 
virtual double getTolerance () const =0
 Returns the tolerance used to assess quantity gradient by the Polynomial Extrapolation method.
 
virtual bool getRadRatioActive () const =0
 Returns true if the radii ratio parameter is used during the computation.
 
virtual bool getPowerActive () const =0
 Returns true if the power parameter is used during the computation.
 
virtual bool getToleranceActive () const =0
 Returns true if the tolerance parameter is used during the computation.
 
virtual double getGpValue (const IVertexThing *gp, const IZoneData *zoneData, uint32 thread, uint32 block) const =0
 Returns the interpolated field value at gridpoint gp.
 
virtual void setHideNull (bool b)=0
 
virtual bool getHideNull () const =0
 
virtual void initialize (const IZoneData *zoneData)=0
 Initializes the interpolation computation.
 
virtual void reset ()=0
 
virtual void destroy ()=0
 Destroys the current instanciation.
 
virtual void save (Archive2 &a) const =0
 
virtual bool restore (Archive2 &a, quint64 label)=0
 
virtual bool parse (IParse &par)=0
 
virtual QStringList getCommandSwitches () const =0
 
virtual void setActive (bool active)=0
 
virtual void setMethod (int method)=0
 Sets the current interpolation method.
 
virtual void setRadRatio (const double &radRatio)=0
 Sets the radii ratio parameter to be used by the Inverse Distance Weighting method.
 
virtual void setPower (const double &power)=0
 Sets the power parameter to be used by the Inverse Distance Weighting method.
 
virtual void setTolerance (const double &tol)=0
 Sets the tolerance parameter to be used by the Polynomial Extrapolation method.
 

Public Attributes

shared::Signal< int > methodChanged
 Signal emitted when the interpolation method is changed.
 
shared::Signal< double > radRatioChanged
 Signal emitted when the radii ratio parameter is changed.
 
shared::Signal< double > powerChanged
 Signal emitted when the power parameter is changed.
 
shared::Signal< double > toleranceChanged
 Signal emitted when the tolerance parameter is changed.
 
shared::Signal< bool > methodActiveChanged
 
shared::Signal< bool > radRatioActiveChanged
 Signal emitted when the radii ratio parameter becomes active.
 
shared::Signal< bool > powerActiveChanged
 Signal emitted when the power parameter becomes active.
 
shared::Signal< bool > toleranceActiveChanged
 Signal emitted when the tolerance parameter becomes active.
 
shared::Signal changed
 

Detailed Description

Interface for accessing the zone interpolation class.

Member Enumeration Documentation

◆ Method

Interpolation method enumeration.

Enumerator
ConstMethod 

Constant in zone.

AverageMethod 

Volumetric Averaging.

IDWMethod 

Inverse Distance Weighting.

PolyMethod 

Polynomial Extrapolation.

Member Function Documentation

◆ getGpValue()

virtual double block::IZoneInterpolate::getGpValue ( const IVertexThing * gp,
const IZoneData * zoneData,
uint32 thread,
uint32 block ) const
pure virtual

Returns the interpolated field value at gridpoint gp.

Parameters
gpis a const pointer to a vertex
zoneDatais the Zone data field

◆ getMethod()

virtual int block::IZoneInterpolate::getMethod ( ) const
pure virtual

Returns an integer corresponding to the active interpolation method.

See enum Method for details

◆ getPowerActive()

virtual bool block::IZoneInterpolate::getPowerActive ( ) const
pure virtual

Returns true if the power parameter is used during the computation.

So far, returns true if the active method is the Inverse Distance Weighting method.

◆ getRadRatioActive()

virtual bool block::IZoneInterpolate::getRadRatioActive ( ) const
pure virtual

Returns true if the radii ratio parameter is used during the computation.

So far, returns true if the active method is the Inverse Distance Weighting method.

◆ getToleranceActive()

virtual bool block::IZoneInterpolate::getToleranceActive ( ) const
pure virtual

Returns true if the tolerance parameter is used during the computation.

So far, returns true if the active method is the Polynomial Extrapolation method.

◆ initialize()

virtual void block::IZoneInterpolate::initialize ( const IZoneData * zoneData)
pure virtual

Initializes the interpolation computation.

Parameters
zoneDatais the Zone data field

◆ setMethod()

virtual void block::IZoneInterpolate::setMethod ( int method)
pure virtual

Sets the current interpolation method.

Parameters
methodis an integer between 0 and 2. See Method enumeration for details.
Calling this function will result in resetting the interpolated data field if the interpolation method is changed.

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