Teko_TimingsSIMPLEPreconditionerFactory.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_TimingsSIMPLEPreconditionerFactory_hpp__
#define __Teko_TimingsSIMPLEPreconditionerFactory_hpp__

#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_InverseFactory.hpp"
#include "Teko_DiagnosticLinearOp.hpp"

#include "Teuchos_Time.hpp"

namespace Teko {
namespace NS {

// Declaration of the preconditioner factory
class TimingsSIMPLEPreconditionerFactory : public BlockPreconditionerFactory {
 public:
  // Constructor
  TimingsSIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& inverse, double alpha);

  // Constructor
  TimingsSIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& invVelFactory,
                                     const Teuchos::RCP<InverseFactory>& invPrsFactory,
                                     double alpha);

  TimingsSIMPLEPreconditionerFactory();

  virtual ~TimingsSIMPLEPreconditionerFactory();

  // Function inherited from BlockPreconditionerFactory
  LinearOp buildPreconditionerOperator(BlockedLinearOp& blo, BlockPreconditionerState& state) const;

  virtual void setMassMatrix(Teko::LinearOp& mass) { massMatrix_ = mass; }

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& pl);

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

 protected:
  using Teko::BlockPreconditionerFactory::buildPreconditionerOperator;

  // class members
  Teuchos::RCP<InverseFactory> customHFactory_;
  Teuchos::RCP<InverseFactory> invVelFactory_;
  Teuchos::RCP<InverseFactory> invPrsFactory_;
  double alpha_;
  DiagonalType fInverseType_;
  // enum FInverseType {Diagonal,Lumped,AbsRowSum,Custom} fInverseType_;

  bool useMass_;
  Teko::LinearOp massMatrix_;

  // Info for the block-diagonal approximation to H if used.
  mutable Teuchos::ParameterList BlkDiagList_;

  mutable Teuchos::Time constrTotal_;
  mutable Teuchos::Time subTotal_;
  mutable int constrCount_;

  mutable Teuchos::RCP<DiagnosticLinearOp> timed_HBt_;
  mutable Teuchos::RCP<DiagnosticLinearOp> timed_B_;
  mutable Teuchos::RCP<DiagnosticLinearOp> timed_invF_;
  mutable Teuchos::RCP<DiagnosticLinearOp> timed_invS_;
  mutable Teuchos::RCP<DiagnosticLinearOp> timed_iU_t_iL_;
};

}  // end namespace NS
}  // end namespace Teko

#endif