utils Namespace Reference

Namespaces
	algorithms
	logo
	parser
	physics
	rocfft

Functions
int	warpx_mpi_thread_required ()
std::pair< int, int >	warpx_mpi_init (int argc, char *argv[])
void	warpx_mpi_finalize ()
void	warpx_check_mpi_thread_level ()
std::vector< double >	getRelativeCellPosition (amrex::MultiFab const &mf)

Function Documentation

getRelativeCellPosition()

std::vector< double > utils::getRelativeCellPosition

(

amrex::MultiFab const &

mf

)

Get the Relative Cell Position of Values in an MultiFab

Translate the IndexType of a given MultiFab into a position relative to the lower corner of a cell.

Parameters

[in]

mf

the amrex::MultiFab to get relative cell positions for

Returns

relative position to the lower corner, scaled to cell size [0.0:1.0)

warpx_check_mpi_thread_level()

void utils::warpx_check_mpi_thread_level

(

)

Check if the requested MPI thread level is valid

Prints warnings and notes otherwise.

warpx_mpi_finalize()

void utils::warpx_mpi_finalize

(

)

Finalize MPI

This function is simply a wrapper around MPI_Finalize(). It is a no-op if WarpX is compiled without MPI support.

warpx_mpi_init()

std::pair< int, int > utils::warpx_mpi_init	(	int	argc,
		char *	argv[]
	)

Initialize MPI

Returns

pair(required, provided) of MPI thread level from MPI_Init_thread

warpx_mpi_thread_required()

int utils::warpx_mpi_thread_required

(

)

Return the required MPI threading

Returns

the MPI_THREAD_* level required for MPI_Init_thread