Proto
Functions
BoxData Writer

Functions

const char * Proto::WriteBoxData (BoxData< double > &a_array, double dx=1.0)
 Write Scalar BoxData. More...
 
void Proto::WriteBoxData (const char *a_filename, BoxData< double > &a_array, double dx=1.0)
 Write Scalar BoxData with Name. More...
 
template<class T , unsigned int C, MemType MEMTYPE, unsigned char D, unsigned char E>
void Proto::WriteBoxData (const char *a_filename, BoxData< T, C, MEMTYPE, D, E > &a_array, const char *const a_varnames[C *D *E], const double *a_corner, const double &a_h)
 Write Non-Scalar BoxData with Name. More...
 
template<class T , unsigned int C, MemType MEMTYPE, unsigned char D, unsigned char E>
void Proto::WriteBoxData (FILE *a_fp, BoxData< T, C, MEMTYPE, D, E > &a_array, const char *const a_varnames[C *D *E], const double *a_corner, const double &a_h)
 Write Non-Scalar BoxData to Existing File. More...
 

Detailed Description

Function Documentation

◆ WriteBoxData() [1/4]

const char * Proto::WriteBoxData ( BoxData< double > &  a_array,
double  dx = 1.0 
)
inline

Write Scalar BoxData.

Write's the data in a BoxData<double> to a default named .vtk file.

Parameters
a_arrayThe BoxData to be printed.
dx(Optional) Physical spacing between points in a_array. (default: 1)

◆ WriteBoxData() [2/4]

void Proto::WriteBoxData ( const char *  a_filename,
BoxData< double > &  a_array,
double  dx = 1.0 
)
inline

Write Scalar BoxData with Name.

Write's the data in a BoxData<double> to a given file name. The given filename should include the relevent extension. (e.g. name.vtk)

Parameters
a_filenameName of output file
a_arrayThe BoxData to be printed.
dx(Optional) Physical spacing between points in a_array. (default: 1)

◆ WriteBoxData() [3/4]

template<class T , unsigned int C, MemType MEMTYPE, unsigned char D, unsigned char E>
void Proto::WriteBoxData ( const char *  a_filename,
BoxData< T, C, MEMTYPE, D, E > &  a_array,
const char *const  a_varnames[C *D *E],
const double *  a_corner,
const double &  a_h 
)
inline

Write Non-Scalar BoxData with Name.

Write's the data in a BoxData<T,C,D,E> to a given file name. The given filename should include the relevent extension. (e.g. name.vtk)

Parameters
a_filenameName of output file
a_arrayThe BoxData to be printed.
a_varnamesArray of strings corresponding to the variable names of a_array.
a_cornerDIM long array of doubles defining the desired origin
a_hPhysical spacing between points

◆ WriteBoxData() [4/4]

template<class T , unsigned int C, MemType MEMTYPE, unsigned char D, unsigned char E>
void Proto::WriteBoxData ( FILE *  a_fp,
BoxData< T, C, MEMTYPE, D, E > &  a_array,
const char *const  a_varnames[C *D *E],
const double *  a_corner,
const double &  a_h 
)
inline

Write Non-Scalar BoxData to Existing File.

Write's the data in a BoxData<T,C,D,E> to an existing file.

Parameters
a_filenameName of output file
a_arrayThe BoxData to be printed.
a_varnamesArray of strings corresponding to the variable names of a_array.
a_cornerDIM long array of doubles defining the desired origin
a_hPhysical spacing between points