Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Packable.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_PACKABLE_DECL_HPP
43 #define TPETRA_PACKABLE_DECL_HPP
44 
47 
48 #include "Tpetra_Packable_fwd.hpp"
49 
50 #ifndef DOXYGEN_SHOULD_SKIP_THIS
51 namespace Teuchos {
52  // Forward declarations
53  template <class T> class Array;
54  template <class T> class ArrayView;
55 } // namespace Teuchos
56 
57 namespace Tpetra {
58  class Distributor; // forward declaration
59 } // namespace Tpetra
60 #endif // DOXYGEN_SHOULD_SKIP_THIS
61 
62 namespace Tpetra {
97  template<class Packet,
98  class LocalOrdinal>
99  class Packable {
100  public:
125  virtual void
126  pack (const Teuchos::ArrayView<const LocalOrdinal>& exportLIDs,
127  Teuchos::Array<Packet>& exports,
128  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
129  size_t& constantNumPackets,
130  Distributor &distor) const = 0;
131 
133  virtual ~Packable () {}
134  };
135 } // namespace Tpetra
136 
137 #endif /* TPETRA_PACKABLE_DECL_HPP */
virtual void pack(const Teuchos::ArrayView< const LocalOrdinal > &exportLIDs, Teuchos::Array< Packet > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor) const =0
Pack the object&#39;s data for an Import or Export.
Forward declaration of Tpetra::Packable.
virtual ~Packable()
Destructor (virtual for memory safety of derived classes).
Sets up and executes a communication plan for a Tpetra DistObject.
Abstract base class for objects that can be the source of an Import or Export operation, and that also know how to pack their data to send to the target object.