Epetra Package Browser (Single Doxygen Collection) Development
Epetra_Operator.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 // 
00005 //               Epetra: Linear Algebra Services Package 
00006 //                 Copyright 2001 Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef EPETRA_OPERATOR_H
00045 #define EPETRA_OPERATOR_H
00046 
00047 #include "Epetra_ConfigDefs.h"
00048 class Epetra_MultiVector;
00049 class Epetra_Map;
00050 class Epetra_Comm;
00051 
00053 
00060 class EPETRA_LIB_DLL_EXPORT Epetra_Operator {
00061       
00062  public:
00063 
00065 
00066 
00067     virtual ~Epetra_Operator() {};
00069   
00071 
00072 
00074 
00083     virtual int SetUseTranspose(bool UseTranspose) = 0;
00085   
00087 
00088 
00090 
00098     virtual int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
00099 
00101 
00112     virtual int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
00113 
00115     /* Returns the quantity \f$ \| A \|_\infty\f$ such that
00116        \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
00117 
00118        \warning This method must not be called unless HasNormInf() returns true.
00119     */ 
00120     virtual double NormInf() const = 0;
00122   
00124 
00125 
00127     virtual const char * Label() const = 0;
00128 
00130     virtual bool UseTranspose() const = 0;
00131 
00133     virtual bool HasNormInf() const = 0;
00134 
00136     virtual const Epetra_Comm & Comm() const = 0;
00137 
00139     virtual const Epetra_Map & OperatorDomainMap() const = 0;
00140 
00142     virtual const Epetra_Map & OperatorRangeMap() const = 0;
00144 
00145 };
00146 
00147 #endif /* EPETRA_OPERATOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines