PlayaGhostImporter.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                 Playa: Programmable Linear Algebra
//                 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 Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef PLAYA_GHOSTIMPORTER_HPP
#define PLAYA_GHOSTIMPORTER_HPP

#include "PlayaVectorDecl.hpp"
#include "PlayaVectorSpaceDecl.hpp"
#include "PlayaGhostView.hpp"

namespace Playa
{
using namespace Teuchos;

/**
 * In many applications it is necessary to view some subset of 
 * off-processor, or "ghost", elements of a vector. In 
 * matrix-vector multiplications,
 * access to off-processor elements is assumed to be handled internally
 * by the apply() method of LinearOp subtypes, so the Playa Vector type
 * does not need explicit accessors for ghost elements. However, in 
 * application interfaces such as finite element assembly engines, 
 * read-only access to ghost elements is sometimes required. The abstract
 * classes GhostImporter and GhostView define flexible interfaces
 * through which a set of required ghosts can be defined, ghost values
 * can be imported, and element values can be accessed through
 * global indices.
 *
 * Class GhostImporter is used to specify the set of ghost elements
 * that must be imported to this processor, and then to carry out the import.
 * It will often be the case that we do many imports with the same
 * set of ghost indices; for example, in a nonlinear problem the
 * import of the same set of ghost indices
 * will be repeated at each function evaluation. Therefore, it makes sense
 * to do the definition of the ghost index set and the import as
 * distinct methods. The definition of the ghost index set should be done
 * in the constructors of GhostImporter subclasses.
 */
template <class Scalar>
class GhostImporter
{
public:
  /** virtual dtor */
  virtual ~GhostImporter(){;}

  /** 
   * Import the ghost elements of the given vector
   * as specified during construction of this object. 
   */
  virtual void importView(const Vector<Scalar>& x,
    RCP<GhostView<Scalar> >& ghostView) const = 0 ;

};

}

#endif