Teko Version of the Day
Teko_BlockedEpetraOperator.hpp
00001 /*
00002 // @HEADER
00003 // 
00004 // ***********************************************************************
00005 // 
00006 //      Teko: A package for block and physics based preconditioning
00007 //                  Copyright 2010 Sandia Corporation 
00008 //  
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 //  
00012 // Redistribution and use in source and binary forms, with or without
00013 // modification, are permitted provided that the following conditions are
00014 // met:
00015 //  
00016 // 1. Redistributions of source code must retain the above copyright
00017 // notice, this list of conditions and the following disclaimer.
00018 //  
00019 // 2. Redistributions in binary form must reproduce the above copyright
00020 // notice, this list of conditions and the following disclaimer in the
00021 // documentation and/or other materials provided with the distribution.
00022 //  
00023 // 3. Neither the name of the Corporation nor the names of the
00024 // contributors may be used to endorse or promote products derived from
00025 // this software without specific prior written permission. 
00026 //  
00027 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00028 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00031 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
00036 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 //  
00039 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
00040 // 
00041 // ***********************************************************************
00042 // 
00043 // @HEADER
00044 
00045 */
00046 
00047 #ifndef __Teko_BlockedEpetraOperator_hpp__
00048 #define __Teko_BlockedEpetraOperator_hpp__
00049 
00050 // Epetra includes
00051 #include "Epetra_Operator.h"
00052 
00053 // Teuchos includes
00054 #include "Teuchos_RCP.hpp"
00055 
00056 #include "Thyra_LinearOpBase.hpp"
00057 
00058 // Teko includes
00059 #include "Teko_BlockedReordering.hpp"
00060 #include "Teko_EpetraOperatorWrapper.hpp"
00061 #include "Teko_BlockedMappingStrategy.hpp"
00062 
00063 namespace Teko {
00064 namespace Epetra {
00065 
00069 class BlockedEpetraOperator : public EpetraOperatorWrapper {
00070 public:
00071 
00080    BlockedEpetraOperator(const std::vector<std::vector<int> > & vars,
00081                          const Teuchos::RCP<const Epetra_Operator> & content,
00082                          const std::string & label="<ANYM>");
00083 
00092    virtual void SetContent(const std::vector<std::vector<int> > & vars,
00093                            const Teuchos::RCP<const Epetra_Operator> & content);
00094 
00098    virtual void RebuildOps()
00099    { BuildBlockedOperator(); }
00100 
00101    virtual const Teuchos::RCP<const Epetra_Operator> GetContent() const
00102    { return fullContent_; }
00103 
00104    virtual const Teuchos::RCP<const Epetra_Operator> GetContent()
00105    { return fullContent_; }
00106 
00107    const Teuchos::RCP<const Epetra_Operator> GetBlock(int i,int j) const;
00108 
00112    void Reorder(const BlockReorderManager & brm);
00113 
00115    void RemoveReording();
00116 
00119    virtual void WriteBlocks(const std::string & prefix) const;
00120 
00121    // functions overloading Epetra_Operator
00123 
00124    // destructor
00125    virtual ~BlockedEpetraOperator() {}
00126 
00127    // attribute set methods
00128    
00129    // don't use transpose...ever!
00130    virtual int SetUseTranspose(bool useTranspose)
00131    { return -1; }
00132 
00133    virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
00134    { TEUCHOS_ASSERT(false); return -1; }
00135 
00136    virtual double NormInf() const
00137    { TEUCHOS_ASSERT(false); return 0.0; }
00138 
00139    // attribute access functions
00140    virtual bool UseTranspose() const { return false; }
00141    virtual bool HasNormInf() const { return false; }
00142    virtual const Epetra_Comm & Comm() const { return fullContent_->Comm(); }
00143 
00144    #ifndef Teko_DEBUG_OFF
00145 
00146    bool testAgainstFullOperator(int count,double tol) const;
00147    #endif
00148 
00149 protected:
00150    // gooey center of this shell
00151    Teuchos::RCP<const Epetra_Operator> fullContent_;
00152    Teuchos::RCP<BlockedMappingStrategy> blockedMapping_;
00153    Teuchos::RCP<Thyra::LinearOpBase<double> > blockedOperator_;
00154    Teuchos::RCP<const BlockReorderManager> reorderManager_;
00155 
00156    std::string label_;
00157 
00158    void BuildBlockedOperator();
00159 };
00160 
00161 } // end namespace Epetra
00162 } // end namespace Teko
00163 
00164 #endif
 All Classes Files Functions Variables