parallel_object.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2013 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 {
49 {
50 public:
51 
57  _communicator(comm_in)
58  {}
59 
63  ParallelObject (const ParallelObject & other) :
65  {}
66 
73  {
74  libmesh_assert_equal_to (&_communicator, &other._communicator);
75  return *this;
76  }
77 
81  virtual ~ParallelObject () {}
82 
87  const Parallel::Communicator & comm () const
88  { return _communicator; }
89 
94  { return cast_int<processor_id_type>(_communicator.size()); }
95 
100  { return cast_int<processor_id_type>(_communicator.rank()); }
101 
102 
103 protected:
104 
106 };
107 } // namespace libMesh
108 
109 #endif // LIBMESH_PARALLEL_OBJECT_H
ParallelObject(const Parallel::Communicator &comm_in)
unsigned int size() const
Definition: parallel.h:679
processor_id_type n_processors() const
uint8_t processor_id_type
Definition: id_types.h:99
const Parallel::Communicator & _communicator
ParallelObject & operator=(const ParallelObject &libmesh_dbg_var(other))
ParallelObject(const ParallelObject &other)
PetscErrorCode Vec Mat libmesh_dbg_var(j)
const Parallel::Communicator & comm() const
unsigned int rank() const
Definition: parallel.h:677
processor_id_type processor_id() const