Belos Version of the Day
BelosInnerSolveResult.hpp
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 #ifndef __Belos_InnerSolverResult_hpp
00043 #define __Belos_InnerSolverResult_hpp
00044 
00045 #include <BelosTypes.hpp> // ReturnType
00046 #include <map>
00047 #include <string>
00048 
00049 namespace Belos {
00050 
00062   class InnerSolveResult {
00063   public:
00081     InnerSolveResult (const ReturnType theResult,
00082           const int theNumRestartCycles,
00083           const int theTotalNumIters,
00084           const std::map<std::string, double>& theExtraData);
00085 
00087     InnerSolveResult (const ReturnType theResult,
00088           const int theNumRestartCycles,
00089           const int theTotalNumIters);
00090 
00097     ReturnType result() {
00098       return result_;
00099     }
00100 
00104     int totalNumIters() const { 
00105       return totalNumIters_;
00106     }
00107 
00109     int numRestartCycles() const { 
00110       return numRestartCycles_;
00111     }
00112 
00119     const std::map<std::string, double>& extraData () const {
00120       return extraData_;
00121     }
00122 
00123   private:
00124     ReturnType result_;
00125     int numRestartCycles_, totalNumIters_;
00126     std::map<std::string, double> extraData_;
00127 
00128     static ReturnType 
00129     validatedReturnType (const ReturnType ret);
00130 
00131     static int 
00132     requireNonNegInt (const int k);
00133   };
00134 
00135 } // namespace Belos
00136 
00137 
00138 #endif // __Belos_InnerSolverResult_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines