Teko_LSCPreconditionerFactory.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_LSCPreconditionerFactory_hpp__
#define __Teko_LSCPreconditionerFactory_hpp__

#include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_LSCStrategy.hpp"

namespace Teko {
namespace NS {  // Navier-Stokes specialization

class LSCPrecondState : public BlockPreconditionerState {
 public:
  LSCPrecondState() {}

  LinearOp invMass_;

  ModifiableLinearOp BQBt_;

  ModifiableLinearOp BHBt_;

  LinearOp BQBtmC_;
  InverseLinearOp invBQBtmC_;

  LinearOp BHBtmC_;
  InverseLinearOp invBHBtmC_;

  LinearOp aiD_;

  double gamma_;

  double alpha_;
};

class LSCPreconditionerFactory : public BlockPreconditionerFactory {
 public:


  LSCPreconditionerFactory(const LinearOp& invF, const LinearOp& invBQBtmC, const LinearOp& invD,
                           const LinearOp& invMass);

  LSCPreconditionerFactory(const LinearOp& invF, const LinearOp& invBQBtmC,
                           const LinearOp& invMass);

  LSCPreconditionerFactory(const Teuchos::RCP<LSCStrategy>& strategy);

  LSCPreconditionerFactory();

  virtual LinearOp buildPreconditionerOperator(BlockedLinearOp& blo,
                                               BlockPreconditionerState& state) const;

  virtual RCP<PreconditionerState> buildPreconditionerState() const {
    return rcp(new LSCPrecondState());
  }

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

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

 protected:
  using Teko::BlockPreconditionerFactory::buildPreconditionerOperator;

  // Gimmie object
  Teuchos::RCP<LSCStrategy> invOpsStrategy_;
  bool isSymmetric_;

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

 public:
  static RCP<LSCStrategy> buildStrategy(const std::string& name,
                                        const Teuchos::ParameterList& settings,
                                        const RCP<const InverseLibrary>& invLib,
                                        const RCP<RequestHandler>& rh);

  static void addStrategy(const std::string& name, const RCP<Cloneable>& clone);

 private:
  static CloneFactory<LSCStrategy> strategyBuilder_;

  static void initializeStrategyBuilder();
};

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

#endif