Teko Version of the Day
Teko_PreconditionerState.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_PreconditionerState_hpp__
00048 #define __Teko_PreconditionerState_hpp__
00049 
00050 #include "Teuchos_ParameterListAcceptor.hpp"
00051 
00052 // Thyra includes
00053 // #include "Thyra_SolveSupportTypes.hpp"
00054 
00055 // Teko includes
00056 #include "Teko_Utilities.hpp"
00057 
00058 namespace Teko {
00059 
00071 class PreconditionerState : public Teuchos::ParameterListAcceptor {
00072 public:
00074 
00075    PreconditionerState() : isInitialized_(false) {}
00076    PreconditionerState(const PreconditionerState & src) 
00077       : paramList_(Teuchos::rcp(new Teuchos::ParameterList(*src.paramList_))), 
00078         srcVector_(src.srcVector_),
00079         inverses_(src.inverses_),
00080         isInitialized_(src.isInitialized_) {}
00082 
00084 
00085 
00087    void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & paramList); 
00088 
00090    Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
00091 
00093    Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00094  
00096 
00100    virtual bool isInitialized() const
00101    { return isInitialized_; }
00102 
00105    virtual void setInitialized(bool init=true) 
00106    { isInitialized_ = init; }
00107 
00109    virtual void setSourceVector(const Teko::MultiVector & srcVec)
00110    { srcVector_ = srcVec; }
00111 
00113    virtual const Teko::MultiVector getSourceVector() const
00114    { return srcVector_; }
00115 
00117    virtual void addInverse(const std::string & name,const Teko::InverseLinearOp & ilo)
00118    { inverses_[name] = ilo; }
00119 
00121    virtual Teko::InverseLinearOp getInverse(const std::string & name) const
00122    { std::map<std::string,Teko::InverseLinearOp>::const_iterator itr;
00123      itr =  inverses_.find(name);
00124      if(itr==inverses_.end()) return Teuchos::null; 
00125      return itr->second; }
00126 
00128    virtual void addLinearOp(const std::string & name,const Teko::LinearOp & lo)
00129    { linearOps_[name] = lo; }
00130 
00132    virtual Teko::LinearOp getLinearOp(const std::string & name)
00133    { return linearOps_[name]; }
00134 
00136    virtual void addModifiableOp(const std::string & name,const Teko::ModifiableLinearOp & mlo)
00137    { modifiableOp_[name] = mlo; }
00138 
00140    virtual Teko::ModifiableLinearOp &
00141    getModifiableOp(const std::string & name)
00142    { std::map<std::string,Teko::ModifiableLinearOp>::iterator itr;
00143      itr =  modifiableOp_.find(name);
00144      if(itr==modifiableOp_.end())
00145         return modifiableOp_[name];
00146      return itr->second; }
00147 
00149    virtual void merge(const PreconditionerState & ps,int position=-1);
00150 
00152    unsigned int getTag() const;
00153 
00155    void setTag(unsigned int tag);
00156 
00157 protected:
00159    Teuchos::RCP<Teuchos::ParameterList>          paramList_;
00160 
00162    Teko::MultiVector srcVector_;
00163 
00165    std::map<std::string,Teko::InverseLinearOp> inverses_;
00166    std::map<std::string,Teko::ModifiableLinearOp> modifiableOp_;
00167    std::map<std::string,Teko::LinearOp> linearOps_;
00168 
00170    bool isInitialized_;
00171 
00172    unsigned int tag_;
00173 };
00174 
00175 } // end namespace Teko
00176 
00177 #endif
 All Classes Files Functions Variables