/usr/include/trilinos/Thyra_LinearOpWithSolveFactoryHelpers.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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | // @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_LINEAR_OP_WITH_SOLVE_FACTORY_HELPERS_HPP
#define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_HELPERS_HPP
#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Thyra_DefaultLinearOpSource.hpp"
#include "Thyra_DefaultPreconditioner.hpp"
#include "Thyra_DefaultInverseLinearOp.hpp"
namespace Thyra {
/** \brief Return if the forward operator is a compatible source for a LOWSFB
* object.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
bool isCompatible(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const LinearOpBase<Scalar> &fwdOp
)
{
return lowsFactory.isCompatible(*defaultLinearOpSource(fwdOp));
}
/** \brief Set default label on a LOWSB object.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void setDefaultObjectLabel(
const LinearOpBase<Scalar> &fwdOp,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op
)
{
const std::string OpLabel = Op->getObjectLabel();
const std::string fwdOpLabel = fwdOp.getObjectLabel();
if ( !OpLabel.length() && fwdOpLabel.length() )
Op->setObjectLabel(fwdOpLabel);
}
/** \brief Initialize a pre-created LOWSB object given a forward operator.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void initializeOp(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
)
{
lowsFactory.initializeOp(defaultLinearOpSource(fwdOp), &*Op, supportSolveUse);
setDefaultObjectLabel(*fwdOp, Op);
}
/** \brief Reinitialize a pre-created LOWSB object given a forward operator,
* reusing a much as possible from the prior LOWSB object.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void initializeAndReuseOp(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op
)
{
lowsFactory.initializeAndReuseOp(defaultLinearOpSource(fwdOp), &*Op);
setDefaultObjectLabel(*fwdOp, Op);
}
/** \brief Initialize a preconditioned LOWSB object given an external
* preconditioner.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void initializePreconditionedOp(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const RCP<const PreconditionerBase<Scalar> > &prec,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
)
{
lowsFactory.initializePreconditionedOp(defaultLinearOpSource(fwdOp),
prec, &*Op, supportSolveUse);
setDefaultObjectLabel(*fwdOp ,Op);
}
/** \brief Initialize a preconditioned LOWSB object given an external operator
* to be used to generate the preconditioner internally.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void initializeApproxPreconditionedOp(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const RCP<const LinearOpBase<Scalar> > &approxFwdOp,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
)
{
lowsFactory.initializeApproxPreconditionedOp(defaultLinearOpSource(fwdOp),
defaultLinearOpSource(approxFwdOp), &*Op, supportSolveUse);
setDefaultObjectLabel(*fwdOp,Op);
}
/** \brief Create and initialize a <tt>LinearOpWithSolveBase</tt> object from
* a <tt>LinearOpBase</tt> object using a
* <tt>LinearOpWithSolveFactoryBase</tt> strategy object.
* \relates LinearOpWithSolveFactoryBase */
template<class Scalar>
RCP<LinearOpWithSolveBase<Scalar> >
linearOpWithSolve(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
)
{
RCP<LinearOpWithSolveBase<Scalar> > Op = lowsFactory.createOp();
Thyra::initializeOp<Scalar>( lowsFactory, fwdOp, Op.ptr(), supportSolveUse);
return Op;
}
/** \brief Form a const implicit inverse operator <tt>M = inv(A)</tt> given a
* factory.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
RCP<LinearOpBase<Scalar> >
inverse(
const LinearOpWithSolveFactoryBase<Scalar> &LOWSF,
const RCP<const LinearOpBase<Scalar> > &fwdOp,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED,
const Ptr<const SolveCriteria<Scalar> > &fwdSolveCriteria = Teuchos::null,
const EThrowOnSolveFailure throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
const Ptr<const SolveCriteria<Scalar> > &adjSolveCriteria = Teuchos::null,
const EThrowOnSolveFailure throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
)
{
return inverse<Scalar>(linearOpWithSolve<Scalar>(LOWSF, fwdOp, supportSolveUse),
fwdSolveCriteria, throwOnFwdSolveFailure, adjSolveCriteria, throwOnAdjSolveFailure);
}
/** \brief Uninitialized a pre-created LOWSB object, returning input objects
* used to initialize it.
*
* \relates LinearOpWithSolveFactoryBase
*/
template<class Scalar>
void uninitializeOp(
const LinearOpWithSolveFactoryBase<Scalar> &lowsFactory,
const Ptr<LinearOpWithSolveBase<Scalar> > &Op,
const Ptr<RCP<const LinearOpBase<Scalar> > > &fwdOp = Teuchos::null,
const Ptr<RCP<const PreconditionerBase<Scalar> > > &prec = Teuchos::null,
const Ptr<RCP<const LinearOpBase<Scalar> > > &approxFwdOp = Teuchos::null,
const Ptr<ESupportSolveUse> &supportSolveUse = Teuchos::null
)
{
RCP<const LinearOpSourceBase<Scalar> > fwdOpSrc;
RCP<const LinearOpSourceBase<Scalar> > approxFwdOpSrc;
lowsFactory.uninitializeOp(Op.get(), &fwdOpSrc, prec.get(), &approxFwdOpSrc,
supportSolveUse.get());
if (nonnull(fwdOp)) {
*fwdOp = ( nonnull(fwdOpSrc) ? fwdOpSrc->getOp() : Teuchos::null );
}
if (nonnull(approxFwdOp)) {
*approxFwdOp = ( nonnull(approxFwdOpSrc) ? approxFwdOpSrc->getOp() : Teuchos::null );
}
}
} // namespace Thyra
#endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_HELPERS_HPP
|