libMesh
parallel_object.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_PARALLEL_OBJECT_H
21 #define LIBMESH_PARALLEL_OBJECT_H
22 
23 
24 // Local includes
25 #include "libmesh/parallel.h"
26 
27 // Macro to identify and debug functions which should only be called in
28 // parallel on every processor at once
29 #undef parallel_object_only
30 #ifndef NDEBUG
31 #define parallel_object_only() libmesh_parallel_only(this->comm())
32 #else
33 #define parallel_object_only() ((void) 0)
34 #endif
35 
36 
37 namespace libMesh
38 {
51 {
52 public:
53 
59  _communicator(comm_in)
60  {}
61 
65  ParallelObject (const ParallelObject & other) :
67  {}
68 
74  ParallelObject & operator= (const ParallelObject & libmesh_dbg_var(other))
75  {
76  libmesh_assert_equal_to (&_communicator, &other._communicator);
77  return *this;
78  }
79 
83  virtual ~ParallelObject () {}
84 
89  const Parallel::Communicator & comm () const
90  { return _communicator; }
91 
96  { return cast_int<processor_id_type>(_communicator.size()); }
97 
102  { return cast_int<processor_id_type>(_communicator.rank()); }
103 
104 
105 protected:
106 
108 };
109 } // namespace libMesh
110 
111 #endif // LIBMESH_PARALLEL_OBJECT_H
ParallelObject(const Parallel::Communicator &comm_in)
Constructor.
Encapsulates the MPI_Comm object.
Definition: communicator.h:92
processor_id_type size() const
Definition: communicator.h:184
const Parallel::Communicator & comm() const
const Parallel::Communicator & _communicator
The libMesh namespace provides an interface to certain functionality in the library.
uint8_t processor_id_type
Definition: id_types.h:104
ParallelObject & operator=(const ParallelObject &libmesh_dbg_var(other))
"Assignment" operator.
processor_id_type n_processors() const
processor_id_type rank() const
Definition: communicator.h:182
virtual ~ParallelObject()
Destructor.
ParallelObject(const ParallelObject &other)
Copy Constructor.
An object whose state is distributed along a set of processors.
processor_id_type processor_id() const