Teko_PCDStrategy.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_PCDStrategy_hpp__
#define __Teko_PCDStrategy_hpp__

#include "Teko_LU2x2Strategy.hpp"

// Teuchos includes
#include "Teuchos_Time.hpp"

namespace Teko {
namespace NS {

class PCDStrategy : public LU2x2Strategy {
 public:
  PCDStrategy();

  PCDStrategy(const Teuchos::RCP<InverseFactory>& invFA, const Teuchos::RCP<InverseFactory>& invS);

  virtual ~PCDStrategy() {}

  virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp& A,
                                            BlockPreconditionerState& state) const;

  virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp& A,
                                              BlockPreconditionerState& state) const;

  virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp& A,
                                       BlockPreconditionerState& state) const;

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

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

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

 protected:
  static void buildTimers();

  void initializeState(const Teko::BlockedLinearOp& A, BlockPreconditionerState& state) const;

  // how to invert the matrices
  Teuchos::RCP<InverseFactory> invFactoryF_;  // for \tilde{A_00}\f$
  Teuchos::RCP<InverseFactory> invFactoryS_;

  DiagonalType massInverseType_;

  Teuchos::RCP<Teuchos::ParameterList> lapParams_;

  Teuchos::RCP<Teuchos::ParameterList> pcdParams_;

  bool schurCompOrdering_;

  static Teuchos::RCP<Teuchos::Time> initTimer_;
  static Teuchos::RCP<Teuchos::Time> invSTimer_;
  static Teuchos::RCP<Teuchos::Time> invFTimer_;
  static Teuchos::RCP<Teuchos::Time> opsTimer_;

 public:
  // some static functions for determining strings

  static std::string getPCDString() { return "PCD Operator"; }
  static std::string getPressureLaplaceString() { return "Pressure Laplace Operator"; }
  static std::string getPressureMassString() { return "Pressure Mass Matrix"; }
};

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

#endif