Reference documentation for deal.II version GIT relicensing-870-g40dcf97519 2024-06-20 23:40:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Classes | Functions
Utilities::System Namespace Reference


struct  MemoryStats


double get_cpu_load ()
std::string get_current_vectorization_level ()
void get_memory_stats (MemoryStats &stats)
std::string get_hostname ()
std::string get_time ()
std::string get_date ()
void posix_memalign (void **memptr, std::size_t alignment, std::size_t size)
bool job_supports_mpi ()

Detailed Description

A namespace for utility functions that probe system properties.

Function Documentation

◆ get_cpu_load()

double Utilities::System::get_cpu_load ( )

Return the CPU load as returned by "uptime". Note that the interpretation of this number depends on the actual number of processors in the machine. This is presently only implemented on Linux, using the /proc/loadavg pseudo-file, on other systems we simply return zero.

Definition at line 930 of file

◆ get_current_vectorization_level()

std::string Utilities::System::get_current_vectorization_level ( )

Return the instruction set extension for vectorization as described by DEAL_II_VECTORIZATION_WIDTH_IN_BITS in vectorization.h as a string. The list of possible return values is:

VECTORIZATION_LEVEL Return Value Width in bits
0 disabled 64
1 SSE2/AltiVec 128
2 AVX 256
3 AVX512 512

Definition at line 938 of file

◆ get_memory_stats()

void Utilities::System::get_memory_stats ( MemoryStats stats)

Fill the stats structure with information about the memory consumption of this process. This is only implemented on Linux.

Definition at line 964 of file

◆ get_hostname()

std::string Utilities::System::get_hostname ( )

Return the name of the host this process runs on.

Definition at line 998 of file

◆ get_time()

std::string Utilities::System::get_time ( )

Return the present time as HH:MM:SS.

Definition at line 1013 of file

◆ get_date()

std::string Utilities::System::get_date ( )

Return the present date as YYYY/MM/DD. MM and DD may be either one or two digits.

Definition at line 1029 of file

◆ posix_memalign()

void Utilities::System::posix_memalign ( void **  memptr,
std::size_t  alignment,
std::size_t  size 

Call the system function posix_memalign, or a replacement function if not available, to allocate memory with a certain minimal alignment. The first argument will then return a pointer to this memory block that can be released later on through a standard free call.

memptrThe address of a pointer variable that will after this call point to the allocated memory.
alignmentThe minimal alignment of the memory block, in bytes.
sizeThe size of the memory block to be allocated, in bytes.
This function checks internally for error codes, rather than leaving this task to the calling site.

Definition at line 1044 of file

◆ job_supports_mpi()

bool Utilities::System::job_supports_mpi ( )

Definition at line 1063 of file