Reference documentation for deal.II version GIT relicensing-1182-g1782d71672 2024-07-22 00:00: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 | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes | List of all members
InitFinalize Class Reference

#include <deal.II/base/init_finalize.h>

Inheritance diagram for InitFinalize:
Inheritance graph


struct  Signals

Public Member Functions

 InitFinalize (int &argc, char **&argv, const InitializeLibrary &libraries, const unsigned int max_num_threads=numbers::invalid_unsigned_int)
 ~InitFinalize ()
void finalize ()

Static Public Member Functions

static void register_request (MPI_Request &request)
static void unregister_request (MPI_Request &request)

Static Public Attributes

static Signals signals = InitFinalize::Signals()

Private Attributes

InitializeLibrary libraries
bool is_finalized = false
bool finalize_petscslepc

Static Private Attributes

static std::set< MPI_Request * > requests

Detailed Description

A class that is used to initialize and finalize deal.II and the external libraries requested by the user.

Definition at line 98 of file init_finalize.h.

Constructor & Destructor Documentation

◆ InitFinalize()

InitFinalize::InitFinalize ( int argc,
char **&  argv,
const InitializeLibrary libraries,
const unsigned int  max_num_threads = numbers::invalid_unsigned_int 

Initialize deal.II and the requested external libraries.

This function calls MultithreadInfo::set_thread_limit() with either max_num_threads or, following the discussion above, a number of threads equal to the number of cores allocated to this MPI process. However, MultithreadInfo::set_thread_limit() in turn also evaluates the environment variable DEAL_II_NUM_THREADS. Finally, the worker threads can only be created on cores to which the current MPI process has access to; some MPI implementations limit the number of cores each process may access to one or a subset of cores in order to ensure better cache behavior. Consequently, the number of threads that will really be created will be the minimum of the argument passed here, the environment variable (if set), and the number of cores accessible to the thread.
MultithreadInfo::set_thread_limit() can only work if it is called before any threads are created. The safest place for a call to it is therefore at the beginning of main(). Consequently, this extends to the current class: the best place to create an object of this type is also at or close to the top of main().

Definition at line 63 of file

◆ ~InitFinalize()

InitFinalize::~InitFinalize ( )

Destructor. Finalize deal.II and the external libraries initialize by deal.II.

Definition at line 449 of file

Member Function Documentation

◆ finalize()

void InitFinalize::finalize ( )

Finalize deal.II and the external libraries initialize by deal.II.

Definition at line 334 of file

◆ register_request()

void InitFinalize::register_request ( MPI_Request &  request)

Register a reference to an MPI_Request on which we need to call MPI_Wait before calling MPI_Finalize.

The object request needs to exist when MPI_Finalize is called, which means the request is typically statically allocated. Otherwise, you need to call unregister_request() before the request goes out of scope. Note that it is acceptable for a request to be already waited on (and consequently reset to MPI_REQUEST_NULL).

It is acceptable to call this function more than once with the same instance (as it is done in the example below).

Typically, this function is used by CollectiveMutex and not directly, but it can also be used directly like this:

static MPI_Request request = MPI_REQUEST_NULL;
// [some algorithm that is not safe to be executed twice in a row.]
MPI_IBarrier(comm, &request);
*braid_SplitCommworld & comm

Definition at line 309 of file

◆ unregister_request()

void InitFinalize::unregister_request ( MPI_Request &  request)

Unregister a request previously added using register_request().

Definition at line 318 of file

Member Data Documentation

◆ signals

InitFinalize::Signals InitFinalize::signals = InitFinalize::Signals()

Definition at line 202 of file init_finalize.h.

◆ libraries

InitializeLibrary InitFinalize::libraries

Definition at line 205 of file init_finalize.h.

◆ requests

std::set< MPI_Request * > InitFinalize::requests

Requests to MPI_Wait before finalizing

Definition at line 210 of file init_finalize.h.

◆ is_finalized

bool InitFinalize::is_finalized = false

Definition at line 212 of file init_finalize.h.

◆ finalize_petscslepc

bool InitFinalize::finalize_petscslepc

Definition at line 215 of file init_finalize.h.

The documentation for this class was generated from the following files: