Epetra Package Browser (Single Doxygen Collection) Development
Epetra_Directory.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 //
00005 //               Epetra: Linear Algebra Services Package
00006 //                 Copyright 2011 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ************************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef EPETRA_DIRECTORY_H
00045 #define EPETRA_DIRECTORY_H
00046 
00047 #include "Epetra_ConfigDefs.h"
00048 
00049 class Epetra_BlockMap;  // Compiler needs forward reference
00050 class Epetra_Map;
00051 
00053 
00059 class Epetra_Directory {
00060 
00061   public:
00062 
00064 
00065 
00066   virtual ~Epetra_Directory(){}
00068 
00070 
00071 
00072 
00098 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00099   virtual int GetDirectoryEntries( const Epetra_BlockMap& Map,
00100            const int NumEntries,
00101            const int * GlobalEntries,
00102            int * Procs,
00103            int * LocalEntries,
00104            int * EntrySizes,
00105            bool high_rank_sharing_procs=false) const = 0;
00106 #endif
00107 
00108 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00109   virtual int GetDirectoryEntries( const Epetra_BlockMap& Map,
00110            const int NumEntries,
00111            const long long * GlobalEntries,
00112            int * Procs,
00113            int * LocalEntries,
00114            int * EntrySizes,
00115            bool high_rank_sharing_procs=false) const = 0;
00116 #endif
00117 
00119 
00121   virtual bool GIDsAllUniquelyOwned() const = 0;
00123 };
00124 
00125 #endif /* EPETRA_DIRECTORY_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines