Macros | Typedefs | Enumerations | Functions | Variables
VPICDefinition.h File Reference
#include <vtksys/Configure.h>
#include <string>
#include <iostream>
#include "vtkABI.h"
Include dependency graph for VPICDefinition.h:

Go to the source code of this file.

Macros

#define BUILD_SHARED_LIBS
 
#define VPIC_EXPORT   VTK_ABI_IMPORT
 
#define vpicNotUsed(x)
 
#define WORDSIZE   8
 

Typedefs

typedef float GRID_T
 

Enumerations

enum  NEIGHBOR {
  X0, X1, Y0, Y1,
  Z0, Z1, X0_Y0, X1_Y1,
  X0_Y1, X1_Y0, Y0_Z0, Y1_Z1,
  Y0_Z1, Y1_Z0, Z0_X0, Z1_X1,
  Z0_X1, Z1_X0, X0_Y0_Z0, X1_Y1_Z1,
  X0_Y0_Z1, X1_Y1_Z0, X0_Y1_Z0, X1_Y0_Z1,
  X0_Y1_Z1, X1_Y0_Z0
}
 

Functions

string readString (FILE *filePtr, int size)
 
void readData (bool littleEndian, unsigned short *data, unsigned long dataSize, unsigned long dataCount, FILE *fp)
 
void readData (bool littleEndian, int *data, unsigned long dataSize, unsigned long dataCount, FILE *fp)
 
void readData (bool littleEndian, float *data, unsigned long dataSize, unsigned long dataCount, FILE *fp)
 
void readData (bool littleEndian, double *data, unsigned long dataSize, unsigned long dataCount, FILE *fp)
 
int GCD (int a, int b)
 
template<class outDataType >
void BinaryWrite (ostream &outStream, const outDataType &outData)
 
template<class inHolderType >
istream & BinaryRead (istream &inStream, inHolderType &inHolder)
 

Variables

const int LINESIZE = 1024
 
const int VPIC_OK = 0
 
const int VPIC_FAIL = 1
 
const int NONE = -1
 
const double MIN_FLOAT = -1e07
 
const double MAX_FLOAT = 1e07
 
const int VPIC_FIELD = 1
 
const int VPIC_HYDRO = 2
 
const int DIMENSION = 3
 
const int TENSOR_DIMENSION = 6
 
const int TENSOR9_DIMENSION = 9
 
const int CONSTANT = 0
 
const int SCALAR = 1
 
const int VECTOR = 2
 
const int TENSOR = 3
 
const int TENSOR9 = 4
 
const int FLOAT = 0
 
const int INTEGER = 1
 
const int NUM_OF_NEIGHBORS = 26
 

Macro Definition Documentation

◆ BUILD_SHARED_LIBS

#define BUILD_SHARED_LIBS

Definition at line 12 of file VPICDefinition.h.

◆ VPIC_EXPORT

#define VPIC_EXPORT   VTK_ABI_IMPORT

Definition at line 19 of file VPICDefinition.h.

◆ vpicNotUsed

#define vpicNotUsed (   x)

Definition at line 25 of file VPICDefinition.h.

◆ WORDSIZE

#define WORDSIZE   8

Definition at line 28 of file VPICDefinition.h.

Typedef Documentation

◆ GRID_T

typedef float GRID_T

Definition at line 55 of file VPICDefinition.h.

Enumeration Type Documentation

◆ NEIGHBOR

enum NEIGHBOR
Enumerator
X0 
X1 
Y0 
Y1 
Z0 
Z1 
X0_Y0 
X1_Y1 
X0_Y1 
X1_Y0 
Y0_Z0 
Y1_Z1 
Y0_Z1 
Y1_Z0 
Z0_X0 
Z1_X1 
Z0_X1 
Z1_X0 
X0_Y0_Z0 
X1_Y1_Z1 
X0_Y0_Z1 
X1_Y1_Z0 
X0_Y1_Z0 
X1_Y0_Z1 
X0_Y1_Z1 
X1_Y0_Z0 

Definition at line 65 of file VPICDefinition.h.

Function Documentation

◆ readString()

string readString ( FILE *  filePtr,
int  size 
)

◆ readData() [1/4]

void readData ( bool  littleEndian,
unsigned short *  data,
unsigned long  dataSize,
unsigned long  dataCount,
FILE *  fp 
)

◆ readData() [2/4]

void readData ( bool  littleEndian,
int data,
unsigned long  dataSize,
unsigned long  dataCount,
FILE *  fp 
)

◆ readData() [3/4]

void readData ( bool  littleEndian,
float data,
unsigned long  dataSize,
unsigned long  dataCount,
FILE *  fp 
)

◆ readData() [4/4]

void readData ( bool  littleEndian,
double data,
unsigned long  dataSize,
unsigned long  dataCount,
FILE *  fp 
)

◆ GCD()

int GCD ( int  a,
int  b 
)

◆ BinaryWrite()

template<class outDataType >
void BinaryWrite ( ostream &  outStream,
const outDataType &  outData 
)
inline

Definition at line 149 of file VPICDefinition.h.

◆ BinaryRead()

template<class inHolderType >
istream& BinaryRead ( istream &  inStream,
inHolderType &  inHolder 
)
inline

Definition at line 157 of file VPICDefinition.h.

Variable Documentation

◆ LINESIZE

const int LINESIZE = 1024

Definition at line 29 of file VPICDefinition.h.

◆ VPIC_OK

const int VPIC_OK = 0

Definition at line 31 of file VPICDefinition.h.

◆ VPIC_FAIL

const int VPIC_FAIL = 1

Definition at line 32 of file VPICDefinition.h.

◆ NONE

const int NONE = -1

Definition at line 34 of file VPICDefinition.h.

◆ MIN_FLOAT

const double MIN_FLOAT = -1e07

Definition at line 36 of file VPICDefinition.h.

◆ MAX_FLOAT

const double MAX_FLOAT = 1e07

Definition at line 37 of file VPICDefinition.h.

◆ VPIC_FIELD

const int VPIC_FIELD = 1

Definition at line 39 of file VPICDefinition.h.

◆ VPIC_HYDRO

const int VPIC_HYDRO = 2

Definition at line 40 of file VPICDefinition.h.

◆ DIMENSION

const int DIMENSION = 3

Definition at line 42 of file VPICDefinition.h.

◆ TENSOR_DIMENSION

const int TENSOR_DIMENSION = 6

Definition at line 43 of file VPICDefinition.h.

◆ TENSOR9_DIMENSION

const int TENSOR9_DIMENSION = 9

Definition at line 44 of file VPICDefinition.h.

◆ CONSTANT

const int CONSTANT = 0

Definition at line 46 of file VPICDefinition.h.

◆ SCALAR

const int SCALAR = 1

Definition at line 47 of file VPICDefinition.h.

◆ VECTOR

const int VECTOR = 2

Definition at line 48 of file VPICDefinition.h.

◆ TENSOR

const int TENSOR = 3

Definition at line 49 of file VPICDefinition.h.

◆ TENSOR9

const int TENSOR9 = 4

Definition at line 50 of file VPICDefinition.h.

◆ FLOAT

const int FLOAT = 0

Definition at line 52 of file VPICDefinition.h.

◆ INTEGER

const int INTEGER = 1

Definition at line 53 of file VPICDefinition.h.

◆ NUM_OF_NEIGHBORS

const int NUM_OF_NEIGHBORS = 26

Definition at line 107 of file VPICDefinition.h.