Thyra Version of the Day
Thyra_DelayedLinearOpWithSolveFactory_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
00043 #define THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
00044 
00045 
00046 #include "Thyra_LinearOpWithSolveFactoryBase.hpp"
00047 #include "Thyra_LinearOpSourceBase.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00061 template<class Scalar>
00062 class DelayedLinearOpWithSolveFactory
00063   : virtual public LinearOpWithSolveFactoryBase<Scalar>
00064 {
00065 public:
00066 
00069   
00071   DelayedLinearOpWithSolveFactory(
00072     const RCP<LinearOpWithSolveFactoryBase<Scalar> > &lowsf
00073     );
00074 
00076   RCP<LinearOpWithSolveFactoryBase<Scalar> > getUnderlyingLOWSF();
00077 
00079   RCP<const LinearOpWithSolveFactoryBase<Scalar> > getUnderlyingLOWSF() const;
00080 
00082 
00085 
00087   std::string description() const;
00088 
00090 
00093 
00095   void setParameterList(RCP<ParameterList> const& paramList);
00097   RCP<ParameterList> getNonconstParameterList();
00099   RCP<ParameterList> unsetParameterList();
00101   RCP<const ParameterList> getParameterList() const;
00103   RCP<const ParameterList> getValidParameters() const;
00104 
00106 
00109   
00111   virtual bool acceptsPreconditionerFactory() const;
00112 
00114   virtual void setPreconditionerFactory(
00115     const RCP<PreconditionerFactoryBase<Scalar> > &precFactory,
00116     const std::string &precFactoryName
00117     );
00118 
00120   virtual RCP<PreconditionerFactoryBase<Scalar> >
00121   getPreconditionerFactory() const;
00122 
00124   virtual void unsetPreconditionerFactory(
00125     RCP<PreconditionerFactoryBase<Scalar> > *precFactory,
00126     std::string *precFactoryName
00127     );
00128 
00130   virtual bool isCompatible(
00131     const LinearOpSourceBase<Scalar> &fwdOpSrc
00132     ) const;
00133 
00135   virtual RCP<LinearOpWithSolveBase<Scalar> > createOp() const;
00136 
00138   virtual void initializeOp(
00139     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00140     LinearOpWithSolveBase<Scalar> *Op,
00141     const ESupportSolveUse supportSolveUse
00142     ) const;
00143 
00145   virtual void initializeAndReuseOp(
00146     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00147     LinearOpWithSolveBase<Scalar> *Op
00148     ) const;
00149 
00151   virtual void uninitializeOp(
00152     LinearOpWithSolveBase<Scalar> *Op,
00153     RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc,
00154     RCP<const PreconditionerBase<Scalar> > *prec,
00155     RCP<const LinearOpSourceBase<Scalar> > *approxFwdOpSrc,
00156     ESupportSolveUse *supportSolveUse
00157     ) const;
00158  
00160   virtual bool supportsPreconditionerInputType(
00161     const EPreconditionerInputType precOpType
00162     ) const;
00163 
00165   virtual void initializePreconditionedOp(
00166     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00167     const RCP<const PreconditionerBase<Scalar> > &prec,
00168     LinearOpWithSolveBase<Scalar> *Op,
00169     const ESupportSolveUse supportSolveUse
00170     ) const;
00171 
00173   virtual void initializeApproxPreconditionedOp(
00174     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00175     const RCP<const LinearOpSourceBase<Scalar> > &approxFwdOpSrc,
00176     LinearOpWithSolveBase<Scalar> *Op,
00177     const ESupportSolveUse supportSolveUse
00178     ) const;
00179 
00181 
00182 protected:
00183 
00186 
00188   void informUpdatedVerbosityState() const;
00189 
00191 
00192 private:
00193 
00194   RCP<LinearOpWithSolveFactoryBase<Scalar> > lowsf_;
00195 
00196   // Not defined and not to be called
00197   DelayedLinearOpWithSolveFactory();
00198 
00199 };
00200 
00201 
00202 } // namespace Thyra
00203 
00204 
00205 #endif // THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines