UGIO.H File Reference

#include <string>
#include "LevelData.H"
#include "REAL.H"
#include "Vector.H"
#include "FArrayBox.H"
#include "IntVectSet.H"
#include "NamespaceHeader.H"
#include "NamespaceFooter.H"

Include dependency graph for UGIO.H:

Go to the source code of this file.

Macros
#define	_UGIO_H_

Functions
void	WriteUGHDF5 (const string &a_filename, const DisjointBoxLayout &a_grids, const LevelData< FArrayBox > &a_data, const Box &a_domain)
	Write single-level of data in HDF5 format. More...
void	WriteUGHDF5 (HDF5Handle &a_handle, const DisjointBoxLayout &a_grids, const LevelData< FArrayBox > &a_data, const Box &a_domain)
	Write a single level of data in HDF5 format. More...
int	ReadUGHDF5 (const string &a_filename, DisjointBoxLayout &a_grids, LevelData< FArrayBox > &a_data, Box &a_domain)
	Reads a level of data in HDF5 format. More...
int	ReadUGHDF5 (HDF5Handle &a_handle, DisjointBoxLayout &a_grids, LevelData< FArrayBox > &a_data, Box &a_domain)
	This is the handle version of ReadUGHDF5. More...

Macro Definition Documentation

_UGIO_H_

#define _UGIO_H_

Function Documentation

WriteUGHDF5() [1/2]

void WriteUGHDF5	(	const string &	a_filename,
		const DisjointBoxLayout &	a_grids,
		const LevelData< FArrayBox > &	a_data,
		const Box &	a_domain
	)

Write single-level of data in HDF5 format.

Writes a single level in HDF5 format. Only available if the preprocessor macro HDF5 is defined at compilation. This is blocking.

Arguments:

• a_filename: file to output to.
• a_grid : grids
• a_data : data
• a_names : names of variables.
• a_domain : domain of level.

WriteUGHDF5() [2/2]

void WriteUGHDF5	(	HDF5Handle &	a_handle,
		const DisjointBoxLayout &	a_grids,
		const LevelData< FArrayBox > &	a_data,
		const Box &	a_domain
	)

Write a single level of data in HDF5 format.

Writes a single level in HDF5 format. Only available if the preprocessor macro HDF5 is defined at compilation. This is the hdf5 handle version and is not blocking.

Arguments:

• a_handle: handle to output to.
• a_grid : grids
• a_data : data
• a_names : names of variables.
• a_domain: domain of level.

ReadUGHDF5() [1/2]

int ReadUGHDF5	(	const string &	a_filename,
		DisjointBoxLayout &	a_grids,
		LevelData< FArrayBox > &	a_data,
		Box &	a_domain
	)

Reads a level of data in HDF5 format.

Only available if the preprocessor macro HDF5 is defined at compilation. Returns 0 on success. This is blocking.

Arguments:

• a_filename: file to input from.
• a_grids : grids
• a_data : data
• a_domain : domain

Returns:

• status code with values:
  • 0: success
  • -1: bogus number of levels
  • -2: bogus number of components
  • -3: error in readlevel
  • -4: file open failed

ReadUGHDF5() [2/2]

int ReadUGHDF5	(	HDF5Handle &	a_handle,
		DisjointBoxLayout &	a_grids,
		LevelData< FArrayBox > &	a_data,
		Box &	a_domain
	)

This is the handle version of ReadUGHDF5.

This is not blocking. Reads a level of data in HDF5 format. Only available if the preprocessor macro HDF5 is defined at compilation. Returns 0 on success.

Arguments:

• a_handle: hdf5 handle to input from.
• a_grids : grids
• a_data : data
• a_domain: domain

Returns:

• status code with values:
  • 0: success
  • -1: bogus number of levels
  • -2: bogus number of components
  • -3: error in readlevel
  • -4: file open failed