Epetra Package Browser (Single Doxygen Collection) Development
Epetra_Distributor.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_DISTRIBUTOR_H
00045 #define EPETRA_DISTRIBUTOR_H
00046 
00048 
00060 #include "Epetra_Object.h"
00061 class Epetra_Distributor {
00062 
00063   public:
00065 
00066 
00067   virtual Epetra_Distributor * Clone() = 0;
00068 
00070 
00073   virtual Epetra_Distributor * ReverseClone() =0;
00074 
00076   virtual ~Epetra_Distributor(){};
00077 
00079 
00080 
00082 
00083 
00084 
00095   virtual int CreateFromSends( const int & NumExportIDs,
00096                                const int * ExportPIDs,
00097              bool Deterministic,
00098                                int & NumRemoteIDs ) = 0;
00099 
00101 
00116   virtual int CreateFromRecvs( const int & NumRemoteIDs,
00117                                const int * RemoteGIDs,
00118              const int * RemotePIDs,
00119              bool Deterministic,
00120              int & NumExportIDs,
00121              int *& ExportGIDs,
00122              int *& ExportPIDs) = 0;
00123 
00124 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00125   virtual int CreateFromRecvs( const int & NumRemoteIDs,
00126                                const long long * RemoteGIDs,
00127              const int * RemotePIDs,
00128              bool Deterministic,
00129              int & NumExportIDs,
00130              long long *& ExportGIDs,
00131              int *& ExportPIDs) = 0;
00132 #endif
00133 
00134 
00136 
00137 
00139   virtual int Do( char * export_objs,
00140                   int obj_size,
00141                   int & len_import_objs,
00142                   char *& import_objs) = 0;
00143 
00145   virtual int DoReverse( char * export_objs,
00146                          int obj_size,
00147                          int & len_import_objs,
00148                          char *& import_objs ) = 0;
00149 
00151   virtual int DoPosts( char * export_objs,
00152                        int obj_size,
00153                        int & len_import_objs,
00154                        char *& import_objs ) = 0;
00155 
00157   virtual int DoWaits() = 0;
00158 
00160   virtual int DoReversePosts( char * export_objs,
00161                               int obj_size,
00162                               int & len_import_objs,
00163                               char *& import_objs) = 0;
00164 
00166   virtual int DoReverseWaits() = 0;
00168 
00170 
00171 
00173   virtual int Do( char * export_objs,
00174                   int obj_size,
00175                   int *& sizes,
00176                   int & len_import_objs,
00177                   char *& import_objs) = 0;
00178 
00180   virtual int DoReverse( char * export_objs,
00181                          int obj_size,
00182                          int *& sizes,
00183                          int & len_import_objs,
00184                          char *& import_objs) = 0;
00185 
00187   virtual int DoPosts( char * export_objs,
00188                        int obj_size,
00189                        int *& sizes,
00190                        int & len_import_objs,
00191                        char *& import_objs) = 0;
00192 
00194   virtual int DoReversePosts( char * export_objs,
00195                               int obj_size,
00196                               int *& sizes,
00197                               int & len_import_objs,
00198                               char *& import_objs) = 0;
00200 
00202 
00203   virtual void Print(std::ostream & os) const = 0;
00205 };
00206 #endif /* EPETRA_DISTRIBUTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines