ug4
pcl_base.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__PCL__PCL_BASE__
34 #define __H__PCL__PCL_BASE__
35 
36 namespace pcl
37 {
38 
41 
43 
46 void DisableMPIInit ();
47 
49 void Init(int *argcp, char ***argvp);
50 
52 void Abort(int errorcode = 1);
53 
55 void Finalize();
56 
58 int NumProcs();
59 
61 int ProcRank();
62 
64 void SetErrHandler();
65 
66 // end group pcl
68 
69 }// end of namespace
70 #endif
int ProcRank()
returns the rank of the process
Definition: pcl_base.cpp:83
void SetErrHandler()
sets error handler
Definition: pcl_base.cpp:116
int NumProcs()
returns the number of processes
Definition: pcl_base.cpp:91
void Finalize()
call this method right before quitting your application
Definition: pcl_base.cpp:75
void Init(int *argcp, char ***argvp)
call this method before any other pcl-operations.
Definition: pcl_base.cpp:51
void Abort(int errorcode)
call this method to abort all mpi processes
Definition: pcl_base.cpp:68
void DisableMPIInit()
call this method before 'Init' to avoid a call to MPI_Init.
Definition: pcl_base.cpp:45
Definition: parallel_grid_layout.h:46