EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
LL/Poisson2dOperator.h
Go to the documentation of this file.
1 
2 //@HEADER
3 // ***********************************************************************
4 //
5 // EpetraExt: Epetra Extended - 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 #ifndef _POISSON2DOPERATOR_H_
44 #define _POISSON2DOPERATOR_H_
45 
46 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
47 #ifdef __GNUC__
48 #warning "The EpetraExt package is deprecated"
49 #endif
50 #endif
51 
52 class Epetra_MultiVector;
53 class Epetra_CrsMatrix;
54 class Epetra_Map;
55 class Epetra_Import;
56 class Epetra_BlockMap;
57 class Epetra_Comm;
58 #include "Epetra_Operator.h"
59 
61 
65 class Poisson2dOperator: public virtual Epetra_Operator {
66 
67  public:
68 
70 
75  Poisson2dOperator(int nx, int ny, const Epetra_Comm & comm);
80 
82 
84 
95 
97 
99 
107  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
108 
110 
121  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {return(Apply(X,Y));};
122 
124  /* Returns the quantity \f$ \| A \|_\infty\f$ such that
125  \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
126 
127  \warning This method must not be called unless HasNormInf() returns true.
128  */
129  double NormInf() const {return(8.0);};
131 
133 
135  const char * Label() const{return(Label_);};
136 
138  bool UseTranspose() const {return(useTranspose_);};
139 
141  bool HasNormInf() const{return(true);};
142 
144  const Epetra_Comm & Comm() const{return(comm_);};
145 
147  const Epetra_Map & OperatorDomainMap() const {return(*map_);};
148 
150  const Epetra_Map & OperatorRangeMap() const {return(*map_);};
152 
154 
158 
159 
160  int nx_, ny_, myny_;
161  bool useTranspose_;
162  const Epetra_Comm & comm_;
163  Epetra_Map * map_;
164  int numImports_;
165  long long * importIDs_;
168  mutable Epetra_MultiVector * importX_;
169  const char * Label_;
170 };
171 
172 #endif /* _POISSON2DOPERATOR_H_ */
Epetra_Map * importMap_
const Epetra_Comm & Comm() const
Returns a pointer to the Epetra_Comm communicator associated with this operator.
~Poisson2dOperator()
Destructor.
const char * Label() const
Returns a character string describing the operator.
int SetUseTranspose(bool UseTranspose)
If set true, transpose of this operator will be applied.
int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Poisson2dOperator inverse applied to an Epetra_MultiVector X in Y...
double NormInf() const
Returns the infinity norm of the global matrix.
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Poisson2dOperator applied to a Epetra_MultiVector X in Y. ...
const Epetra_Comm & comm_
Poisson2dOperator: A sample implementation of the Epetra_Operator class.
Epetra_CrsMatrix * GeneratePrecMatrix() const
Generate a tridiagonal approximation to the 5-point Poisson as an Epetra_CrsMatrix.
Epetra_Import * importer_
const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this operator.
Epetra_MultiVector * importX_
Poisson2dOperator(int nx, int ny, const Epetra_Comm &comm)
Builds a 2 dimensional Poisson operator for a nx by ny grid, assuming zero Dirichlet BCs...
bool UseTranspose() const
Returns the current UseTranspose setting.
const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this operator.
bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.