Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_Directory.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Epetra: Linear Algebra Services Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRA_DIRECTORY_H
45 #define EPETRA_DIRECTORY_H
46 
47 #include "Epetra_ConfigDefs.h"
48 
49 class Epetra_BlockMap; // Compiler needs forward reference
50 class Epetra_Map;
51 
53 
60 
61  public:
62 
64 
65  virtual ~Epetra_Directory(){}
68 
70 
71 
98 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
99  virtual int GetDirectoryEntries( const Epetra_BlockMap& Map,
100  const int NumEntries,
101  const int * GlobalEntries,
102  int * Procs,
103  int * LocalEntries,
104  int * EntrySizes,
105  bool high_rank_sharing_procs=false) const = 0;
106 #endif
107 
108 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
109  virtual int GetDirectoryEntries( const Epetra_BlockMap& Map,
110  const int NumEntries,
111  const long long * GlobalEntries,
112  int * Procs,
113  int * LocalEntries,
114  int * EntrySizes,
115  bool high_rank_sharing_procs=false) const = 0;
116 #endif
117 
119 
121  virtual bool GIDsAllUniquelyOwned() const = 0;
123 };
124 
125 #endif /* EPETRA_DIRECTORY_H */
126 
127 #if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
128 #ifdef __GNUC__
129 #warning "The Epetra package is deprecated"
130 #endif
131 #endif
132 
Epetra_Map: A class for partitioning vectors and matrices.
Definition: Epetra_Map.h:119
virtual bool GIDsAllUniquelyOwned() const =0
GIDsAllUniquelyOwned: returns true if all GIDs appear on just one processor.
virtual int GetDirectoryEntries(const Epetra_BlockMap &Map, const int NumEntries, const int *GlobalEntries, int *Procs, int *LocalEntries, int *EntrySizes, bool high_rank_sharing_procs=false) const =0
GetDirectoryEntries : Returns proc and local id info for non-local map entries.
Epetra_Directory: This class is a pure virtual class whose interface allows Epetra_Map and Epetr_Bloc...
Epetra_BlockMap: A class for partitioning block element vectors and matrices.
virtual ~Epetra_Directory()
Epetra_Directory destructor.