Teko Version of the Day
Teko_DiagonallyScaledPreconditionerFactory.cpp
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 // Teko includes
00048 #include "Teko_DiagonallyScaledPreconditionerFactory.hpp"
00049 
00050 #include "Teko_PreconditionerInverseFactory.hpp"
00051 
00052 namespace Teko {
00053 
00055 DiagonallyScaledPreconditionerFactory::DiagonallyScaledPreconditionerFactory()
00056    : invFactory_(Teuchos::null), scalingType_(ROW_SCALING), diagonalType_(AbsRowSum)
00057 { }
00058 
00062 DiagonallyScaledPreconditionerFactory::DiagonallyScaledPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory,
00063                                                                              ScalingType scalingType,DiagonalType diagonalType)
00064    : invFactory_(invFactory), scalingType_(scalingType), diagonalType_(diagonalType)
00065 { 
00066 }
00067 
00068 DiagonallyScaledPreconditionerFactory::~DiagonallyScaledPreconditionerFactory()
00069 { 
00070 }
00071 
00075 LinearOp DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const
00076 {
00077    using Teuchos::RCP;
00078    using Teuchos::rcp_dynamic_cast;
00079    Teko_DEBUG_SCOPE("DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator",10);
00080 
00081    TEUCHOS_TEST_FOR_EXCEPTION(invFactory_==Teuchos::null,std::runtime_error,
00082                       "ERROR: Teko::DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator requires that an "
00083                    << "inverse factory has been set. Currently it is null!");
00084 
00085    // get diagonal matrix
00086    LinearOp invD = getInvDiagonalOp(lo,diagonalType_);
00087 
00088    // M = A * invD
00089    ModifiableLinearOp & M = state.getModifiableOp("op_M");
00090    if(scalingType_==COLUMN_SCALING)
00091       M = explicitMultiply(lo,invD,M);
00092    else
00093       M = explicitMultiply(invD,lo,M);
00094 
00095    // build inverse operator
00096    ModifiableLinearOp & invM = state.getModifiableOp("op_invM");
00097    if(invM==Teuchos::null)
00098       invM = buildInverse(*invFactory_,M);
00099    else
00100       rebuildInverse(*invFactory_,M,invM);
00101 
00102    // return invD * invM
00103    if(scalingType_==COLUMN_SCALING)
00104       return multiply(invD,invM.getConst());
00105    else
00106       return multiply(invM.getConst(),invD);
00107 }
00108 
00112 void DiagonallyScaledPreconditionerFactory::initializeFromParameterList(const Teuchos::ParameterList & settings)
00113 {
00114    TEUCHOS_TEST_FOR_EXCEPTION(not settings.isParameter("Inverse Factory"),std::runtime_error,
00115                       "Parameter \"Inverse Factory\" is required by a Teko::DiagonallyScaledPreconditionerFactory");
00116       
00117    // grab library and preconditioner name
00118    std::string invName = settings.get<std::string>("Inverse Factory");
00119 
00120    // build preconditioner factory
00121    Teuchos::RCP<const InverseLibrary> il = getInverseLibrary();
00122    invFactory_ = il->getInverseFactory(invName);
00123    TEUCHOS_TEST_FOR_EXCEPTION(invFactory_==Teuchos::null,std::runtime_error,
00124                       "ERROR: \"Inverse Factory\" = " << invName
00125                    << " could not be found");
00126    
00127    // get scaling type specified by XML file
00128    const std::string defaultScaleType = "Row";
00129    const std::string scalingTypeString = "Scaling Type";
00130    std::string scaleType = defaultScaleType;
00131    if(settings.isParameter(scalingTypeString))
00132       scaleType = settings.get<std::string>(scalingTypeString);
00133 
00134    if(defaultScaleType==scaleType)
00135       scalingType_ = ROW_SCALING;
00136    else
00137       scalingType_ = COLUMN_SCALING;
00138 
00139    if(settings.isParameter("Diagonal Type"))
00140       diagonalType_ = Teko::getDiagonalType(settings.get<std::string>("Diagonal Type"));
00141 }
00142 
00143 } // end namespace Teko
 All Classes Files Functions Variables