PlayaBlockOperatorBaseDecl.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_BLOCKOPERATORBASE_DECL_HPP
#define PLAYA_BLOCKOPERATORBASE_DECL_HPP

#include "PlayaDefs.hpp"


namespace Playa
{


template <class Scalar>
class LinearOperator;

/**
 * Class BlockOperatorBase provides an abstract interface for accessing
 * blocks of block operators
 *
 * @author Paul T Boggs (ptboggs@sandia.gov)
 */
template <class Scalar>
class BlockOperatorBase 
{
public:

  /** */
  virtual int numBlockRows() const = 0 ;

  /** */
  virtual int numBlockCols() const = 0 ;

  /** */
  virtual const LinearOperator<Scalar>& getBlock(int i, int j) const = 0 ;
  /** */
  virtual LinearOperator<Scalar> getNonconstBlock(int i, int j) = 0 ;

}; 

/**
 * Class SetableBlockOperatorBase provides an abstract interface for setting
 * blocks of block operators
 *
 * @author Paul T Boggs (ptboggs@sandia.gov)
 */
template <class Scalar>
class SetableBlockOperatorBase : public BlockOperatorBase<Scalar>
{
public:

  /** */
  virtual void setBlock(int i, int j, const LinearOperator<Scalar>& Aij) = 0 ;

  /** Callback to finalize block fill. The default is a no-op. */
  virtual void endBlockFill() {;}

  

}; 





}

#endif