Tpetra parallel linear algebra  Version of the Day
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 
48 
49 #include <Teuchos_Array.hpp>
50 #include <Teuchos_ArrayView.hpp>
51 
52 namespace Tpetra {
53 
54  // Forward declaration of Distributor. We don't actually need to
55  // include Distributor here, since we only refer to it by reference
56  // in this file and don't call any of its methods or refer to any of
57  // its fields. Subclasses should be sure to include
58  // Tpetra_Distributor.hpp.
59  class Distributor;
60 
95  template<class Packet, class LocalOrdinal>
96  class Packable {
97  public:
122  virtual void
123  pack (const Teuchos::ArrayView<const LocalOrdinal>& exportLIDs,
124  Teuchos::Array<Packet>& exports,
125  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
126  size_t& constantNumPackets,
127  Distributor &distor) const = 0;
128 
130  virtual ~Packable () {}
131  };
132 
133 } // namespace Tpetra
134 
135 #endif /* TPETRA_PACKABLE_DECL_HPP */
Namespace Tpetra contains the class and methods constituting the Tpetra library.
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.
virtual ~Packable()
Destructor (declared 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.