Teko Version of the Day
Teko_DiagnosticPreconditionerFactory.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_DiagnosticPreconditionerFactory_hpp__
00048 #define __Teko_DiagnosticPreconditionerFactory_hpp__
00049 
00050 #include "Teuchos_Time.hpp"
00051 
00052 // Teko includes
00053 #include "Teko_PreconditionerFactory.hpp"
00054 
00055 namespace Teko {
00056 
00072 class DiagnosticPreconditionerFactory 
00073    : public virtual Teko::PreconditionerFactory {
00074 public:
00076    DiagnosticPreconditionerFactory();
00077 
00084    DiagnosticPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory,const std::string & label,
00085                                    const Teuchos::RCP<std::ostream> & os=Teuchos::null,bool printResidual=false);
00086 
00088    virtual ~DiagnosticPreconditionerFactory();
00089 
00103    virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;
00104 
00106 
00107 
00118    virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
00119 
00132    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
00133    
00145    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
00146    
00148 
00149    int numInitialBuilds() const { return buildTimer_->numCalls(); }
00150    double totalInitialBuildTime() const { return buildTimer_->totalElapsedTime(); }
00151 
00152    int numRebuilds() const { return rebuildTimer_->numCalls(); }
00153    double totalRebuildTime() const { return rebuildTimer_->totalElapsedTime(); }
00154 
00155 private:
00156    void initTimers(const std::string & label);
00157 
00158    Teuchos::RCP<std::ostream> outputStream_;
00159    Teuchos::RCP<Teko::InverseFactory> invFactory_;
00160    std::string diagString_;
00161    bool printResidual_;
00162 
00163    mutable Teuchos::RCP<Teuchos::Time> buildTimer_;   // only first pass construction time (no rebuild)
00164    mutable Teuchos::RCP<Teuchos::Time> rebuildTimer_; // rebuild-construction timer (no build)
00165 };
00166 
00167 } // end namespace Teko
00168 
00169 #endif
 All Classes Files Functions Variables