Teko_LU2x2PreconditionerFactory.cpp

/*
// @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

*/

#include "Teko_LU2x2PreconditionerFactory.hpp"

// Teko includes
#include "Teko_LU2x2InverseOp.hpp"
#include "Teko_BlockUpperTriInverseOp.hpp"

// default strategies
#include "Teko_LU2x2DiagonalStrategy.hpp"
#include "NS/Teko_PCDStrategy.hpp"

using Teuchos::rcp;
using Teuchos::RCP;

namespace Teko {

// construct a PreconditionerFactory
LU2x2PreconditionerFactory::LU2x2PreconditionerFactory(LinearOp & invA00, LinearOp & invS)
      : invOpsStrategy_(rcp(new StaticLU2x2Strategy(invA00,invA00,invS))), useFullLDU_(true)
{ }

LU2x2PreconditionerFactory::LU2x2PreconditionerFactory(LinearOp & hatInvA00,LinearOp & tildeInvA00,LinearOp & invS)
      : invOpsStrategy_(rcp(new StaticLU2x2Strategy(hatInvA00,tildeInvA00,invS))), useFullLDU_(true)
{ }

LU2x2PreconditionerFactory::LU2x2PreconditionerFactory(const RCP<LU2x2Strategy> & strategy)
   : invOpsStrategy_(strategy), useFullLDU_(true)
{ }

LU2x2PreconditionerFactory::LU2x2PreconditionerFactory()
   : invOpsStrategy_(Teuchos::null), useFullLDU_(true)
{ }

// for PreconditionerFactoryBase

// initialize a newly created preconditioner object
LinearOp LU2x2PreconditionerFactory::buildPreconditionerOperator(BlockedLinearOp & A,BlockPreconditionerState & state) const
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::buildPreconditionerOperator",10);
   LinearOp hatInvA00   = invOpsStrategy_->getHatInvA00(A,state);
   LinearOp tildeInvA00 = invOpsStrategy_->getTildeInvA00(A,state);
   LinearOp invS        = invOpsStrategy_->getInvS(A,state);

   // build the SchurSolve LinearOp
   if(useFullLDU())
      return createLU2x2InverseOp(A,hatInvA00,tildeInvA00,invS,"LU2x2-Full");
   else  {
      std::vector<LinearOp> invDiag(2);
      invDiag[0] = hatInvA00;
      invDiag[1] = scale(-1.0,invS);
      return createBlockUpperTriInverseOp(A,invDiag,"LU2x2-Upper");
   }
}

void LU2x2PreconditionerFactory::initializeFromParameterList(const Teuchos::ParameterList & settings)
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::initializeFromParameterList",10);

   // use Golub & Wathen type or full LDU decomposition for inverse solve?
   bool useLDU = true; 
   if(settings.isParameter("Use LDU"))
      useLDU = settings.get<bool>("Use LDU");
   setFullLDU(useLDU);
   
   // build strategy object
   std::string stratName = settings.get<std::string>("Strategy Name");
   const Teuchos::ParameterList & pl = settings.sublist("Strategy Settings");
   invOpsStrategy_ = buildStrategy(stratName,pl,getInverseLibrary(),getRequestHandler());
}

Teuchos::RCP<Teuchos::ParameterList> LU2x2PreconditionerFactory::getRequestedParameters() const
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::getRequestedParameters",0);
   return invOpsStrategy_->getRequestedParameters();
}

bool LU2x2PreconditionerFactory::updateRequestedParameters(const Teuchos::ParameterList & pl)
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::updateRequestedParameters",0);
   return invOpsStrategy_->updateRequestedParameters(pl);
}

// Static members and methods

CloneFactory<LU2x2Strategy> LU2x2PreconditionerFactory::strategyBuilder_;

RCP<LU2x2Strategy> LU2x2PreconditionerFactory::buildStrategy(const std::string & name, 
                                                             const Teuchos::ParameterList & settings,
                                                             const RCP<const InverseLibrary> & invLib,
                                                             const RCP<RequestHandler> & rh)
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::buildStrategy",0);

   // initialize the defaults if necessary
   if(strategyBuilder_.cloneCount()==0) initializeStrategyBuilder();

   Teko_DEBUG_MSG_BEGIN(1)
      std::vector<std::string> names;
      strategyBuilder_.getCloneNames(names); 
      DEBUG_STREAM << "Strategy names = "; 
      for(std::size_t i=0;i<names.size();i++)
         DEBUG_STREAM << names[i] << ", ";
      DEBUG_STREAM << std::endl;
   Teko_DEBUG_MSG_END()

   // request the preconditioner factory from the CloneFactory
   RCP<LU2x2Strategy> strategy = strategyBuilder_.build(name);

   if(strategy==Teuchos::null) {
      Teko_DEBUG_MSG("Warning: Could not build LU2x2Strategy named \"" 
                 << name << "\"...pressing on, failure expected",0)
      return Teuchos::null;
   }

   // now that inverse library has been set,
   // pass in the parameter list
   strategy->setRequestHandler(rh);
   strategy->initializeFromParameterList(settings,*invLib);

   return strategy;
}

void LU2x2PreconditionerFactory::addStrategy(const std::string & name,const RCP<Cloneable> & clone)
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::addStrategy",10);

   // initialize the defaults if necessary
   if(strategyBuilder_.cloneCount()==0) initializeStrategyBuilder();

   // add clone to builder
   strategyBuilder_.addClone(name,clone); 
}

void LU2x2PreconditionerFactory::initializeStrategyBuilder()
{
   Teko_DEBUG_SCOPE("LU2x2PreconditionerFactory::initializeStrategyBuilder",10);

   RCP<Cloneable> clone;

   // add various strategies to the factory
   clone = rcp(new AutoClone<LU2x2DiagonalStrategy>());
   strategyBuilder_.addClone("Diagonal Strategy",clone);

   // add various strategies to the factory
   clone = rcp(new AutoClone<NS::PCDStrategy>());
   strategyBuilder_.addClone("NS PCD Strategy",clone);
}

} // end namespace Teko