Teko_LSCPreconditionerFactory.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_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