Teko Version of the Day
Teko_LSCPreconditionerFactory.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_LSCPreconditionerFactory_hpp__
00048 #define __Teko_LSCPreconditionerFactory_hpp__
00049 
00050 #include "Teko_BlockPreconditionerFactory.hpp"
00051 #include "Teko_LSCStrategy.hpp"
00052 
00053 namespace Teko {
00054 namespace NS { // Navier-Stokes specialization
00055 
00064 class LSCPrecondState : public BlockPreconditionerState {
00065 public:
00066    LSCPrecondState() {}
00067 
00069    LinearOp invMass_;
00070 
00073    ModifiableLinearOp BQBt_;
00074 
00077    ModifiableLinearOp BHBt_;
00078 
00081    LinearOp BQBtmC_;
00082    InverseLinearOp invBQBtmC_;
00083 
00086    LinearOp BHBtmC_;
00087    InverseLinearOp invBHBtmC_;
00088 
00090    LinearOp aiD_;
00091 
00093    double gamma_;
00094 
00098    double alpha_;
00099 };
00100 
00101 class LSCPreconditionerFactory 
00102    : public BlockPreconditionerFactory {
00103 public:
00105 
00106 
00108    LSCPreconditionerFactory(const LinearOp & invF,const LinearOp & invBQBtmC,
00109                             const LinearOp & invD,const LinearOp & invMass);
00110  
00112    LSCPreconditionerFactory(const LinearOp & invF,
00113                             const LinearOp & invBQBtmC,
00114                             const LinearOp & invMass);
00115 
00117    LSCPreconditionerFactory(const Teuchos::RCP<LSCStrategy> & strategy);
00118 
00120    LSCPreconditionerFactory();
00122 
00124    virtual LinearOp buildPreconditionerOperator(BlockedLinearOp & blo,BlockPreconditionerState & state) const;
00125 
00127    virtual RCP<PreconditionerState> buildPreconditionerState() const
00128    { return rcp(new LSCPrecondState()); }
00129 
00131    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
00132 
00134    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
00135 
00136 protected:
00137    // Gimmie object
00138    Teuchos::RCP<LSCStrategy> invOpsStrategy_;
00139    bool isSymmetric_;
00140 
00142    virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
00143 
00144 public:
00157    static RCP<LSCStrategy> 
00158    buildStrategy(const std::string & name, 
00159                  const Teuchos::ParameterList & settings,
00160                  const RCP<const InverseLibrary> & invLib,
00161                  const RCP<RequestHandler> & rh);
00162 
00176    static void addStrategy(const std::string & name,const RCP<Cloneable> & clone);
00177 
00178 private:
00180    static CloneFactory<LSCStrategy> strategyBuilder_;
00181 
00183    static void initializeStrategyBuilder();
00184 };
00185 
00186 } // end namespace NS
00187 } // end namespace Teko
00188 
00189 #endif
 All Classes Files Functions Variables