Teko Version of the Day
Teko_DiagonallyScaledPreconditionerFactory.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_DiagonallyScaledPreconditionerFactory_hpp__
00048 #define __Teko_DiagonallyScaledPreconditionerFactory_hpp__
00049 
00050 #include "Teuchos_Time.hpp"
00051 
00052 // Teko includes
00053 #include "Teko_PreconditionerFactory.hpp"
00054 
00055 namespace Teko {
00056 
00083 class DiagonallyScaledPreconditionerFactory 
00084    : public virtual Teko::PreconditionerFactory {
00085 public:
00086    typedef enum {COLUMN_SCALING, ROW_SCALING} ScalingType;
00087 
00089    DiagonallyScaledPreconditionerFactory();
00090 
00095    DiagonallyScaledPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory,ScalingType columnScaling=COLUMN_SCALING,DiagonalType diagonalType=AbsRowSum);
00096 
00098    virtual ~DiagonallyScaledPreconditionerFactory();
00099 
00113    virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;
00114 
00116 
00117 
00128    virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
00129    
00131 
00132 private:
00133    Teuchos::RCP<Teko::InverseFactory> invFactory_;
00134    ScalingType scalingType_;
00135    DiagonalType diagonalType_;
00136 };
00137 
00138 } // end namespace Teko
00139 
00140 #endif
 All Classes Files Functions Variables