Belos Version of the Day
BelosTypes.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_TYPES_HPP
00043 #define BELOS_TYPES_HPP
00044 
00050 #include "BelosConfigDefs.hpp"
00051 #include "Teuchos_TestForException.hpp"
00052 
00053 namespace Belos {
00054  
00056 
00057 
00061   class BelosError: public std::logic_error {
00062     public: BelosError(const std::string& what_arg) : std::logic_error(what_arg) {}
00063   };
00064 
00066 
00067  
00072   enum ETrans     { NOTRANS = 0,  
00073       TRANS = 1,    
00074       CONJTRANS = 2 
00075   };
00076   
00081   enum NormType {   OneNorm,       
00082         TwoNorm,       
00083         InfNorm        
00084   };
00085   
00090   enum ScaleType {NormOfRHS,     
00091                   NormOfInitRes, 
00092                   NormOfPrecInitRes, 
00093                   None,          
00094                   UserProvided   
00096   };
00097  
00102   enum OutputType {General,     
00103                    Brief        
00104   };
00105 
00113   enum ReturnType  {    Converged,     
00114                         Unconverged    
00115   };
00116   
00123   enum StatusType {   Passed = 0x1,      
00124                         Failed = 0x2,      
00125       Undefined = 0x4    
00126   };
00127 
00128   enum ResetType  {     Problem = 0x1,           
00129                         RecycleSubspace = 0x2    
00130   };
00131 
00135   inline
00136   const char* toString(const StatusType status)
00137   {
00138     switch(status) {
00139       case Passed:
00140         return "Passed";
00141       case Failed:
00142         return "Failed";
00143       case Undefined:
00144         return "Undefined";
00145       default:
00146         TEST_FOR_EXCEPT(true);
00147     }
00148     return NULL; // Should never be called!
00149   }
00150   
00157   enum ConjType {
00158     NO_CONJ,      
00159     CONJ          
00160   };
00161   
00166   enum MsgType 
00167     {
00168       Errors= 0,                  
00169       Warnings = 0x1,             
00170       IterationDetails = 0x2,     
00171       OrthoDetails = 0x4,         
00172       FinalSummary = 0x8,         
00173       TimingDetails = 0x10,       
00174       StatusTestDetails = 0x20,   
00175       Debug = 0x40                
00176     };
00177 
00178 } // end Belos namespace
00179 
00180 #endif /* BELOS_TYPES_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines