Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_TieBreak.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// ************************************************************************
38// @HEADER
39
40#ifndef TPETRA_DETAILS_TIEBREAK_HPP
41#define TPETRA_DETAILS_TIEBREAK_HPP
42
45
47#include "Teuchos_RCP.hpp"
48#include <utility>
49#include <vector>
50
51namespace Tpetra {
52namespace Details {
53
67 template <typename LocalOrdinal, typename GlobalOrdinal>
68 class TieBreak {
69 public:
83 struct Triplet {
84 LocalOrdinal LID;
85 GlobalOrdinal GID;
86 int PID;
87 };
88
98 virtual bool mayHaveSideEffects () const {
99 return true;
100 }
101
103 virtual ~TieBreak () = default;
104
125 virtual std::size_t
126 selectedIndex (GlobalOrdinal GID,
127 const std::vector<std::pair<int, LocalOrdinal> >& pid_and_lid) const = 0;
128 };
129
130} // namespace Details
131} // namespace Tpetra
132
133#endif // TPETRA_DETAILS_TIEBREAK_HPP
Forward declaration for Tpetra::TieBreak.
Interface for breaking ties in ownership.
virtual ~TieBreak()=default
Virtual destructor (for memory safety of derived classes).
virtual bool mayHaveSideEffects() const
Whether selectedIndex() may have side effects.
virtual std::size_t selectedIndex(GlobalOrdinal GID, const std::vector< std::pair< int, LocalOrdinal > > &pid_and_lid) const =0
Break any ties in ownership of the given global index GID.
Implementation details of Tpetra.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Representation of a global index on a process.