Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
BelosInnerSolveResult.cpp
Go to the documentation of this file.
1//@HEADER
2// ************************************************************************
3//
4// Belos: Block Linear Solvers Package
5// Copyright 2004 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
43
44namespace Belos {
45
47 InnerSolveResult (const ReturnType theResult,
48 const int theNumRestartCycles,
49 const int theTotalNumIters,
50 const std::map<std::string, double>& theExtraData) :
51 result_ (validatedReturnType (theResult)),
52 numRestartCycles_ (requireNonNegInt (theNumRestartCycles)),
53 totalNumIters_ (requireNonNegInt (theTotalNumIters)),
54 extraData_ (theExtraData)
55 {}
56
58 InnerSolveResult (const ReturnType theResult,
59 const int theNumRestartCycles,
60 const int theTotalNumIters) :
61 result_ (validatedReturnType (theResult)),
62 numRestartCycles_ (requireNonNegInt (theNumRestartCycles)),
63 totalNumIters_ (requireNonNegInt (theTotalNumIters))
64 {}
65
68 {
69 TEUCHOS_TEST_FOR_EXCEPTION(ret != Converged || ret != Unconverged,
70 std::invalid_argument,
71 "Invalid ReturnType enum value " << ret << ". "
72 "Valid values are Converged=" << Converged << " and "
73 "Unconverged=" << Unconverged << ".");
74 return ret;
75 }
76
77 int
79 {
80 TEUCHOS_TEST_FOR_EXCEPTION(k < 0, std::invalid_argument,
81 "The given integer argument k=" << k
82 << " must be nonnegative.");
83 return k;
84 }
85
86} // namespace Belos
static int requireNonNegInt(const int k)
static ReturnType validatedReturnType(const ReturnType ret)
InnerSolveResult(const ReturnType theResult, const int theNumRestartCycles, const int theTotalNumIters, const std::map< std::string, double > &theExtraData)
Constructor.
ReturnType
Whether the Belos solve converged for all linear systems.
Definition: BelosTypes.hpp:155
@ Unconverged
Definition: BelosTypes.hpp:157
@ Converged
Definition: BelosTypes.hpp:156