Thyra Version of the Day
Thyra_LinearOpWithSolveBase_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_LINEAR_OP_WITH_SOLVE_BASE_DEF_HPP
00043 #define THYRA_LINEAR_OP_WITH_SOLVE_BASE_DEF_HPP
00044 
00045 #include "Thyra_LinearOpWithSolveBase_decl.hpp"
00046 
00047 
00048 namespace Thyra {
00049 
00050 
00051 // Deprecated
00052 
00053 
00054 template<class Scalar>
00055 bool LinearOpWithSolveBase<Scalar>::solveSupportsConj(EConj conj) const
00056 {
00057   return solveSupports(applyConjToTrans(conj));
00058 }
00059 
00060 
00061 template<class Scalar>
00062 bool LinearOpWithSolveBase<Scalar>::solveSupportsSolveMeasureType(
00063   EConj conj, const SolveMeasureType& solveMeasureType) const
00064 {
00065   return solveSupportsSolveMeasureType(applyConjToTrans(conj), solveMeasureType);
00066 }
00067 
00068 
00069 template<class Scalar>
00070 void LinearOpWithSolveBase<Scalar>::solve(
00071   const EConj conj,
00072   const MultiVectorBase<Scalar> &B,
00073   MultiVectorBase<Scalar> *X,
00074   const int numBlocks,
00075   const BlockSolveCriteria<Scalar> blockSolveCriteria[],
00076   SolveStatus<Scalar> blockSolveStatus[]
00077   ) const
00078 {
00079   const SolveStatus<Scalar> solveStatus =
00080     this->solve(applyConjToTrans(conj), B, Teuchos::ptr(X),
00081       convertBlockSolveCriteriaToSolveCritiera(numBlocks, blockSolveCriteria)
00082       );
00083   if (numBlocks) {
00084     blockSolveStatus[0] = solveStatus;
00085   }
00086 }
00087 
00088 
00089 template<class Scalar>
00090 bool LinearOpWithSolveBase<Scalar>::solveTransposeSupportsConj(EConj conj) const
00091 {
00092   return solveSupports(applyTransposeConjToTrans(conj));
00093 }
00094 
00095 
00096 template<class Scalar>
00097 bool LinearOpWithSolveBase<Scalar>::solveTransposeSupportsSolveMeasureType(
00098   EConj conj, const SolveMeasureType& solveMeasureType) const
00099 {
00100   return solveSupportsSolveMeasureType(applyTransposeConjToTrans(conj),
00101     solveMeasureType);
00102 }
00103 
00104 
00105 template<class Scalar>
00106 void LinearOpWithSolveBase<Scalar>::solveTranspose(
00107   const EConj conj,
00108   const MultiVectorBase<Scalar> &B,
00109   MultiVectorBase<Scalar> *X,
00110   const int numBlocks,
00111   const BlockSolveCriteria<Scalar> blockSolveCriteria[],
00112   SolveStatus<Scalar> blockSolveStatus[]
00113   ) const
00114 {
00115   const SolveStatus<Scalar> solveStatus =
00116     this->solve(applyTransposeConjToTrans(conj), B, Teuchos::ptr(X),
00117       convertBlockSolveCriteriaToSolveCritiera(numBlocks, blockSolveCriteria)
00118       );
00119   if (numBlocks) {
00120     blockSolveStatus[0] = solveStatus;
00121   }
00122 }
00123 
00124 
00125 // Protected virtual functions to be overridden by subclasses
00126 
00127 
00128 template<class Scalar>
00129 bool
00130 LinearOpWithSolveBase<Scalar>::solveSupportsImpl(
00131   EOpTransp transp) const
00132 {
00133   return (transp == NOTRANS);
00134 }
00135 
00136 
00137 template<class Scalar>
00138 bool
00139 LinearOpWithSolveBase<Scalar>::solveSupportsSolveMeasureTypeImpl(
00140   EOpTransp transp, const SolveMeasureType& solveMeasureType) const
00141 {
00142   return (solveSupports(transp) && solveMeasureType.useDefault());
00143 }
00144 
00145 
00146 // private:
00147 
00148 
00149 template<class Scalar>
00150 Ptr<const SolveCriteria<Scalar> >
00151 LinearOpWithSolveBase<Scalar>::convertBlockSolveCriteriaToSolveCritiera(
00152   const int numBlocks,
00153   const BlockSolveCriteria<Scalar> blockSolveCriteria[]
00154   )
00155 {
00156   TEUCHOS_ASSERT(numBlocks == 0 || numBlocks == 1);
00157   if (numBlocks == 1)
00158     return Teuchos::ptrFromRef(blockSolveCriteria[0].solveCriteria);
00159   return Teuchos::null;
00160 }
00161 
00162 
00163 } // namespace Thyra
00164 
00165 
00166 #endif // THYRA_LINEAR_OP_WITH_SOLVE_BASE_DEF_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines