EpetraExt Package Browser (Single Doxygen Collection) Development
EpetraExt_TimedEpetraOperator.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //     EpetraExt: Epetra Extended - Linear Algebra Services Package
00005 //                 Copyright (2011) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 
00042 #ifndef EPETRAEXT_TIMED_EPETRA_OP_HPP
00043 #define EPETRAEXT_TIMED_EPETRA_OP_HPP
00044 
00045 #include "Teuchos_RCP.hpp"
00046 #include "Epetra_Operator.h"
00047 #include "Epetra_MultiVector.h"
00048 #include <Teuchos_Time.hpp>
00049 #include <EpetraExt_ConfigDefs.h>
00050 
00051 namespace EpetraExt {
00052     
00057   class Epetra_Timed_Operator : public Epetra_Operator {
00058       
00059   public:
00060 
00062     Epetra_Timed_Operator(const Teuchos::RCP<Epetra_Operator>& A_);
00063     
00065     virtual ~Epetra_Timed_Operator();
00066 
00068     int SetUseTranspose(bool useTranspose);
00069     
00074     virtual int Apply(const Epetra_MultiVector& Input, 
00075                       Epetra_MultiVector& Result) const;
00076 
00081     virtual int ApplyInverse(const Epetra_MultiVector& X, 
00082                              Epetra_MultiVector& Y) const;
00083     
00085     virtual double NormInf() const;
00086     
00088     virtual const char* Label () const;
00089   
00091     virtual bool UseTranspose() const;
00092     
00097     virtual bool HasNormInf() const;
00098 
00103     virtual const Epetra_Comm & Comm() const;
00104 
00109     virtual const Epetra_Map& OperatorDomainMap () const;
00110 
00115     virtual const Epetra_Map& OperatorRangeMap () const;
00116     
00120     virtual double ApplyTime() const{return this->ApplyTimer->totalElapsedTime(false);};
00121 
00125     virtual double ApplyInverseTime() const{return this->ApplyInverseTimer->totalElapsedTime(false);};
00126 
00130     virtual Teuchos::RCP<const Epetra_Operator> ReturnOperator() const{return this->A;};
00131 
00132   private:
00133     
00135     Epetra_Timed_Operator(const Epetra_Timed_Operator&);
00136     
00138     Epetra_Timed_Operator & operator=(const Epetra_Timed_Operator&);
00139     
00140   protected:
00141     
00143     Teuchos::RCP<Epetra_Operator> A;
00144 
00146     Teuchos::RCP<Teuchos::Time> ApplyTimer;
00147 
00149     Teuchos::RCP<Teuchos::Time> ApplyInverseTimer;
00150 
00151   }; // class Epetra_Timed_Operator
00152   
00153 } // namespace EpetraExt
00154 
00155 #endif // EPETRAEXT_TIMED_EPETRA_OP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines