BelosStatusTestOutputFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
//
 
#ifndef BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP
#define BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP

 
#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosStatusTestResNormOutput.hpp"
#include "BelosStatusTestUserOutput.hpp"
#include "BelosStatusTestGeneralOutput.hpp"
 
namespace Belos {

template <class ScalarType, class MV, class OP, class DM = DefaultDenseMatrix<int,ScalarType>>
class StatusTestOutputFactory {
 
 public:


  StatusTestOutputFactory( int outputStyle, Teuchos::RCP<std::map<std::string,Teuchos::RCP<StatusTest<ScalarType,MV,OP,DM> > > > taggedTests = Teuchos::null )
    : outputStyle_(outputStyle),
      taggedTests_(taggedTests)
  {}

  virtual ~StatusTestOutputFactory() {}
 



   Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP,DM> > create(const Teuchos::RCP<OutputManager<ScalarType> > &printer,
                                                            Teuchos::RCP<StatusTest<ScalarType,MV,OP,DM> > test,
                                                            int mod,
                                                            int printStates)
    {
      Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP,DM> > outputTest;
 
      switch( outputStyle_ ) {
 
      case General:
        if (mod > 0) {
          outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP,DM>( printer, test, mod, printStates ) );
        }
        else {
          outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP,DM>( printer, test, 1 ) );
        }
        break;
      case Brief:
        if (mod > 0) {
          outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP,DM>( printer, test, mod, printStates ) );
        }
        else {
          outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP,DM>( printer, test, 1 ) );
        }
        break;
      case User:
        if (mod > 0) {
          outputTest = Teuchos::rcp( new StatusTestUserOutput<ScalarType,MV,OP,DM>( printer, test, taggedTests_, mod, printStates ) );
        }
        else {
          outputTest = Teuchos::rcp( new StatusTestUserOutput<ScalarType,MV,OP,DM>( printer, test, taggedTests_, 1 ) );
        }
        break;
      default: //Default to General if invalid outputStyle_ given.
        if (mod > 0) {
          outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP,DM>( printer, test, mod, printStates ) );
        }
        else {
          outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP,DM>( printer, test, 1 ) );
        }
        break;
      }
 
 
      return outputTest;
    }

 
 private:
 
  // Which type of StatusTestOutput class
  int outputStyle_;
 
  Teuchos::RCP<std::map<std::string,Teuchos::RCP<StatusTest<ScalarType,MV,OP,DM> > > > taggedTests_;
 
  // Hide the default constructor and copy constructor
  StatusTestOutputFactory( void ) {}
  StatusTestOutputFactory( const StatusTestOutputFactory<ScalarType,MV,OP,DM>& ) {}
 
};
 
} // end of Belos namespace
 
#ifdef HAVE_BELOS_TPETRA
#include "BelosTpetraETIHelpers.hpp"
 
#define BELOS_TPETRA_STATUSTESTOUTPUTFACTORY_NOEXTERN_CALL(SC, LO, GO, NT)            \
  BELOS_TPETRA_CALL(Belos::StatusTestOutputFactory, SC, LO, GO, NT)
 
#define BELOS_TPETRA_STATUSTESTOUTPUTFACTORY_EXTERN_CALL(SC, LO, GO, NT)              \
  BELOS_TPETRA_EXTERN_CALL(Belos::StatusTestOutputFactory, SC, LO, GO, NT)
 
TPETRA_INSTANTIATE_SLGN_NO_ORDINAL_SCALAR(BELOS_TPETRA_STATUSTESTOUTPUTFACTORY_EXTERN_CALL)
#endif
 
 
#endif /* BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP */