Teko_DiagnosticPreconditionerFactory.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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);

  DiagnosticPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory>& invFactory,
                                  const Teuchos::RCP<Teko::InverseFactory>& precFactory,
                                  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;

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

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

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

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

}  // end namespace Teko

#endif