Teko Version of the Day
Teko_DiagnosticLinearOp.hpp
Go to the documentation of this file.
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 
00053 #ifndef __Teko_DiagnosticLinearOp_hpp__
00054 #define __Teko_DiagnosticLinearOp_hpp__
00055 
00056 #include <iostream>
00057 
00058 #include "Teko_Utilities.hpp"
00059 #include "Teko_ImplicitLinearOp.hpp"
00060 
00061 #include "Teuchos_Time.hpp"
00062 
00063 namespace Teko {
00064 
00069 class DiagnosticLinearOp : public ImplicitLinearOp {
00070 public:
00075    DiagnosticLinearOp(const Teuchos::RCP<std::ostream> & ostrm,const ModifiableLinearOp & A,const std::string & diagnosticString);
00076 
00081    DiagnosticLinearOp(const Teuchos::RCP<std::ostream> & ostrm,const LinearOp & fwdOp,const ModifiableLinearOp & A,const std::string & diagnosticString);
00082 
00085    virtual ~DiagnosticLinearOp();
00086 
00088 
00089 
00091    virtual VectorSpace range() const { return wrapOpA_->range(); }
00092 
00094    virtual VectorSpace domain() const { return wrapOpA_->range(); }
00095 
00108    virtual void implicitApply(const MultiVector & x, MultiVector & y,
00109               const double alpha = 1.0, const double beta = 0.0) const;
00111 
00112    virtual void describe(Teuchos::FancyOStream & out_arg,
00113                          const Teuchos::EVerbosityLevel verbLevel) const
00114    { wrapOpA_->describe(out_arg,verbLevel); }
00115 
00116    int numApplications() const { return timer_.numCalls(); }
00117    double totalTime() const { return timer_.totalElapsedTime(); }
00118 
00119    ModifiableLinearOp getModifiableOp() const
00120    { return wrapOpA_; } 
00121 
00122    LinearOp getLinearOp() const
00123    { return wrapOpA_; } 
00124  
00125    void setForwardOp(const Teko::LinearOp & lo)
00126    { fwdOp_ = lo; }
00127  
00128    /* Get the residual norm.  Used purely for testing.
00129     */
00130    double getResidualNorm() const
00131    { return residualNorm_; }
00132 
00133 protected:
00134    // fundamental operators to use
00135    Teuchos::RCP<std::ostream> outputStream_;
00136    ModifiableLinearOp wrapOpA_;      
00137    Teko::LinearOp fwdOp_;      
00138    std::string diagString_;
00139 
00140    mutable double residualNorm_; // for testing purposes
00141    mutable Teuchos::Time timer_;
00142 
00143 private:
00144    // hide me!
00145    DiagnosticLinearOp();
00146    DiagnosticLinearOp(const DiagnosticLinearOp &);
00147 };
00148 
00162 inline ModifiableLinearOp createDiagnosticLinearOp(const Teuchos::RCP<std::ostream> & os,const ModifiableLinearOp & A,const std::string & label)
00163 {
00164    return Teuchos::rcp(new DiagnosticLinearOp(os,A,label));
00165 }
00166 
00181 inline ModifiableLinearOp createDiagnosticLinearOp(const Teuchos::RCP<std::ostream> & os,const Teko::LinearOp & fwdOp,const ModifiableLinearOp & A,const std::string & label)
00182 {
00183    return Teuchos::rcp(new DiagnosticLinearOp(os,fwdOp,A,label));
00184 }
00185 
00186 } // end namespace Teko
00187 
00188 #endif  
 All Classes Files Functions Variables