TTK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ttkArrayPreconditioning Class Reference

TTK VTK-filter to generate order fields. More...

#include <ttkArrayPreconditioning.h>

Inheritance diagram for ttkArrayPreconditioning:
ttkAlgorithm ttk::ArrayPreconditioning ttk::Debug ttk::Debug ttk::BaseClass ttk::BaseClass

Public Types

typedef ttkAlgorithm Superclass
 
- Public Types inherited from ttkAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void SetSelectFieldsWithRegexp (bool)
 
virtual bool GetSelectFieldsWithRegexp ()
 
virtual void SetBurstSize (int)
 
virtual int GetBurstSize ()
 
virtual void SetRegexpString (const std::string &)
 
virtual std::string GetRegexpString ()
 
virtual void SetGlobalOrder (bool)
 
virtual bool GetGlobalOrder ()
 
vtkDataArraySelection * GetPointDataArraySelection ()
 
- Public Member Functions inherited from ttkAlgorithm
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void UpdateThreadNumber ()
 
void SetThreadNumber (int threadNumber)
 
void SetUseAllCores (bool useAllCores)
 
void SetDebugLevel (int debugLevel)
 
void SetCompactTriangulationCacheSize (float cacheSize)
 
vtkDataArray * GetOptionalArray (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, const int &inputPort=0)
 
vtkDataArray * GetOrderArray (vtkDataSet *const inputData, const int scalarArrayIdx, const int orderArrayIdx=0, const bool enforceOrderArrayIdx=false)
 
ttk::SimplexIdGetIdentifierArrayPtr (const bool &enforceArrayIndex, const int &arrayIndex, const std::string &arrayName, vtkDataSet *const inputData, std::vector< ttk::SimplexId > &spareStorage, const int inputPort=0, const bool printErr=true)
 
ttk::TriangulationGetTriangulation (vtkDataSet *dataSet)
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVectors, vtkInformationVector *outputVector) override
 
vtkDataSet * GetOutput ()
 
vtkDataSet * GetOutput (int)
 
void SetInputData (vtkDataSet *)
 
void SetInputData (int, vtkDataSet *)
 
void AddInputData (vtkDataSet *)
 
void AddInputData (int, vtkDataSet *)
 
template<typename inputType >
int checkEmptyMPIInput (inputType *input)
 This method tests whether the input is a nullptr. If the computation is being done on multiple processes, it is possible that the domain of one process or more is empty, but not others, therefore in that particular case the rest of the filter will not be computed but an error message will not be sent.
 
- Public Member Functions inherited from ttk::Debug
 Debug ()
 
 ~Debug () override
 
virtual int setDebugLevel (const int &debugLevel)
 
int setWrapper (const Wrapper *wrapper) override
 
int printMsg (const std::string &msg, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::string > &msgs, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printErr (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printWrn (const std::string &msg, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cerr) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const double &memory, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const double &time, const int &threads, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::PERFORMANCE, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const double &progress, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::vector< std::vector< std::string > > &rows, const debug::Priority &priority=debug::Priority::INFO, const bool hasHeader=true, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
int printMsg (const debug::Separator &separator, const debug::Priority &priority, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsg (const std::string &msg, const debug::Separator &separator, const debug::LineMode &lineMode=debug::LineMode::NEW, const debug::Priority &priority=debug::Priority::INFO, std::ostream &stream=std::cout) const
 
void setDebugMsgPrefix (const std::string &prefix)
 
- Public Member Functions inherited from ttk::BaseClass
 BaseClass ()
 
virtual ~BaseClass ()=default
 
int getThreadNumber () const
 
virtual int setThreadNumber (const int threadNumber)
 
virtual int setWrapper (const Wrapper *wrapper)
 

Static Public Member Functions

static ttkArrayPreconditioningNew ()
 
static int IsTypeOf (const char *type)
 
static ttkArrayPreconditioningSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from ttkAlgorithm
static ttkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static ttkAlgorithmSafeDownCast (vtkObject *o)
 
static std::string GetOrderArrayName (vtkDataArray *const array)
 
static vtkInformationIntegerKey * SAME_DATA_TYPE_AS_INPUT_PORT ()
 

Protected Member Functions

 ttkArrayPreconditioning ()
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- Protected Member Functions inherited from ttkAlgorithm
 ttkAlgorithm ()
 
 ~ttkAlgorithm () override
 
void MPIGhostPipelinePreconditioning (vtkDataSet *input)
 
void MPIPipelinePreconditioning (vtkDataSet *input, std::vector< int > &neighbors, ttk::Triangulation *triangulation=nullptr)
 
bool checkGlobalIdValidity (ttk::LongSimplexId *globalIds, ttk::SimplexId simplexNumber, unsigned char *ghost, int *rankArray)
 
int GenerateGlobalIds (vtkDataSet *input, std::unordered_map< ttk::SimplexId, ttk::SimplexId > &vertGtoL, std::vector< int > &neighborRanks)
 
void MPITriangulationPreconditioning (ttk::Triangulation *triangulation, vtkDataSet *input)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVectors, vtkInformationVector *outputVector)
 
virtual int RequestInformation (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateTime (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestUpdateExtent (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestDataNotGenerated (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
virtual int RequestData (vtkInformation *ttkNotUsed(request), vtkInformationVector **ttkNotUsed(inputVectors), vtkInformationVector *ttkNotUsed(outputVector))
 
int FillInputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
int FillOutputPortInformation (int ttkNotUsed(port), vtkInformation *ttkNotUsed(info)) override
 
- Protected Member Functions inherited from ttk::Debug
int printMsgInternal (const std::string &msg, const std::string &right, const std::string &filler, const debug::Priority &priority=debug::Priority::INFO, const debug::LineMode &lineMode=debug::LineMode::NEW, std::ostream &stream=std::cout) const
 
int printMsgInternal (const std::string &msg, const debug::Priority &priority, const debug::LineMode &lineMode, std::ostream &stream=std::cout) const
 
int welcomeMsg (std::ostream &stream)
 
- Protected Member Functions inherited from ttk::ArrayPreconditioning
 ArrayPreconditioning ()
 
template<typename DT , typename GVGID , typename GVR , typename GVLID >
int processScalarArray (ttk::SimplexId *orderArray, const DT *scalarArray, const GVGID &getVertexGlobalId, const GVR &getVertexRank, const GVLID &getVertexLocalId, const size_t nVerts, const int burstSize, std::vector< int > neighbors={}) const
 

Additional Inherited Members

- Protected Attributes inherited from ttkAlgorithm
float CompactTriangulationCacheSize {0.2f}
 
- Protected Attributes inherited from ttk::Debug
int debugLevel_
 
std::string debugMsgPrefix_
 
std::string debugMsgNamePrefix_
 
- Protected Attributes inherited from ttk::BaseClass
bool lastObject_
 
int threadNumber_
 
Wrapperwrapper_
 
- Protected Attributes inherited from ttk::ArrayPreconditioning
bool GlobalOrder {false}
 
- Static Protected Attributes inherited from ttk::Debug
static COMMON_EXPORTS debug::LineMode lastLineMode = ttk::debug::LineMode::NEW
 

Detailed Description

TTK VTK-filter to generate order fields.

Author
Pierre Guillou pierr.nosp@m.e.gu.nosp@m.illou.nosp@m.@lip.nosp@m.6.fr
Date
September 2020

This VTK filter generates order arrays from a selection of scalar field arrays.

Parameters
InputvtkDataSet.
OutputvtkDataSet.

See the related ParaView example state files for usage examples within a VTK pipeline.

See also
ttk::ttkArrayPreconditioning
ttkAlgorithm

Definition at line 34 of file ttkArrayPreconditioning.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file ttkArrayPreconditioning.h.

Constructor & Destructor Documentation

◆ ttkArrayPreconditioning()

ttkArrayPreconditioning::ttkArrayPreconditioning ( )
protected

Definition at line 18 of file ttkArrayPreconditioning.cpp.

Member Function Documentation

◆ FillInputPortInformation()

int ttkArrayPreconditioning::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 28 of file ttkArrayPreconditioning.cpp.

◆ FillOutputPortInformation()

int ttkArrayPreconditioning::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
overrideprotected

Definition at line 37 of file ttkArrayPreconditioning.cpp.

◆ GetBurstSize()

virtual int ttkArrayPreconditioning::GetBurstSize ( )
virtual

◆ GetClassName()

virtual const char * ttkArrayPreconditioning::GetClassName ( )
virtual

Reimplemented from ttkAlgorithm.

◆ GetGlobalOrder()

virtual bool ttkArrayPreconditioning::GetGlobalOrder ( )
virtual

◆ GetPointDataArraySelection()

vtkDataArraySelection * ttkArrayPreconditioning::GetPointDataArraySelection ( )
inline

Definition at line 57 of file ttkArrayPreconditioning.h.

◆ GetRegexpString()

virtual std::string ttkArrayPreconditioning::GetRegexpString ( )
virtual

◆ GetSelectFieldsWithRegexp()

virtual bool ttkArrayPreconditioning::GetSelectFieldsWithRegexp ( )
virtual

◆ IsA()

virtual int ttkArrayPreconditioning::IsA ( const char *  type)
virtual

Reimplemented from ttkAlgorithm.

◆ IsTypeOf()

static int ttkArrayPreconditioning::IsTypeOf ( const char *  type)
static

◆ New()

static ttkArrayPreconditioning * ttkArrayPreconditioning::New ( )
static

◆ RequestData()

int ttkArrayPreconditioning::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
overrideprotected

Definition at line 46 of file ttkArrayPreconditioning.cpp.

◆ SafeDownCast()

static ttkArrayPreconditioning * ttkArrayPreconditioning::SafeDownCast ( vtkObject *  o)
static

◆ SetBurstSize()

virtual void ttkArrayPreconditioning::SetBurstSize ( int  )
virtual

◆ SetGlobalOrder()

virtual void ttkArrayPreconditioning::SetGlobalOrder ( bool  )
virtual

◆ SetRegexpString()

virtual void ttkArrayPreconditioning::SetRegexpString ( const std::string &  )
virtual

◆ SetSelectFieldsWithRegexp()

virtual void ttkArrayPreconditioning::SetSelectFieldsWithRegexp ( bool  )
virtual

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