Teko_DiagnosticPreconditionerFactory.hpp

/*
// @HEADER
// 
// ***********************************************************************
// 
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 Sandia Corporation 
//  
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//  
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//  
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//  
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//  
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission. 
//  
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//  
// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
// 
// ***********************************************************************
// 
// @HEADER

*/

#ifndef __Teko_DiagnosticPreconditionerFactory_hpp__
#define __Teko_DiagnosticPreconditionerFactory_hpp__

#include "Teuchos_Time.hpp"

// Teko includes
#include "Teko_PreconditionerFactory.hpp"

namespace Teko {

class DiagnosticPreconditionerFactory 
   : public virtual Teko::PreconditionerFactory {
public:
   DiagnosticPreconditionerFactory();

   DiagnosticPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory,const std::string & label,
                                   const Teuchos::RCP<std::ostream> & os=Teuchos::null,bool printResidual=false);

   virtual ~DiagnosticPreconditionerFactory();

   virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;



   virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);

   virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
   
   virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
   

   int numInitialBuilds() const { return buildTimer_->numCalls(); }
   double totalInitialBuildTime() const { return buildTimer_->totalElapsedTime(); }

   int numRebuilds() const { return rebuildTimer_->numCalls(); }
   double totalRebuildTime() const { return rebuildTimer_->totalElapsedTime(); }

private:
   void initTimers(const std::string & label);

   Teuchos::RCP<std::ostream> outputStream_;
   Teuchos::RCP<Teko::InverseFactory> invFactory_;
   std::string diagString_;
   bool printResidual_;

   mutable Teuchos::RCP<Teuchos::Time> buildTimer_;   // only first pass construction time (no rebuild)
   mutable Teuchos::RCP<Teuchos::Time> rebuildTimer_; // rebuild-construction timer (no build)
};

} // end namespace Teko

#endif