Info

Functions for getting debugging information. More...

Functions
void	getQuESTEnvironmentString (char str[200])

Detailed Description

Functions for getting debugging information.

Function Documentation

getQuESTEnvironmentString()

void getQuESTEnvironmentString

(

char

str[200]

)

Writes a compact description of the active QuEST environment into str.

The caller must provide a character buffer of length at least 200. The resulting string is null-terminated and summarises the current deployment.

Parameters

[out]

str

a character buffer of length 200 to overwrite.

Exceptions

error

if the QuEST environment is not initialised.

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Author

Tyson Jones

Definition at line 529 of file environment.cpp.

                                              {
    validate_envIsInit(__func__);
 
    int numThreads = cpu_isOpenmpCompiled()? cpu_getAvailableNumThreads() : 1;
    int cuQuantum = global_envPtr->isGpuAccelerated && gpu_isCuQuantumCompiled();
    int gpuDirect = global_envPtr->isGpuAccelerated && gpu_isDirectGpuCommPossible();
 
    snprintf(str, 200, "CUDA=%d OpenMP=%d MPI=%d userOwnsMPI=%d threads=%d ranks=%d cuQuantum=%d gpuDirect=%d",
        global_envPtr->isGpuAccelerated,
        global_envPtr->isMultithreaded,
        global_envPtr->isDistributed,
        global_envPtr->isMpiUserOwned,
        numThreads,
        global_envPtr->numNodes,
        cuQuantum,
        gpuDirect);
}