Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_Operator.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Epetra: Linear Algebra Services Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRA_OPERATOR_H
45 #define EPETRA_OPERATOR_H
46 
47 #include "Epetra_ConfigDefs.h"
48 class Epetra_MultiVector;
49 class Epetra_Map;
50 class Epetra_Comm;
51 
53 
60 class EPETRA_LIB_DLL_EXPORT Epetra_Operator {
61 
62  public:
63 
65 
66  virtual ~Epetra_Operator() {};
69 
71 
72 
74 
83  virtual int SetUseTranspose(bool UseTranspose) = 0;
85 
87 
88 
90 
98  virtual int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
99 
101 
112  virtual int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const = 0;
113 
115  /* Returns the quantity \f$ \| A \|_\infty\f$ such that
116  \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
117 
118  \warning This method must not be called unless HasNormInf() returns true.
119  */
120  virtual double NormInf() const = 0;
122 
124 
125 
127  virtual const char * Label() const = 0;
128 
130  virtual bool UseTranspose() const = 0;
131 
133  virtual bool HasNormInf() const = 0;
134 
136  virtual const Epetra_Comm & Comm() const = 0;
137 
139  virtual const Epetra_Map & OperatorDomainMap() const = 0;
140 
142  virtual const Epetra_Map & OperatorRangeMap() const = 0;
144 
145 };
146 
147 #endif /* EPETRA_OPERATOR_H */
Epetra_MultiVector: A class for constructing and using dense multi-vectors, vectors and matrices in p...
Epetra_Map: A class for partitioning vectors and matrices.
Definition: Epetra_Map.h:119
Epetra_Comm: The Epetra Communication Abstract Base Class.
Definition: Epetra_Comm.h:73
Epetra_Operator: A pure virtual class for using real-valued double-precision operators.