EpetraExt_ProductOperator.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 Copyright (2011) 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER

#ifndef EPETRAEXT_PRODUCT_OPERATOR_H
#define EPETRAEXT_PRODUCT_OPERATOR_H

#if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The EpetraExt package is deprecated"
#endif
#endif

#include "Epetra_Operator.h"
#include "Teuchos_RCP.hpp"
#include "Teuchos_BLAS_types.hpp"
#include <vector>

class Epetra_Vector;

namespace EpetraExt {

class ProductOperator : public Epetra_Operator {
public:


        enum EApplyMode { APPLY_MODE_APPLY, APPLY_MODE_APPLY_INVERSE };



        ProductOperator();

        ProductOperator(
                const int                                            num_Op
                ,const Teuchos::RCP<const Epetra_Operator>   Op[]
                ,const Teuchos::ETransp                              Op_trans[]
                ,const EApplyMode                                    Op_inverse[]
                );

        void initialize(
                const int                                            num_Op
                ,const Teuchos::RCP<const Epetra_Operator>   Op[]
                ,const Teuchos::ETransp                              Op_trans[]
                ,const EApplyMode                                    Op_inverse[]
                );

        void uninitialize(
                int                                            *num_Op
                ,Teuchos::RCP<const Epetra_Operator>   Op[]
                ,Teuchos::ETransp                              Op_trans[]
                ,EApplyMode                                    p_inverse[]
                );

        void applyConstituent(
                const int                  k
                ,Teuchos::ETransp          Op_trans
                ,EApplyMode                Op_inverse
                ,const Epetra_MultiVector  &X_k
                ,Epetra_MultiVector        *Y_k
                ) const;

        int num_Op() const;

        Teuchos::RCP<const Epetra_Operator> Op(int k) const;

        Teuchos::ETransp Op_trans(int k) const;

  EApplyMode Op_inverse(int k) const;



        int SetUseTranspose(bool UseTranspose);
        int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
        int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
        double NormInf() const;
        const char * Label() const;
        bool UseTranspose() const;
        bool HasNormInf() const;
        const Epetra_Comm & Comm() const;
        const Epetra_Map & OperatorDomainMap() const;
        const Epetra_Map & OperatorRangeMap() const;


private:

        // ////////////////////////////
        // Private types

        typedef std::vector<Teuchos::RCP<const Epetra_Operator> >  Op_t;
        typedef std::vector<Teuchos::ETransp>                        Op_trans_t;
        typedef std::vector<EApplyMode>                              Op_inverse_t;
        typedef std::vector<Teuchos::RCP<Epetra_Vector> >    EV_t;

        // ////////////////////////////
        // Private data members

        bool          UseTranspose_;
        Op_t          Op_;
        Op_trans_t    Op_trans_;
        Op_inverse_t  Op_inverse_;

        mutable EV_t  range_vecs_;
        mutable EV_t  domain_vecs_;

        // ////////////////////////////
        // Private member functions

        void assertInitialized() const;
        void validateIndex(int k) const;
        void initializeTempVecs(bool applyInverse) const;

}; // class ProductOperator

// ////////////////////////////
// Inline members

// public

inline
int ProductOperator::num_Op() const
{
        return Op_.size();
}

inline
Teuchos::RCP<const Epetra_Operator>
ProductOperator::Op(int k) const
{
        validateIndex(k);
        return Op_[k];
}

inline
Teuchos::ETransp
ProductOperator::Op_trans(int k) const
{
        validateIndex(k);
        return Op_trans_[k];
}

inline
ProductOperator::EApplyMode
ProductOperator::Op_inverse(int k) const
{
        validateIndex(k);
        return Op_inverse_[k];
}


// private

inline
void ProductOperator::assertInitialized() const
{
        TEUCHOS_TEST_FOR_EXCEPTION(
                Op_.size()==0, std::logic_error
                ,"Epetra::ProductOperator: Error, Client has not called initialize(...) yet!"
                );
}

inline
void ProductOperator::validateIndex(int k) const
{
        TEUCHOS_TEST_FOR_EXCEPTION(
                k < 0 || static_cast<int>(Op_.size())-1 < k, std::logic_error
                ,"Epetra::ProductOperator: Error, k = "<<k<< " is not in the range [0,"<<Op_.size()-1<<"]!"
                );
}

} // namespace EpetraExt

#endif // EPETRAEXT_PRODUCT_OPERATOR_H