Teko_LSCStrategy.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_LSCStrategy_hpp__
#define __Teko_LSCStrategy_hpp__

#include "Teuchos_RCP.hpp"

#include "Thyra_LinearOpBase.hpp"

#include "Teko_Utilities.hpp"
#include "Teko_InverseFactory.hpp"
#include "Teko_BlockPreconditionerFactory.hpp"

namespace Teko {
namespace NS {

class LSCPrecondState;  // forward declaration

class LSCStrategy {
 public:
  virtual ~LSCStrategy() {}

  virtual void buildState(BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInvBQBt(const BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInvBHBt(const BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInvF(const BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

#if 0

   virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
#endif

  virtual LinearOp getOuterStabilization(const BlockedLinearOp& A,
                                         BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInnerStabilization(const BlockedLinearOp& A,
                                         BlockPreconditionerState& state) const = 0;

  virtual LinearOp getInvMass(const BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

  virtual LinearOp getHScaling(const BlockedLinearOp& A, BlockPreconditionerState& state) const = 0;

  virtual bool useFullLDU() const = 0;

  virtual void setSymmetric(bool isSymmetric) = 0;

  virtual void initializeFromParameterList(const Teuchos::ParameterList& /* pl */,
                                           const InverseLibrary& /* invLib */) {}

  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const {
    return Teuchos::null;
  }

  virtual bool updateRequestedParameters(const Teuchos::ParameterList& /* pl */) { return true; }

  void setRequestHandler(const Teuchos::RCP<RequestHandler>& rh) { requestHandler_ = rh; }

  Teuchos::RCP<RequestHandler> getRequestHandler() const { return requestHandler_; }

 private:
  Teuchos::RCP<RequestHandler> requestHandler_;
};

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

#endif