Belos Version of the Day
BelosStatusTestOutput.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 
00043 #ifndef BELOS_STATUS_TEST_OUTPUT_HPP
00044 #define BELOS_STATUS_TEST_OUTPUT_HPP
00045 
00051 #include "BelosConfigDefs.hpp"
00052 #include "BelosTypes.hpp"
00053 #include "BelosIteration.hpp"
00054 
00055 #include "BelosStatusTest.hpp"
00056 #include "BelosOutputManager.hpp"
00057 
00058 
00059 namespace Belos {
00060 
00071 template <class ScalarType, class MV, class OP>
00072 class StatusTestOutput : public virtual StatusTest<ScalarType,MV,OP> {
00073 
00074  public:
00076 
00077 
00079   StatusTestOutput() {}
00080 
00095   StatusTestOutput(const Teuchos::RCP<OutputManager<ScalarType> > &printer, 
00096                    Teuchos::RCP<StatusTest<ScalarType,MV,OP> > test,
00097                    int mod = 1,
00098                    int printStates = Passed)
00099     {}   
00100 
00102   virtual ~StatusTestOutput() {}
00104 
00106 
00107 
00110   virtual void setOutputManager(const Teuchos::RCP<OutputManager<ScalarType> > &printer) = 0;
00111 
00114   virtual void setOutputFrequency(int mod) = 0;
00115 
00120   virtual void setChild(Teuchos::RCP<StatusTest<ScalarType,MV,OP> > test) = 0;
00121 
00123   virtual Teuchos::RCP<StatusTest<ScalarType,MV,OP> > getChild() const = 0;
00124 
00127   virtual void setSolverDesc(const std::string& solverDesc) = 0;
00128 
00131   virtual void setPrecondDesc(const std::string& precondDesc) = 0;
00132 
00134 
00135 
00137 
00138 
00140   virtual void resetNumCalls() = 0;
00141 
00143 
00144 };
00145 
00146 } // end of Belos namespace
00147 
00148 #endif /* BELOS_STATUS_TEST_OUTPUT_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines