Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_EReductionType.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 
44 
45 namespace Teuchos {
46 
47 #ifdef HAVE_TEUCHOS_MPI
48 namespace Details {
49 
50 MPI_Op
51 getMpiOpForEReductionType (const enum EReductionType reductionType)
52 {
53  switch (reductionType) {
54  case REDUCE_SUM: return MPI_SUM;
55  case REDUCE_MIN: return MPI_MIN;
56  case REDUCE_MAX: return MPI_MAX;
57  case REDUCE_AND: return MPI_LAND; // logical AND, not bitwise AND
58  case REDUCE_BOR: return MPI_BOR; // bitwise OR
59  default:
60  TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument,
61  "The given EReductionType value is invalid.");
62  }
63 }
64 
65 } // namespace Details
66 #endif // HAVE_TEUCHOS_MPI
67 
68 const char*
69 toString (const EReductionType reductType)
70 {
71  switch (reductType) {
72  case REDUCE_SUM: return "REDUCE_SUM";
73  case REDUCE_MIN: return "REDUCE_MIN";
74  case REDUCE_MAX: return "REDUCE_MAX";
75  case REDUCE_AND: return "REDUCE_AND";
76  case REDUCE_BOR: return "REDUCE_BOR";
77  default:
79  (true, std::invalid_argument, "Teuchos::toString(EReductionType): "
80  "Invalid EReductionType value " << reductType << ". Valid values "
81  "are REDUCE_SUM = " << REDUCE_SUM << ", REDUCE_MIN = " << REDUCE_MIN
82  << ", REDUCE_MAX = " << REDUCE_MIN << ", REDUCE_AND = " << REDUCE_AND
83  << ", and REDUCE_BOR = " << REDUCE_BOR
84  << ".");
85  }
86 }
87 
88 } // namespace Teuchos
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
Declaration of Teuchos::EReductionType enum, and related functions.
Standard test and throw macros.