ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCPProcessor Class Reference

There are 3 distinct phases for the operation of a co-processor. More...

#include <vtkCPProcessor.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int AddPipeline (vtkCPPipeline *pipeline)
 Add in a pipeline that is externally configured. More...
 
virtual int GetNumberOfPipelines ()
 Get the number of pipelines. More...
 
virtual vtkCPPipelineGetPipeline (int which)
 Return a specific pipeline. More...
 
virtual void RemovePipeline (vtkCPPipeline *pipeline)
 Remove pipelines. More...
 
virtual void RemoveAllPipelines ()
 
virtual int Initialize ()
 Initialize the co-processor. More...
 
virtual int Initialize (vtkMPICommunicatorOpaqueComm &comm)
 
virtual int RequestDataDescription (vtkCPDataDescription *dataDescription)
 Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise. More...
 
virtual int CoProcess (vtkCPDataDescription *dataDescription)
 Processing Step: Provides the grid and the field data for the co-procesor to process. More...
 
virtual int Finalize ()
 Called after all co-processing is complete giving the Co-Processor implementation an opportunity to clean up, before it is destroyed. More...
 

Static Public Member Functions

static vtkCPProcessorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCPProcessorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkCPProcessor ()
 
virtual ~vtkCPProcessor ()
 
virtual vtkObject * NewInitializationHelper ()
 Create a new instance of the InitializationHelper. More...
 

Detailed Description

There are 3 distinct phases for the operation of a co-processor.


1) Initialization – set up for the run.
2) Processing – the run.
3) Finalization – clean up before exit.
The processing phase occurs repeatedly and is composed of two distinct steps, namely 1) Configuration (see vtkCPProcessor::ProcessDataDescription) and 2) Processing (see vtkCPProcessor::ProcessData).

Configuration step:
In the first step the Co-Processor implemntation is called with a vtkDataDescription describing the data that the simulation can provide This gives the Co-Processor implemntation a chance to identify what (if any) of the available data it will process during this pass. By default all of the avaible data is selected, so that if the Co-Processor implementation does nothing it will receive all data during the Processing step. The Co-Processor implementation should extract what ever meta-data it will need (or alternatively can save a reference to the DataDescription), during the Processing step.

Processing step:
In the second step the Co-Processor implementation is called with the actual data that it has been asked to provide, if any. If no data was selected during the Configuration Step than the priovided vtkDataObject may be NULL.

Definition at line 57 of file vtkCPProcessor.h.

Member Typedef Documentation

§ Superclass

typedef vtkObject vtkCPProcessor::Superclass

Definition at line 61 of file vtkCPProcessor.h.

Constructor & Destructor Documentation

§ vtkCPProcessor()

vtkCPProcessor::vtkCPProcessor ( )
protected

§ ~vtkCPProcessor()

virtual vtkCPProcessor::~vtkCPProcessor ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkCPProcessor* vtkCPProcessor::New ( )
static

§ GetClassName()

virtual const char* vtkCPProcessor::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

void vtkCPProcessor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ AddPipeline()

virtual int vtkCPProcessor::AddPipeline ( vtkCPPipeline pipeline)
virtual

Add in a pipeline that is externally configured.

Returns 1 if successful and 0 otherwise.

§ GetNumberOfPipelines()

virtual int vtkCPProcessor::GetNumberOfPipelines ( )
virtual

Get the number of pipelines.

§ GetPipeline()

virtual vtkCPPipeline* vtkCPProcessor::GetPipeline ( int  which)
virtual

Return a specific pipeline.

§ RemovePipeline()

virtual void vtkCPProcessor::RemovePipeline ( vtkCPPipeline pipeline)
virtual

Remove pipelines.

§ RemoveAllPipelines()

virtual void vtkCPProcessor::RemoveAllPipelines ( )
virtual

§ Initialize() [1/2]

virtual int vtkCPProcessor::Initialize ( )
virtual

Initialize the co-processor.

Returns 1 if successful and 0 otherwise. otherwise. If Catalyst is built with MPI then Initialize() can also be called with a specific MPI communicator if MPI_COMM_WORLD isn't the proper one. Catalyst is initialized to use MPI_COMM_WORLD by default.

§ Initialize() [2/2]

virtual int vtkCPProcessor::Initialize ( vtkMPICommunicatorOpaqueComm &  comm)
virtual

§ RequestDataDescription()

virtual int vtkCPProcessor::RequestDataDescription ( vtkCPDataDescription dataDescription)
virtual

Configuration Step: The coprocessor first determines if any coprocessing needs to be done at this TimeStep/Time combination returning 1 if it does and 0 otherwise.

If coprocessing does need to be performed this time step it fills in the FieldNames array that the coprocessor requires in order to fulfill all the coprocessing requests for this TimeStep/Time combination.

§ CoProcess()

virtual int vtkCPProcessor::CoProcess ( vtkCPDataDescription dataDescription)
virtual

Processing Step: Provides the grid and the field data for the co-procesor to process.

Return value is 1 for success and 0 for failure.

§ Finalize()

virtual int vtkCPProcessor::Finalize ( )
virtual

Called after all co-processing is complete giving the Co-Processor implementation an opportunity to clean up, before it is destroyed.

§ NewInitializationHelper()

virtual vtkObject* vtkCPProcessor::NewInitializationHelper ( )
protectedvirtual

Create a new instance of the InitializationHelper.


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