Belos Version of the Day
BelosInnerSolveResult.cpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //                 Belos: Block Linear Solvers Package
00005 //                  Copyright 2004 Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #include <BelosInnerSolveResult.hpp>
00043 
00044 namespace Belos {
00045 
00046   InnerSolveResult::
00047   InnerSolveResult (const ReturnType theResult,
00048         const int theNumRestartCycles,
00049         const int theTotalNumIters,
00050         const std::map<std::string, double>& theExtraData) :
00051     result_ (validatedReturnType (theResult)),
00052     numRestartCycles_ (requireNonNegInt (theNumRestartCycles)),
00053     totalNumIters_ (requireNonNegInt (theTotalNumIters)),
00054     extraData_ (theExtraData)
00055   {}
00056 
00057   InnerSolveResult::
00058   InnerSolveResult (const ReturnType theResult,
00059         const int theNumRestartCycles,
00060         const int theTotalNumIters) :
00061     result_ (validatedReturnType (theResult)),
00062     numRestartCycles_ (requireNonNegInt (theNumRestartCycles)),
00063     totalNumIters_ (requireNonNegInt (theTotalNumIters))
00064   {}
00065 
00066   ReturnType 
00067   InnerSolveResult::validatedReturnType (const ReturnType ret)
00068   {
00069     TEST_FOR_EXCEPTION(ret != Converged || ret != Unconverged,
00070            std::invalid_argument,
00071            "Invalid ReturnType enum value " << ret << ".  "
00072            "Valid values are Converged=" << Converged << " and "
00073            "Unconverged=" << Unconverged << ".");
00074     return ret;
00075   }
00076 
00077   int 
00078   InnerSolveResult::requireNonNegInt (const int k) 
00079   {
00080     TEST_FOR_EXCEPTION(k < 0, std::invalid_argument, 
00081            "The given integer argument k=" << k 
00082            << " must be nonnegative.");
00083     return k;
00084   }
00085 
00086 } // namespace Belos
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines