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 {
48  {
49  public:
50 
56  _communicator(comm_in)
57  {}
58 
62  ParallelObject (const ParallelObject &other) :
64  {}
65 
72  {
73  libmesh_assert_equal_to (&_communicator, &other._communicator);
74  return *this;
75  }
76 
80  virtual ~ParallelObject () {}
81 
86  const Parallel::Communicator & comm () const
87  { return _communicator; }
88 
93  { return libmesh_cast_int<processor_id_type>(_communicator.size()); }
94 
99  { return libmesh_cast_int<processor_id_type>(_communicator.rank()); }
100 
101 
102  protected:
103 
105  };
106 } // namespace libMesh
107 
108 #endif // LIBMESH_PARALLEL_OBJECT_H

Site Created By: libMesh Developers
Last modified: February 07 2014 16:57:06 UTC

Hosted By:
SourceForge.net Logo