Thyra Version of the Day
Thyra_DefaultDiagonalLinearOpWithSolve_def.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_DIAGONAL_LINEAR_OP_WITH_SOLVE_HPP
00043 #define THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_HPP
00044 
00045 #include "Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp"
00046 #include "Thyra_DefaultDiagonalLinearOp.hpp"
00047 #include "Thyra_MultiVectorStdOps.hpp"
00048 #include "Thyra_VectorBase.hpp"
00049 #include "Thyra_TestingTools.hpp" // ToDo: I need to have a better way to get eps()!
00050 #include "Teuchos_Assert.hpp"
00051 
00052 
00053 namespace Thyra {
00054 
00055 
00056 // Constructors/initializers/accessors
00057 
00058 
00059 template<class Scalar>
00060 DefaultDiagonalLinearOpWithSolve<Scalar>::DefaultDiagonalLinearOpWithSolve()
00061 {}
00062 
00063 
00064 template<class Scalar>
00065 DefaultDiagonalLinearOpWithSolve<Scalar>::DefaultDiagonalLinearOpWithSolve(
00066   const RCP<const VectorBase<Scalar> >   &diag
00067   )
00068 {
00069   this->initialize(diag);
00070 }
00071 
00072 
00073 // protected
00074 
00075 
00076 // Overridden from LinearOpWithSolveBase
00077 
00078 
00079 template<class Scalar>
00080 bool
00081 DefaultDiagonalLinearOpWithSolve<Scalar>::solveSupportsImpl(
00082   EOpTransp M_trans) const
00083 {
00084   typedef Teuchos::ScalarTraits<Scalar> ST;
00085   return (ST::isComplex ? M_trans==NOTRANS || M_trans==TRANS : true);
00086 }
00087 
00088 
00089 template<class Scalar>
00090 bool
00091 DefaultDiagonalLinearOpWithSolve<Scalar>::solveSupportsSolveMeasureTypeImpl(
00092   EOpTransp M_trans, const SolveMeasureType& solveMeasureType) const
00093 {
00094   return this->solveSupportsImpl(M_trans); // I am a direct solver!
00095 }
00096 
00097 
00098 template<class Scalar>
00099 SolveStatus<Scalar>
00100 DefaultDiagonalLinearOpWithSolve<Scalar>::solveImpl(
00101   const EOpTransp transp,
00102   const MultiVectorBase<Scalar> &B,
00103   const Ptr<MultiVectorBase<Scalar> > &X,
00104   const Ptr<const SolveCriteria<Scalar> > solveCriteria
00105   ) const
00106 {
00107 
00108 #ifdef THYRA_DEBUG
00109   TEUCHOS_ASSERT(this->solveSupportsImpl(transp));
00110 #endif
00111 
00112   typedef Teuchos::ScalarTraits<Scalar> ST;
00113 
00114   assign(X, ST::zero());
00115   
00116   const Ordinal numCols = B.domain()->dim();
00117   SolveStatus<Scalar> overallSolveStatus;
00118 
00119   for (Ordinal col_j = 0; col_j < numCols; ++col_j) {
00120 
00121     const RCP<const VectorBase<Scalar> > b = B.col(col_j);
00122     const RCP<VectorBase<Scalar> > x = X->col(col_j);
00123 
00124     ele_wise_divide( ST::one(), *b, *this->getDiag(), x.ptr() );
00125 
00126   }
00127 
00128   SolveStatus<Scalar> solveStatus;
00129   solveStatus.solveStatus =
00130     (nonnull(solveCriteria) && !solveCriteria->solveMeasureType.useDefault()
00131       ? SOLVE_STATUS_CONVERGED : SOLVE_STATUS_UNKNOWN );
00132   solveStatus.achievedTol = SolveStatus<Scalar>::unknownTolerance();
00133   return solveStatus;
00134 
00135 }
00136 
00137 
00138 } // end namespace Thyra
00139 
00140 
00141 #endif  // THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines