domain Namespace Reference

Container for ELA Data including its physical structure. More...

Classes
struct	Domain
	A wrapper for global ELA data. More...
class	MPIDomain
	An extension of Domain for parallelization with MPI. More...

Enumerations
enum	Face {   iMinus , jMinus , kMinus , iPlus ,   jPlus , kPlus }
	Corresponds to each of the six faces of the domain.

Functions
std::size_t	getCompressedSize (const fields::Helper< svec::SVector > &slice)
	The size of the compressed data (in bytes)
void	compress (void *const buff, const fields::Helper< svec::SVector > &slice)
	Compress the data in the slice.
void	decompress (const void *const buff, const fields::Helper< svec::SVector > &slice)
	Decompress the data in the buff.
constexpr Face	getOppositeFace (const Face &f)
	Get the Face opposite to Face f.

Detailed Description

Container for ELA Data including its physical structure.

Function Documentation

compress()

void domain::compress	(	void *const	buff,
		const fields::Helper< svec::SVector > &	slice
	)

Compress the data in the slice.

Parameters

[out]	buff	The buffer to fill with the compressed data
[in]	slice	The data to compress

decompress()

void domain::decompress	(	const void *const	buff,
		const fields::Helper< svec::SVector > &	slice
	)

Decompress the data in the buff.

Parameters

[in]	buff	The buffer with the compressed data
[out]	slice	The slice to fill

getCompressedSize()

std::size_t domain::getCompressedSize

(

const fields::Helper< svec::SVector > &

slice

)

The size of the compressed data (in bytes)

When calling compress() with the slice, this is how much space will be used in buff

Parameters

[in]

slice

Returns

std::size_t

getOppositeFace()

constexpr Face domain::getOppositeFace ( const Face &  f )

constexpr

Get the Face opposite to Face f.

For example getOppositeFace(Face::iMinus) will return Face::iPlus.

Parameters

f

Returns

constexpr Face