Stokhos_ProductEpetraOperator.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                           Stokhos Package
//                 Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// 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 T. Phipps (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP
#define STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP

#include "Stokhos_ProductContainer.hpp"
#include "Stokhos_VectorOrthogPolyTraitsEpetra.hpp"
#include "Epetra_Map.h"
#include "EpetraExt_MultiComm.h"

namespace Stokhos {

  class ProductEpetraOperator :
    public virtual ProductContainer<Epetra_Operator>,
    public virtual Epetra_Operator {
  public:

    typedef double value_type;

    typedef int ordinal_type;

    ProductEpetraOperator(
      const Teuchos::RCP<const Epetra_BlockMap>& block_map,
      const Teuchos::RCP<const Epetra_Map>& domain_base_map,
      const Teuchos::RCP<const Epetra_Map>& range_base_map,
      const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);

    /*
     * This version supplies the generated product map \c product_map
     */
    ProductEpetraOperator(
      const Teuchos::RCP<const Epetra_BlockMap>& block_map,
      const Teuchos::RCP<const Epetra_Map>& domain_base_map,
      const Teuchos::RCP<const Epetra_Map>& range_base_map,
      const Teuchos::RCP<const Epetra_Map>& range_product_map,
      const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);
    

    ProductEpetraOperator(const ProductEpetraOperator& v);

    virtual ~ProductEpetraOperator();


    ProductEpetraOperator& operator=(const ProductEpetraOperator& v);

    Teuchos::RCP<const EpetraExt::MultiComm> productComm() const;

    
    virtual int SetUseTranspose(bool UseTranspose);
    
    virtual int Apply(const Epetra_MultiVector& Input, 
                      Epetra_MultiVector& Result) const;

    virtual int ApplyInverse(const Epetra_MultiVector& X, 
                             Epetra_MultiVector& Y) const;
    
    virtual double NormInf() const;
    
    virtual const char* Label () const;
  
    virtual bool UseTranspose() const;
    
    virtual bool HasNormInf() const;

    virtual const Epetra_Comm & Comm() const;

    virtual const Epetra_Map& OperatorDomainMap () const;

    virtual const Epetra_Map& OperatorRangeMap () const;


  protected:

    ProductEpetraOperator(
      const Teuchos::RCP<const Epetra_BlockMap>& block_map,
      const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm);

    void setup(const Teuchos::RCP<const Epetra_Map>& domain_base_map,
         const Teuchos::RCP<const Epetra_Map>& range_base_map);

  protected:

    Teuchos::RCP<const Epetra_Map> domain_base_map;

    Teuchos::RCP<const Epetra_Map> range_base_map;

    Teuchos::RCP<const Epetra_Map> product_range_map;

    Teuchos::RCP<const EpetraExt::MultiComm> product_comm;

    bool useTranspose;

  }; // class ProductEpetraOperator

} // end namespace Stokhos

#endif  // STOKHOS_PRODUCT_EPETRA_OPERATOR_HPP