Belos Package Browser (Single Doxygen Collection) Development
BelosStatusTestOutputFactory.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_FACTORY_HPP
00044 #define BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP
00045 
00051 #include "BelosConfigDefs.hpp"
00052 #include "BelosTypes.hpp"
00053 #include "BelosStatusTestResNormOutput.hpp"
00054 #include "BelosStatusTestGeneralOutput.hpp"
00055 
00056 
00057 namespace Belos {
00058 
00068 template <class ScalarType, class MV, class OP>
00069 class StatusTestOutputFactory {
00070 
00071  public:
00073 
00074 
00082   StatusTestOutputFactory( int outputStyle )
00083     : outputStyle_(outputStyle)
00084     {}
00085 
00087   virtual ~StatusTestOutputFactory() {}
00089 
00090 
00092 
00093 
00108    Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > create(const Teuchos::RCP<OutputManager<ScalarType> > &printer, 
00109                                                             Teuchos::RCP<StatusTest<ScalarType,MV,OP> > test,
00110                                                             int mod,
00111                                                             int printStates)
00112     {
00113       Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > outputTest;
00114 
00115       switch( outputStyle_ ) {
00116 
00117       case General:
00118         if (mod > 0) {
00119           outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP>( printer, test, mod, printStates ) );
00120         }
00121         else {
00122           outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP>( printer, test, 1 ) );
00123         }
00124         break;
00125       case Brief:
00126         if (mod > 0) {
00127           outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP>( printer, test, mod, printStates ) );
00128         }
00129         else {
00130           outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP>( printer, test, 1 ) );
00131         }
00132         break;
00133       }
00134 
00135       return outputTest;
00136     }   
00137 
00139 
00140  private:
00141 
00142   // Which type of StatusTestOutput class
00143   int outputStyle_;
00144 
00145   // Hide the default constructor and copy constructor
00146   StatusTestOutputFactory( void ) {}
00147   StatusTestOutputFactory( const StatusTestOutputFactory<ScalarType,MV,OP>& ) {}
00148 
00149 };
00150 
00151 } // end of Belos namespace
00152 
00153 #endif /* BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines