Teko_TpetraBlockedMappingStrategy.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_TpetraBlockedMappingStrategy_hpp__
#define __Teko_TpetraBlockedMappingStrategy_hpp__

// stl includes
#include <vector>

// Teuchos includes
#include "Teuchos_RCP.hpp"

// Thyra includes
#include "Thyra_MultiVectorBase.hpp"
#include "Thyra_LinearOpBase.hpp"
#include "Thyra_BlockedLinearOpBase.hpp"

// Tpetra includes
#include "Tpetra_Map.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Import.hpp"
#include "Tpetra_Export.hpp"
#include "Tpetra_CrsMatrix.hpp"

// Teko includes
#include "Teko_TpetraOperatorWrapper.hpp"
#include "Teko_BlockingTpetra.hpp"
#include "Teko_ConfigDefs.hpp"

namespace Teko {
namespace TpetraHelpers {

class TpetraBlockedMappingStrategy : public MappingStrategy {
public:


   TpetraBlockedMappingStrategy(const std::vector<std::vector<GO> > & vars,
         const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);



   virtual void copyTpetraIntoThyra(const Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_X, 
                                    const Teuchos::Ptr<Thyra::MultiVectorBase<ST> > & thyra_X) const;

   virtual void copyThyraIntoTpetra(const Teuchos::RCP<const Thyra::MultiVectorBase<ST> > & thyra_Y, 
                                    Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_Y) const;

   virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap() const
   { return domainMap_; }

   virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap() const
   { return rangeMap_; }

   virtual std::string toString() const
   { return std::string("TpetraBlockedMappingStrategy"); }
 



   void buildBlockTransferData(const std::vector<std::vector<GO> > & vars,
         const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);

   const std::vector<Blocking::MapPair> & getMaps() const
   { return blockMaps_; }

   const Teuchos::RCP<Thyra::BlockedLinearOpBase<ST> > 
   buildBlockedThyraOp(const Teuchos::RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,const std::string & label="<ANYM>") const;

   void rebuildBlockedThyraOp(const RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,
                              const RCP<Thyra::BlockedLinearOpBase<ST> > & A) const;


protected:
   // member variables


   Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap_; 
   Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap_;


   std::vector<Blocking::MapPair> blockMaps_;
   std::vector<Teuchos::RCP<Tpetra::Import<LO,GO,NT> > > blockImport_;
   std::vector<Teuchos::RCP<Tpetra::Export<LO,GO,NT> > > blockExport_;
};

} // end namespace TpetraHelpers
} // end namespace Teko

#endif