libMesh
Loading...
Searching...
No Matches
libmesh_base.h
Go to the documentation of this file.
1// The libMesh Finite Element Library.
2// Copyright (C) 2002-2026 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
25namespace libMesh {
26
31
37
41unsigned int n_threads();
42
48unsigned int default_grainsize();
49
57namespace libMeshPrivateData {
58#ifdef LIBMESH_HAVE_MPI
63
68#endif
69
73extern int _n_threads;
74
79extern unsigned int _default_grainsize;
80}
81}
82
83
84
85// ------------------------------------------------------------
86// libMesh inline member functions
87inline
89{
90#ifdef LIBMESH_HAVE_MPI
92#else
93 return 1;
94#endif
95}
96
97inline
99{
100#ifdef LIBMESH_HAVE_MPI
102#else
103 return 0;
104#endif
105}
106
107
108inline
109unsigned int libMesh::n_threads()
110{
111 return static_cast<unsigned int>(libMeshPrivateData::_n_threads);
112}
113
114
115
116inline
121
122
123
124// We now put everything we can into a separate libMesh namespace;
125// code which forward declares libMesh classes or which specializes
126// libMesh templates may want to know whether it is compiling under
127// such conditions, to be backward compatible with older libMesh
128// versions:
129#define LIBMESH_USE_SEPARATE_NAMESPACE 1
130
131
132// Unless configured otherwise, we import all of namespace libMesh,
133// for backwards compatibility with pre-namespaced codes.
134
135#ifndef LIBMESH_REQUIRE_SEPARATE_NAMESPACE
136using namespace libMesh;
137#endif
138
139
140#endif // LIBMESH_LIBMESH_BASE_H
processor_id_type _n_processors
Total number of processors used.
Definition libmesh.C:300
unsigned int _default_grainsize
Minimum number of elements/nodes/indices per thread above which we can split work onto more threads.
Definition libmesh.C:304
processor_id_type _processor_id
The local processor id.
Definition libmesh.C:301
int _n_threads
Total number of threads possible.
Definition libmesh.C:303
The libMesh namespace provides an interface to certain functionality in the library.
unsigned int default_grainsize()
processor_id_type global_processor_id()
processor_id_type global_n_processors()
uint8_t processor_id_type
Definition id_types.h:104
unsigned int n_threads()