Teko Version of the Day
Teko_AddPreconditionerFactory.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 #include "Teko_AddPreconditionerFactory.hpp"
00048 
00049 namespace Teko {
00050 
00051 using Teuchos::RCP;
00052 
00053 AddPreconditionerFactory::AddPreconditionerFactory(
00054                             const RCP<const BlockPreconditionerFactory> & FirstFactory,
00055                             const RCP<const BlockPreconditionerFactory> & SecondFactory)
00056    : FirstFactory_(FirstFactory), SecondFactory_(SecondFactory)
00057 {}
00058 
00059 AddPreconditionerFactory::AddPreconditionerFactory()
00060 {}
00061 
00063 RCP<PreconditionerState> AddPreconditionerFactory::buildPreconditionerState() const
00064 { 
00065    AddPrecondState*   mystate = new AddPrecondState(); 
00066    mystate->StateOne_ = Teuchos::rcp_dynamic_cast<BlockPreconditionerState>(FirstFactory_->buildPreconditionerState());
00067    mystate->StateTwo_ = Teuchos::rcp_dynamic_cast<BlockPreconditionerState>(SecondFactory_->buildPreconditionerState());
00068    return rcp(mystate);
00069 }
00070 
00071 // Use the factory to build the preconditioner (this is where the work goes)
00072 LinearOp AddPreconditionerFactory 
00073    ::buildPreconditionerOperator(BlockedLinearOp & blockOp,
00074                                  BlockPreconditionerState & state) const
00075 {
00076    // The main tricky thing here is that we have to take the 'state' object
00077    // associated with AddPreconditionerFactory(), pull out the states for
00078    // the individual preconditioners, and pass these on to 
00079    // buildPreconditionerOperator() for each subpreconditioner.
00080    
00081    AddPrecondState *MyState = dynamic_cast<AddPrecondState *> (&state);
00082    TEUCHOS_ASSERT(MyState != 0);
00083 
00084    LinearOp M1 = FirstFactory_->buildPreconditionerOperator(blockOp, *MyState->StateOne_);
00085    LinearOp M2 = SecondFactory_->buildPreconditionerOperator(blockOp, *MyState->StateTwo_);
00086 
00087    LinearOp invA = add(M1, M2);
00088 
00089    // return fully constructed preconditioner
00090    return invA;
00091 }
00092 
00094 void AddPreconditionerFactory::initializeFromParameterList(const Teuchos::ParameterList & pl)
00095 {
00096    RCP<const InverseLibrary> invLib = getInverseLibrary();
00097 
00098    // get string specifying inverse
00099    std::string aStr="", bStr="";
00100 
00101    // "parse" the parameter list
00102    aStr = pl.get<std::string>("Preconditioner A");
00103    bStr = pl.get<std::string>("Preconditioner B");
00104 
00105    RCP<const Teuchos::ParameterList> aSettings = invLib->getParameterList(aStr);
00106    RCP<const Teuchos::ParameterList> bSettings = invLib->getParameterList(bStr);
00107 
00108    // build preconditioner from the parameters
00109    std::string aType = aSettings->get<std::string>("Preconditioner Type");
00110    RCP<Teko::PreconditionerFactory> precA
00111          = Teko::PreconditionerFactory::buildPreconditionerFactory(aType,aSettings->sublist("Preconditioner Settings"),invLib);
00112 
00113    // build preconditioner from the parameters
00114    std::string bType = bSettings->get<std::string>("Preconditioner Type");
00115    RCP<Teko::PreconditionerFactory> precB
00116          = Teko::PreconditionerFactory::buildPreconditionerFactory(bType,bSettings->sublist("Preconditioner Settings"),invLib);
00117 
00118    // set preconditioners
00119    FirstFactory_ = Teuchos::rcp_dynamic_cast<const Teko::BlockPreconditionerFactory>(precA);
00120    SecondFactory_ = Teuchos::rcp_dynamic_cast<const Teko::BlockPreconditionerFactory>(precB);
00121 }
00122 
00123 } // end namespace Teko
 All Classes Files Functions Variables