Xpetra_TpetraImport_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//             Xpetra: A linear algebra interface package
//                  Copyright 2012 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
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_TPETRAIMPORT_DECL_HPP
#define XPETRA_TPETRAIMPORT_DECL_HPP
 
/* this file is automatically generated - do not edit (see script/tpetra.py) */
 
#include "Xpetra_TpetraConfigDefs.hpp"
 
#include "Xpetra_Import.hpp"
#include "Xpetra_Exceptions.hpp"
 
#include "Xpetra_TpetraMap_decl.hpp"
#include "Tpetra_Import.hpp"
 
namespace Xpetra {
 
  template <class LocalOrdinal,
            class GlobalOrdinal,
            class Node = KokkosClassic::DefaultNode::DefaultNodeType>
  class TpetraImport
    : public Import<LocalOrdinal, GlobalOrdinal, Node>
  {
 
  public:
 
    typedef Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
 
 
 
    TpetraImport(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target);
 
    TpetraImport(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist);
 
    TpetraImport(const Import< LocalOrdinal, GlobalOrdinal, Node > &import);
 
    ~TpetraImport();
 
    Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
    createRemoteOnlyImport (const Teuchos::RCP<const map_type>& remoteTarget) const;
 
 
 
 
    size_t getNumSameIDs() const;
 
    size_t getNumPermuteIDs() const;
 
    ArrayView< const LocalOrdinal > getPermuteFromLIDs() const;
 
    ArrayView< const LocalOrdinal > getPermuteToLIDs() const;
 
    size_t getNumRemoteIDs() const;
 
    ArrayView< const LocalOrdinal > getRemoteLIDs() const;
 
    void setDistributorParameters(const Teuchos::RCP<Teuchos::ParameterList> params) const;
 
    size_t getNumExportIDs() const;
 
    ArrayView< const LocalOrdinal > getExportLIDs() const;
 
    ArrayView< const int > getExportPIDs() const;
 
    Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getSourceMap() const;
 
    Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getTargetMap() const;
 
 
 
 
    void print(std::ostream &os) const;
 
 
 
 
    TpetraImport(const RCP<const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > &import);
 
    RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > getTpetra_Import() const;
 
 
  private:
 
    RCP<const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > import_;
 
  }; // TpetraImport class
 
 
  // TODO: move that elsewhere
  template <class LocalOrdinal, class GlobalOrdinal, class Node>
  const Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node> & toTpetra(const Import<LocalOrdinal,GlobalOrdinal,Node> &import) {
    // TODO: throw exception
    const TpetraImport<LocalOrdinal,GlobalOrdinal,Node> & tpetraImport = dynamic_cast<const TpetraImport<LocalOrdinal,GlobalOrdinal,Node> &>(import);
    return *tpetraImport.getTpetra_Import();
  }
 
  template <class LocalOrdinal, class GlobalOrdinal, class Node>
  const RCP< const Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > toTpetra(const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &importObj) {
    typedef TpetraImport<LocalOrdinal, GlobalOrdinal, Node> TpetraImportClass;
    if (importObj != Teuchos::null) {
      XPETRA_RCP_DYNAMIC_CAST(const TpetraImportClass, rcpFromRef(*importObj), tpetraImport, "toTpetra");
      return tpetraImport->getTpetra_Import();
    }
    return Teuchos::null;
  }
 
  template <class LocalOrdinal, class GlobalOrdinal, class Node>
  RCP<const Import<LocalOrdinal,GlobalOrdinal,Node> > toXpetra(const RCP< const Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node > >& import) {
    if (!import.is_null())
      return rcp(new TpetraImport<LocalOrdinal,GlobalOrdinal,Node>(import));
 
    return Teuchos::null;
  }
 
} // Xpetra namespace
 
#endif // XPETRA_TPETRAIMPORT_HPP