/usr/include/trilinos/Thyra_DelayedLinearOpWithSolve_decl.hpp is in libtrilinos-thyra-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_DECL_HPP
#define THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_DECL_HPP
#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
namespace Thyra {
/** \brief Delayed linear solver construction LinearOpWithSolveBase decorator
* class.
*
* This simple class takes a LinearOpWithSolveFactoryBase object and the
* arguments for a call to LinearOpWithSolveBase::initializeOp() (or one of
* its related functions) and then waits until a solve is called before it
* constructs the preconditioner.
*
* This class should never be created directly by a client. Instead, it
* should be created by a DelayedLinearOpWithSolveFactory object.
*/
template <class Scalar>
class DelayedLinearOpWithSolve : virtual public LinearOpWithSolveBase<Scalar>
{
public:
/** \name Constructor/Initializers */
//@{
/** \brief . */
DelayedLinearOpWithSolve();
/** \brief . */
void initialize(
const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
const RCP<const PreconditionerBase<Scalar> > &prec,
const RCP<const LinearOpSourceBase<Scalar> > &approxFwdOpSrc,
const ESupportSolveUse supportSolveUse,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &lowsf
);
/** \brief . */
RCP<const LinearOpSourceBase<Scalar> > getFwdOpSrc() const;
/** \brief . */
RCP<const PreconditionerBase<Scalar> > getPrec() const;
/** \brief . */
RCP<const LinearOpSourceBase<Scalar> > getApproxFwdOpSrc() const;
/** \brief . */
ESupportSolveUse getSupportSolveUse() const;
//@}
/** \name Overridden from Teuchos::Describable. */
//@{
/** \brief . */
std::string description() const;
//@}
/** @name Overridden from LinearOpBase */
//@{
/** \brief . */
RCP< const VectorSpaceBase<Scalar> > range() const;
/** \brief . */
RCP< const VectorSpaceBase<Scalar> > domain() const;
/** \brief . */
RCP<const LinearOpBase<Scalar> > clone() const;
//@}
protected:
/** \brief Overridden from Teuchos::VerboseObjectBase */
//@{
/** \brief . */
void informUpdatedVerbosityState() const;
//@}
/** @name Overridden from LinearOpBase */
//@{
/** \brief . */
virtual bool opSupportedImpl(EOpTransp M_trans) const;
/** \brief . */
virtual void applyImpl(
const EOpTransp M_trans,
const MultiVectorBase<Scalar> &X,
const Ptr<MultiVectorBase<Scalar> > &Y,
const Scalar alpha,
const Scalar beta
) const;
//@}
/** @name Overridden from LinearOpWithSolveBase. */
//@{
/** \brief . */
virtual bool solveSupportsImpl(EOpTransp M_trans) const;
/** \brief . */
virtual bool solveSupportsSolveMeasureTypeImpl(
EOpTransp M_trans, const SolveMeasureType& solveMeasureType
) const;
/** \brief . */
SolveStatus<Scalar> solveImpl(
const EOpTransp transp,
const MultiVectorBase<Scalar> &B,
const Ptr<MultiVectorBase<Scalar> > &X,
const Ptr<const SolveCriteria<Scalar> > solveCriteria
) const;
//@}
private:
// //////////////////////
// Private data members
RCP<const LinearOpSourceBase<Scalar> > fwdOpSrc_;
RCP<const PreconditionerBase<Scalar> > prec_;
RCP<const LinearOpSourceBase<Scalar> > approxFwdOpSrc_;
ESupportSolveUse supportSolveUse_;
RCP<LinearOpWithSolveFactoryBase<Scalar> > lowsf_;
RCP<const LinearOpBase<Scalar> > fwdOp_;
mutable bool lows_is_valid_;
mutable RCP<LinearOpWithSolveBase<Scalar> > lows_;
// ///////////////////////////
// Private member functions
void updateSolver() const;
};
/** \brief Nonmember constuctor.
*
* \relates DelayedLinearOpWithSolve
*/
template <class Scalar>
RCP<DelayedLinearOpWithSolve<Scalar> > delayedLinearOpWithSolve()
{
return Teuchos::rcp(new DelayedLinearOpWithSolve<Scalar>());
}
/** \brief Nonmember constuctor.
*
* \relates DelayedLinearOpWithSolve
*/
template <class Scalar>
RCP<DelayedLinearOpWithSolve<Scalar> >
delayedLinearOpWithSolve(
const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &lowsf
)
{
using Teuchos::null;
const RCP<DelayedLinearOpWithSolve<Scalar> > dlows =
delayedLinearOpWithSolve<Scalar>();
dlows->initialize(fwdOpSrc, null, null, SUPPORT_SOLVE_UNSPECIFIED, lowsf);
return dlows;
}
} // namespace Thyra
#endif // THYRA_DELAYED_LINEAR_OP_WITH_SOLVE_DECL_HPP
|