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 2001 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;
00069   virtual ~Epetra_Distributor(){};
00071 
00072   
00074 
00075 
00076 
00087   virtual int CreateFromSends( const int & NumExportIDs,
00088                                const int * ExportPIDs,
00089              bool Deterministic,
00090                                int & NumRemoteIDs ) = 0;
00091 
00093 
00108   virtual int CreateFromRecvs( const int & NumRemoteIDs,
00109                                const int * RemoteGIDs,
00110              const int * RemotePIDs,
00111              bool Deterministic,
00112              int & NumExportIDs,
00113              int *& ExportGIDs,
00114              int *& ExportPIDs) = 0;
00116 
00118 
00119 
00121   virtual int Do( char * export_objs,
00122                   int obj_size,
00123                   int & len_import_objs,
00124                   char *& import_objs) = 0;
00125 
00127   virtual int DoReverse( char * export_objs,
00128                          int obj_size,
00129                          int & len_import_objs,
00130                          char *& import_objs ) = 0;
00131 
00133   virtual int DoPosts( char * export_objs, 
00134                        int obj_size,
00135                        int & len_import_objs,
00136                        char *& import_objs ) = 0;
00137 
00139   virtual int DoWaits() = 0;
00140 
00142   virtual int DoReversePosts( char * export_objs,
00143                               int obj_size,
00144                               int & len_import_objs,
00145                               char *& import_objs) = 0;
00146 
00148   virtual int DoReverseWaits() = 0;
00150 
00152 
00153 
00155   virtual int Do( char * export_objs,
00156                   int obj_size,
00157                   int *& sizes,
00158                   int & len_import_objs,
00159                   char *& import_objs) = 0;
00160 
00162   virtual int DoReverse( char * export_objs,
00163                          int obj_size,
00164                          int *& sizes,
00165                          int & len_import_objs,
00166                          char *& import_objs) = 0;
00167 
00169   virtual int DoPosts( char * export_objs,
00170                        int obj_size,
00171                        int *& sizes,
00172                        int & len_import_objs,
00173                        char *& import_objs) = 0;
00174 
00176   virtual int DoReversePosts( char * export_objs,
00177                               int obj_size,
00178                               int *& sizes,
00179                               int & len_import_objs,
00180                               char *& import_objs) = 0;
00181 
00183 
00185 
00186   virtual void Print(ostream & os) const = 0;
00188 };
00189 #endif /* EPETRA_DISTRIBUTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines