libMesh
include
base
libmesh_base.h
Go to the documentation of this file.
1
// The libMesh Finite Element Library.
2
// Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3
4
// This library is free software; you can redistribute it and/or
5
// modify it under the terms of the GNU Lesser General Public
6
// License as published by the Free Software Foundation; either
7
// version 2.1 of the License, or (at your option) any later version.
8
9
// This library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12
// Lesser General Public License for more details.
13
14
// You should have received a copy of the GNU Lesser General Public
15
// License along with this library; if not, write to the Free Software
16
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
19
20
#ifndef LIBMESH_LIBMESH_BASE_H
21
#define LIBMESH_LIBMESH_BASE_H
22
23
#include "libmesh/id_types.h"
24
25
namespace
libMesh
{
26
30
processor_id_type
global_n_processors
();
31
36
processor_id_type
global_processor_id
();
37
41
unsigned
int
n_threads
();
42
50
namespace
libMeshPrivateData {
51
#ifdef LIBMESH_HAVE_MPI
52
55
extern
processor_id_type
_n_processors
;
56
60
extern
processor_id_type
_processor_id
;
61
#endif
62
66
extern
int
_n_threads
;
67
}
68
}
69
70
71
72
// ------------------------------------------------------------
73
// libMesh inline member functions
74
inline
75
libMesh::processor_id_type
libMesh::global_n_processors
()
76
{
77
#ifdef LIBMESH_HAVE_MPI
78
return
libMeshPrivateData::_n_processors
;
79
#else
80
return
1;
81
#endif
82
}
83
84
inline
85
libMesh::processor_id_type
libMesh::global_processor_id
()
86
{
87
#ifdef LIBMESH_HAVE_MPI
88
return
libMeshPrivateData::_processor_id
;
89
#else
90
return
0;
91
#endif
92
}
93
94
95
inline
96
unsigned
int
libMesh::n_threads
()
97
{
98
return
static_cast<unsigned int>(
libMeshPrivateData::_n_threads
);
99
}
100
101
102
// We now put everything we can into a separate libMesh namespace;
103
// code which forward declares libMesh classes or which specializes
104
// libMesh templates may want to know whether it is compiling under
105
// such conditions, to be backward compatible with older libMesh
106
// versions:
107
#define LIBMESH_USE_SEPARATE_NAMESPACE 1
108
109
110
// Unless configured otherwise, we import all of namespace libMesh,
111
// for backwards compatibility with pre-namespaced codes.
112
113
#ifndef LIBMESH_REQUIRE_SEPARATE_NAMESPACE
114
using namespace
libMesh
;
115
#endif
116
117
118
#endif // LIBMESH_LIBMESH_BASE_H
libMesh::global_n_processors
processor_id_type global_n_processors()
Definition:
libmesh_base.h:75
libMesh::libMeshPrivateData::_processor_id
processor_id_type _processor_id
The local processor id.
Definition:
libmesh.C:243
libMesh::n_threads
unsigned int n_threads()
Definition:
libmesh_base.h:96
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition:
factoryfunction.C:55
libMesh::libMeshPrivateData::_n_threads
int _n_threads
Total number of threads possible.
Definition:
libmesh.C:245
libMesh::processor_id_type
uint8_t processor_id_type
Definition:
id_types.h:104
libMesh::libMeshPrivateData::_n_processors
processor_id_type _n_processors
Total number of processors used.
Definition:
libmesh.C:242
libMesh::global_processor_id
processor_id_type global_processor_id()
Definition:
libmesh_base.h:85
Generated on Sat Jan 25 2020 12:06:52 for libMesh by
1.8.16