ZCrossFaceGeneratorInterface Class Reference

The interface for the ZCrossExtractor FaceGenerator functor template argument. More...

#include <zcross_extractor.H>

Inheritance diagram for ZCrossFaceGeneratorInterface:

[legend]List of all members.

Public Member Functions
virtual	~ZCrossFaceGeneratorInterface ()
template<typename ScalarField, typename Confidence, typename FaceGenerator>
void	operator() (const ZCrossExtractor< ScalarField, Confidence, FaceGenerator > *)
virtual int	operator() ()=0

---

Detailed Description

The interface for the ZCrossExtractor FaceGenerator functor template argument.

This functor should have two overloaded forms.

The first form should take a single const ZCrossExtractor* as an argument and should have a void return type. This form should reset the generator and perform any initialization needed (specifically using information available through the ZCrossExtractor*).

The second form should take no arguments and return an int. The int is the index of the face that the ZCrossExtractor should examine next to look for zero crossing lines (the index is into the ZCrossExtractor's mesh's list of faces). When the ZCrossExtractor should stop looking for zero crossing lines, a value of -1 should be returned.

Definition at line 281 of file zcross_extractor.H.

---

Constructor & Destructor Documentation

virtual ZCrossFaceGeneratorInterface::~ZCrossFaceGeneratorInterface (   )  [inline, virtual]

Definition at line 285 of file zcross_extractor.H.

---

Member Function Documentation

virtual int ZCrossFaceGeneratorInterface::operator() (   )  [pure virtual]

Implemented in ZCrossAllFaceGenerator, ZCrossRandFaceGenerator, ZCrossPreviousFaceGenerator, and ZCrossPreviousAndRandFaceGenerator.

template<typename ScalarField, typename Confidence, typename FaceGenerator> void ZCrossFaceGeneratorInterface::operator() (  const ZCrossExtractor< ScalarField, Confidence, FaceGenerator > *   )  [inline]

Reimplemented in ZCrossAllFaceGenerator, ZCrossRandFaceGenerator, ZCrossPreviousFaceGenerator, and ZCrossPreviousAndRandFaceGenerator. Definition at line 288 of file zcross_extractor.H.

---

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

• zcross_extractor.H

---