Epetra Package Browser (Single Doxygen Collection) Development
Epetra_SerialDistributor.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_SERIALDISTRIBUTOR_H
00045 #define EPETRA_SERIALDISTRIBUTOR_H
00046 
00047 #include "Epetra_Object.h"
00048 #include "Epetra_Distributor.h"
00049 class Epetra_SerialComm;
00050 
00052 
00058 class Epetra_SerialDistributor: public Epetra_Object, public virtual Epetra_Distributor {
00059     
00060   public:
00061 
00063 
00064 
00066   Epetra_SerialDistributor(const Epetra_SerialComm & Comm);
00067 
00069   Epetra_SerialDistributor(const Epetra_SerialDistributor & Plan);
00070 
00072   Epetra_Distributor * Clone(){return(dynamic_cast<Epetra_Distributor *>(new Epetra_SerialDistributor(*this)));};
00073 
00075   virtual ~Epetra_SerialDistributor();
00077 
00078   
00079   int CreateFromSends( const int & NumExportIDs,
00080                        const int * ExportPIDs,
00081            bool Deterministic,
00082                        int & NumRemoteIDs );
00083 
00084   int CreateFromRecvs( const int & NumRemoteIDs,
00085                        const int * RemoteGIDs,
00086                        const int * RemotePIDs,
00087            bool Deterministic,
00088                        int & NumExportIDs,
00089                        int *& ExportGIDs,
00090                        int *& ExportPIDs);
00091 
00092 
00093   int Do       (char * export_objs,
00094                 int obj_size,
00095                 int & len_import_objs,
00096                 char *& import_objs);
00097   int DoReverse(char * export_objs,
00098                 int obj_size,
00099                 int & len_import_objs,
00100                 char *& import_objs);
00101 
00102   int DoPosts(char * export_objs,
00103               int obj_size,
00104               int & len_import_objs,
00105               char *& import_objs);
00106   int DoWaits();
00107 
00108   int DoReversePosts(char * export_objs,
00109                      int obj_size,
00110                      int & len_import_objs,
00111                      char *& import_objs);
00112   int DoReverseWaits();
00113 
00114 
00115   int Do       (char * export_objs,
00116                 int obj_size,
00117                 int *& sizes,
00118                 int & len_import_objs,
00119                 char *& import_objs);
00120   int DoReverse(char * export_objs,
00121                 int obj_size,
00122                 int *& sizes,
00123                 int & len_import_objs,
00124                 char *& import_objs);
00125 
00126   int DoPosts(char * export_objs,
00127               int obj_size,
00128               int *& sizes,
00129               int & len_import_objs,
00130               char *& import_objs);
00131 
00132   int DoReversePosts(char * export_objs,
00133                      int obj_size,
00134                      int *& sizes,
00135                      int & len_import_objs,
00136                      char *& import_objs);
00137 
00138 
00139   virtual void Print(ostream & os) const;
00140 
00141  private:
00142   int nrecvs_;
00143   int nsends_;
00144 };
00145 #endif /* EPETRA_SERIALDISTRIBUTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines