ParaView
CAdaptorAPI.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: CAdaptorAPI.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 #ifndef CAdaptorAPI_h
16 #define CAdaptorAPI_h
17 
18 #include "vtkPVCatalystModule.h"
19 
20 // This code is meant to be used as an API for C simulation
21 // codes. To use with C codes, include this header file. Call the
22 // 'extern "C"' functions as named below for both Fortran and C.
23 // C code should include this header file to get the properly
24 // mangled function names.
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30  // call at the start of the simulation
31  void VTKPVCATALYST_EXPORT coprocessorinitialize();
32 
33  // call at the end of the simulation
34  void VTKPVCATALYST_EXPORT coprocessorfinalize();
35 
36  // this is the function that determines whether or not there
37  // is anything to coprocess this time step
38  void VTKPVCATALYST_EXPORT requestdatadescription(int* timeStep, double* time,
39  int* coprocessThisTimeStep);
40 
41  // this function sets needgrid to 1 if it does not have a copy of the grid
42  // it sets needgrid to 0 if it does have a copy of the grid but does not
43  // check if the grid is modified or needs to be updated
44  void VTKPVCATALYST_EXPORT needtocreategrid(int* needGrid);
45 
46  // do the actual coprocessing. it is assumed that the vtkCPDataDescription
47  // has been filled in elsewhere.
48  void VTKPVCATALYST_EXPORT coprocess();
49 
50 #ifdef __cplusplus
51 } /* extern "C" */
52 #endif
53 
54 #endif
55 // VTK-HeaderTest-Exclude: CAdaptorAPI.h
void VTKPVCATALYST_EXPORT needtocreategrid(int *needGrid)
void VTKPVCATALYST_EXPORT coprocessorfinalize()
void VTKPVCATALYST_EXPORT coprocess()
void VTKPVCATALYST_EXPORT coprocessorinitialize()
void VTKPVCATALYST_EXPORT requestdatadescription(int *timeStep, double *time, int *coprocessThisTimeStep)