Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_CombineMode.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Tpetra: Templated Linear Algebra Services Package
4 //
5 // Copyright 2008 NTESS and the Tpetra contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef TPETRA_COMBINEMODE_HPP
11 #define TPETRA_COMBINEMODE_HPP
12 
17 
18 #include <string>
19 
20 // Forward declaration of Teuchos::ParameterList.
21 namespace Teuchos {
22  class ParameterList;
23 } // namespace Teuchos
24 
25 namespace Tpetra {
26 
65  enum CombineMode {
66  ADD,
70  ZERO,
72  };
73 
97  void
98  setCombineModeParameter (Teuchos::ParameterList& plist,
99  const std::string& paramName);
100 
102  std::string combineModeToString (const CombineMode combineMode);
103 
104 } // namespace Tpetra
105 
106 #endif // TPETRA_COMBINEMODE_HPP
void setCombineModeParameter(Teuchos::ParameterList &plist, const std::string &paramName)
Set CombineMode parameter in a Teuchos::ParameterList.
Insert new values that don&#39;t currently exist.
CombineMode
Rule for combining data in an Import or Export.
Sum new values.
Replace old value with maximum of magnitudes of old and new values.
Replace existing values with new values.
Replace old values with zero.
std::string combineModeToString(const CombineMode combineMode)
Human-readable string representation of the given CombineMode.
Accumulate new values into existing values (may not be supported in all classes)