Thyra Version of the Day
Thyra_DefaultSerialDenseLinearOpWithSolveFactory_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_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
00043 #define THYRA_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
00044 
00045 
00046 #include "Thyra_LinearOpWithSolveFactoryBase.hpp"
00047 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00059 template<class Scalar>
00060 class DefaultSerialDenseLinearOpWithSolveFactory
00061   : virtual public LinearOpWithSolveFactoryBase<Scalar>,
00062     virtual protected Teuchos::ParameterListAcceptorDefaultBase
00063 {
00064 public:
00065 
00068 
00070 
00073 
00075   void setParameterList(RCP<ParameterList> const& paramList);
00077   RCP<const ParameterList> getValidParameters() const;
00078 
00080 
00083   
00085   virtual bool acceptsPreconditionerFactory() const;
00086 
00088   virtual void setPreconditionerFactory(
00089     const RCP<PreconditionerFactoryBase<Scalar> > &precFactory,
00090     const std::string &precFactoryName
00091     );
00092 
00094   virtual RCP<PreconditionerFactoryBase<Scalar> >
00095   getPreconditionerFactory() const;
00096 
00098   virtual void unsetPreconditionerFactory(
00099     RCP<PreconditionerFactoryBase<Scalar> > *precFactory,
00100     std::string *precFactoryName
00101     );
00102 
00104   virtual bool isCompatible(
00105     const LinearOpSourceBase<Scalar> &fwdOpSrc
00106     ) const;
00107 
00109   virtual RCP<LinearOpWithSolveBase<Scalar> > createOp() const;
00110 
00112   virtual void initializeOp(
00113     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00114     LinearOpWithSolveBase<Scalar> *Op,
00115     const ESupportSolveUse supportSolveUse
00116     ) const;
00117 
00119   virtual void initializeAndReuseOp(
00120     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00121     LinearOpWithSolveBase<Scalar> *Op
00122     ) const;
00123 
00125   virtual void uninitializeOp(
00126     LinearOpWithSolveBase<Scalar> *Op,
00127     RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc,
00128     RCP<const PreconditionerBase<Scalar> > *prec,
00129     RCP<const LinearOpSourceBase<Scalar> > *approxFwdOpSrc,
00130     ESupportSolveUse *supportSolveUse
00131     ) const;
00132  
00134   virtual bool supportsPreconditionerInputType(
00135     const EPreconditionerInputType precOpType
00136     ) const;
00137 
00139   virtual void initializePreconditionedOp(
00140     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00141     const RCP<const PreconditionerBase<Scalar> > &prec,
00142     LinearOpWithSolveBase<Scalar> *Op,
00143     const ESupportSolveUse supportSolveUse
00144     ) const;
00145 
00147   virtual void initializeApproxPreconditionedOp(
00148     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00149     const RCP<const LinearOpSourceBase<Scalar> > &approxFwdOpSrc,
00150     LinearOpWithSolveBase<Scalar> *Op,
00151     const ESupportSolveUse supportSolveUse
00152     ) const;
00153 
00155 
00156 };
00157 
00158 
00163 template<class Scalar>
00164 RCP<DefaultSerialDenseLinearOpWithSolveFactory<Scalar> >
00165 defaultSerialDenseLinearOpWithSolveFactory()
00166 {
00167   return Teuchos::rcp(new DefaultSerialDenseLinearOpWithSolveFactory<Scalar>);
00168 }
00169 
00170 
00171 } // namespace Thyra
00172 
00173 
00174 #endif // THYRA_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines