Epetra Package Browser (Single Doxygen Collection) Development
Epetra_InvOperator.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 // 
00005 //               Epetra: Linear Algebra Services Package 
00006 //                 Copyright 2011 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_INVOPERATOR_H
00045 #define EPETRA_INVOPERATOR_H
00046 
00047 class Epetra_MultiVector;
00048 class Epetra_BlockMap;
00049 class Epetra_Comm;
00050 #include <string>
00051 #include "Epetra_Operator.h"
00052 
00054 
00059 class Epetra_InvOperator: public virtual Epetra_Operator {
00060       
00061  public:
00062 
00064 
00065 
00066 
00069   Epetra_InvOperator(Epetra_Operator * operatorIn) {
00070     operator_ = operatorIn; 
00071     Label_ = "Inverse of " + string(operatorIn->Label());
00072     return;
00073   }
00075   virtual ~Epetra_InvOperator(){}
00077   
00079 
00080 
00082 
00091   int SetUseTranspose(bool UseTranspose_in){EPETRA_CHK_ERR(operator_->SetUseTranspose(UseTranspose_in)); return(0);}
00093   
00095 
00096 
00098 
00106   int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {EPETRA_CHK_ERR(operator_->ApplyInverse(X,Y)); return(0);}
00107 
00109 
00117   int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const{EPETRA_CHK_ERR(operator_->Apply(X,Y)); return(0);}
00118   
00120   /* Returns the quantity \f$ \| A \|_\infty\f$ such that
00121      \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
00122      
00123      \warning This method must not be called unless HasNormInf() returns true.
00124   */ 
00125   double NormInf() const {return(operator_->NormInf());}
00126   
00128 
00129 
00131   const char * Label() const {return(Label_.c_str());}
00132 
00134   Epetra_Operator * Operator() const {return(operator_);}
00135 
00136   
00138   bool UseTranspose() const {return(operator_->UseTranspose());}
00139   
00141   bool HasNormInf() const {return(operator_->HasNormInf());};
00142   
00144   const Epetra_Comm & Comm() const {return(operator_->Comm());}
00145   
00147   const Epetra_Map & OperatorDomainMap() const
00148   {
00149     if (!UseTranspose()) return(operator_->OperatorRangeMap());
00150     else return(operator_->OperatorDomainMap());
00151   }
00152   
00154   const Epetra_Map & OperatorRangeMap() const
00155   {
00156     if (!UseTranspose()) return(operator_->OperatorDomainMap());
00157     else return(operator_->OperatorRangeMap());
00158   }
00160   
00161  protected:
00162 
00163   Epetra_Operator * operator_;
00164   string Label_;
00165 };
00166 
00167 #endif /* EPETRA_INVOPERATOR_H */
00168 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines