1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*
//@HEADER
// ***********************************************************************
//
// Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
// Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/
/// \file Ifpack2_UnitTest234.cpp
/// \brief Unit test for Github Issue #234
///
/// This test ensures that the "chebyshev: boost factor" parameter of
/// Ifpack2::Chebyshev may have type either double or magnitude_type,
/// no matter what the Scalar type is.
///
/// Ifpack2::Chebyshev currently only works with real Scalar types.
/// Furthermore, this test only actually exercises the fix for #234
/// when <tt>Teuchos::ScalarTraits<Scalar>::magnitudeType !=
/// double</tt>. Thus, this test is not actually effective unless
/// Scalar != double. One such Scalar value suffices; we use float.
/// However, testing Scalar = double is not entirely useless, since it
/// makes sure that Ifpack2::Chebyshev takes a "chebyshev: boost
/// factor" parameter. Thus, we build the test for both Scalar =
/// float (if enabled) and Scalar = double (if enabled).
#include "Teuchos_UnitTestHarness.hpp"
#include "Ifpack2_Chebyshev.hpp"
#include "Tpetra_CrsMatrix.hpp"
#include "Tpetra_Core.hpp"
#include "Tpetra_Map.hpp"
#include <type_traits>
namespace { // (anonymous)
// Issue #234 only relates to the Scalar type (SC), so we only need to
// template on that.
TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL(Chebyshev, Issue234, SC)
{
// We are now in a class method declared by the above macro.
// The method has these input arguments:
// (Teuchos::FancyOStream& out, bool& success)
using Teuchos::RCP;
using Teuchos::rcp;
using Teuchos::tuple;
using std::endl;
typedef Tpetra::Map<>::local_ordinal_type LO;
typedef Tpetra::Map<>::global_ordinal_type GO;
typedef Tpetra::Map<>::node_type NT;
typedef Tpetra::global_size_t GST;
typedef Tpetra::CrsMatrix<SC, LO, GO, NT> crs_matrix_type;
typedef Tpetra::RowMatrix<SC, LO, GO, NT> row_matrix_type;
typedef Tpetra::Map<LO, GO, NT> map_type;
typedef typename Teuchos::ScalarTraits<SC>::magnitudeType magnitude_type;
const SC ONE = Teuchos::ScalarTraits<SC>::one ();
static_assert (! Teuchos::ScalarTraits<SC>::isComplex,
"This test only makes sense when the Scalar type SC is real.");
out << "Test fix for #234 (\"chebyshev: boost factor\" parameter)" << endl;
Teuchos::OSTab tab0 (out);
out << "Create test matrix A" << endl;
RCP<const Teuchos::Comm<int> > comm = Tpetra::getDefaultComm ();
// Create a nonzero diagonal matrix with a single row per process.
// We won't actually do anything with it; we just need to give the
// ContainerFactory a nontrivial matrix.
const LO lclNumRows = 3;
const GO gblNumRows = comm->getSize () * lclNumRows;
const GO indexBase = 0;
RCP<const map_type> rowMap =
rcp (new map_type (static_cast<GST> (gblNumRows),
static_cast<size_t> (lclNumRows),
indexBase, comm));
RCP<const map_type> colMap = rowMap;
RCP<const map_type> domMap = rowMap;
RCP<const map_type> ranMap = rowMap;
// For a diagonal matrix, we can use the row Map as the column Map.
const size_t maxNumEntPerRow = 1;
RCP<crs_matrix_type> A =
rcp (new crs_matrix_type (rowMap, colMap, maxNumEntPerRow,
Tpetra::StaticProfile));
for (LO lclRow = 0; lclRow < lclNumRows; ++lclRow) {
A->insertLocalValues (lclRow, tuple (lclRow), tuple (ONE));
}
A->fillComplete (domMap, ranMap);
// 2.1 is not a reasonable value of this parameter. We just want
// to use a value here that could not reasonably be a default
// value.
const double boostFactor = 2.1;
// Create the Chebyshev instance with a matrix, and set the
// "chebyshev: boost factor" parameter, using double as the
// parameter's type. Setting the parameter should not throw.
if (! std::is_same<double, magnitude_type>::value) {
Ifpack2::Chebyshev<row_matrix_type> prec (A);
Teuchos::ParameterList params;
params.set ("chebyshev: boost factor", static_cast<double> (boostFactor));
TEST_NOTHROW( prec.setParameters (params) );
}
// Create the Chebyshev instance with a matrix, and set the
// "chebyshev: boost factor" parameter, using magnitude_type as the
// parameter's type. Setting the parameter should not throw.
{
Ifpack2::Chebyshev<row_matrix_type> prec (A);
Teuchos::ParameterList params;
params.set ("chebyshev: boost factor", static_cast<magnitude_type> (boostFactor));
TEST_NOTHROW( prec.setParameters (params) );
}
}
// Define the set of unit tests to instantiate in this file.
#define UNIT_TEST_GROUP_SC( SC ) \
TEUCHOS_UNIT_TEST_TEMPLATE_1_INSTANT( Chebyshev, Issue234, SC )
#include "Ifpack2_ETIHelperMacros.h"
IFPACK2_ETI_MANGLING_TYPEDEFS()
// See discussion in file comments above to understand why we exercise
// only these two Scalar types.
#ifdef HAVE_TPETRA_INST_FLOAT
UNIT_TEST_GROUP_SC( float )
#endif // HAVE_TPETRA_FLOAT
#ifdef HAVE_TPETRA_INST_DOUBLE
UNIT_TEST_GROUP_SC( double )
#endif // HAVE_TPETRA_DOUBLE
} // namespace (anonymous)
|
