/usr/include/trilinos/Thyra_DefaultInverseLinearOp_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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | // @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_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP
#define THYRA_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP
#include "Thyra_InverseLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"
namespace Thyra {
/** \brief Determines what to do if inverse solve fails.
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
enum EThrowOnSolveFailure {
THROW_ON_SOLVE_FAILURE=1, ///< Throw an exception if a solve fails to converge
IGNORE_SOLVE_FAILURE=0 ///< Don't throw an exception if a solve fails to converge
};
/** \brief Concrete <tt>LinearOpBase</tt> subclass that creates an implicit
* <tt>LinearOpBase</tt> object using the inverse action of a
* <tt>LinearOpWithSolveBase</tt> object.
*
* This class represents an implicit inverse linear operator:
\verbatim
M = inv(A)
\endverbatim
* where <tt>A</tt> is any <tt>LinearOpWithSolveBase</tt> object.
* Specifically, the <tt>solve(...)</tt> function <tt>A</tt> is used to
* implement <tt>this->apply()</tt> and the <tt>solveTranspose(...)</tt>
* function <tt>A</tt> is used to implement <tt>this->applyTranspose()</tt>.
*
* <tt>SolveCriteria</tt> objects can be associated with <tt>A</tt> to define
* the solve criterion for calling the <tt>A.solve(...,fwdSolveCriteria)</tt>
* and <tt>A.solveTranspose(...,adjSolveCriteria)</tt>.
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
class DefaultInverseLinearOp : virtual public InverseLinearOpBase<Scalar>
{
public:
/** @name Constructors/initializers/accessors */
//@{
/** \brief Constructs to uninitialized (see postconditions for
* <tt>uninitialize()</tt>).
*/
DefaultInverseLinearOp();
/** Calls <tt>initialize()</tt>.
*/
DefaultInverseLinearOp(
const RCP<LinearOpWithSolveBase<Scalar> > &lows,
const SolveCriteria<Scalar> *fwdSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
const SolveCriteria<Scalar> *adjSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
);
/** Calls <tt>initialize()</tt>.
*
* Rather than calling this constructor directly, consider using the non-member helper
* functions described \ref Thyra_Op_Vec_AddedLinearOp_helpers_grp "here".
*/
DefaultInverseLinearOp(
const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
const SolveCriteria<Scalar> *fwdSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
const SolveCriteria<Scalar> *adjSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
);
/** \brief Initialize given a non-const <tt>LinearOpWithSolveBase</tt>
* object and an optional <tt>.
*
* \param lows [in] The <tt>LinearOpWithSolveBase</tt> object that will
* <tt>solve(...)</tt> and/or <tt>solveTranspose(...)</tt> will be called
* on. Note that <tt>*this</tt> may give up non-const views of
* <tt>*lows</tt> so that <tt>*lows</tt> may be changed through clients of
* this object.
*
* \param fwdSolveCriteria [in] The criteria used to call
* <tt>lows->solve(...)</tt>. If <tt>fwdSolveCriteria==NULL</tt> then the
* default solve criteria built into <tt>*lows<tt> will be used. If
* <tt>fwdSolveCriteria!=NULL</tt> then <tt>*fwdSolveCriteria</tt> will be
* copied internally. <b>Warning!</b> If shallow copy is used by any
* parameters in <tt>fwdSolveCriteria->extraParameter</tt> these these
* parameters will be "remembered" by <tt>*this</tt>.
*
* \param adjSolveCriteria [in] The criteria used to call
* <tt>lows->solveTranspose(...)</tt>. If <tt>adjSolveCriteria==NULL</tt>
* then the default solve criteria built into <tt>*lows<tt> will be used.
* If <tt>adjSolveCriteria!=NULL</tt> then <tt>*adjSolveCriteria</tt> will
* be copied internally. <b>Warning!</b> If shallow copy is used by any
* parameters in <tt>adjSolveCriteria->extraParameter</tt> these these
* parameters will be "remembered" by <tt>*this</tt>.
*
* <b>Preconditions:</b><ul>
* <li><tt>lows.get() != NULL</tt>
* </ul>
*
* <b>Postconditions:</b><ul>
* <li><tt>this->domain().get() == lows->range().get()</tt>
* <li><tt>this->range().get() == lows->domain().get()</tt>
* </ul>
*/
void initialize(
const RCP<LinearOpWithSolveBase<Scalar> > &lows,
const SolveCriteria<Scalar> *fwdSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
const SolveCriteria<Scalar> *adjSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
);
/** \brief Initialize given a non-const <tt>LinearOpWithSolveBase</tt>
* object and an optional <tt>.
*
* \param lows [in] The <tt>LinearOpWithSolveBase</tt> object that will
* <tt>solve(...)</tt> and/or <tt>solveTranspose(...)</tt> will be called
* on. Note that <tt>*this</tt> may give up non-const views of
* <tt>*lows</tt> so that <tt>*lows</tt> may be changed through clients of
* this object.
*
* \param fwdSolveCriteria [in] The criteria used to call
* <tt>lows->solve(...)</tt>. If <tt>fwdSolveCriteria==NULL</tt> then the
* default solve criteria built into <tt>*lows<tt> will be used. If
* <tt>fwdSolveCriteria!=NULL</tt> then <tt>*fwdSolveCriteria</tt> will be
* copied internally. <b>Warning!</b> If shallow copy is used by any
* parameters in <tt>fwdSolveCriteria->extraParameter</tt> these these
* parameters will be "remembered" by <tt>*this</tt>.
*
* \param adjSolveCriteria [in] The criteria used to call
* <tt>lows->solveTranspose(...)</tt>. If <tt>adjSolveCriteria==NULL</tt>
* then the default solve criteria built into <tt>*lows<tt> will be used.
* If <tt>adjSolveCriteria!=NULL</tt> then <tt>*adjSolveCriteria</tt> will
* be copied internally. <b>Warning!</b> If shallow copy is used by any
* parameters in <tt>adjSolveCriteria->extraParameter</tt> these these
* parameters will be "remembered" by <tt>*this</tt>.
*
* <b>Preconditions:</b><ul>
* <li><tt>lows.get() != NULL</tt>
* </ul>
*
* <b>Postconditions:</b><ul>
* <li><tt>this->domain().get() == lows->range().get()</tt>
* <li><tt>this->range().get() == lows->domain().get()</tt>
* </ul>
*/
void initialize(
const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
const SolveCriteria<Scalar> *fwdSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnFwdSolveFailure = THROW_ON_SOLVE_FAILURE,
const SolveCriteria<Scalar> *adjSolveCriteria = NULL,
const EThrowOnSolveFailure throwOnAdjSolveFailure = THROW_ON_SOLVE_FAILURE
);
/** \brief Set to uninitialized.
*
* <b>Postconditions:</b><ul>
* <li><tt>this->getLows().get()==NULL</tt>
* <li><tt>this->range().get()==NULL</tt>
* <li><tt>this->domain().get()==NULL</tt>
* </ul>
*/
void uninitialize();
//@}
/** @name Overridden from InverseLinearOpBase */
//@{
/** \brief . */
bool isLowsConst() const;
/** \brief . */
RCP<LinearOpWithSolveBase<Scalar> >
getNonconstLows();
/** \brief . */
RCP<const LinearOpWithSolveBase<Scalar> >
getLows() const;
//@}
/** @name Overridden from LinearOpBase */
//@{
/** \brief Returns <tt>this->getLows()->domain() if
* <t>this->getLows().get()!=NULL</tt> and returns <tt>Teuchos::null</tt>
* otherwise.
*/
RCP< const VectorSpaceBase<Scalar> > range() const;
/** \brief Returns <tt>this->getLows()->range() if
* <t>this->getLows().get()!=NULL</tt> and returns <tt>Teuchos::null</tt>
* otherwise.
*/
RCP< const VectorSpaceBase<Scalar> > domain() const;
/** \brief . */
RCP<const LinearOpBase<Scalar> > clone() const;
//@}
/** @name Overridden from Teuchos::Describable */
//@{
/** \brief . */
std::string description() const;
/** \brief . */
void describe(
FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel
) const;
//@}
protected:
/** @name Overridden from LinearOpBase */
//@{
/** \brief Returns <tt>true</tt> only if all constituent operators support
* <tt>M_trans</tt>.
*/
bool opSupportedImpl(EOpTransp M_trans) const;
/** \brief . */
void applyImpl(
const EOpTransp M_trans,
const MultiVectorBase<Scalar> &X,
const Ptr<MultiVectorBase<Scalar> > &Y,
const Scalar alpha,
const Scalar beta
) const;
//@}
private:
Teuchos::ConstNonconstObjectContainer<LinearOpWithSolveBase<Scalar> > lows_;
RCP<SolveCriteria<Scalar> > fwdSolveCriteria_;
EThrowOnSolveFailure throwOnFwdSolveFailure_;
RCP<SolveCriteria<Scalar> > adjSolveCriteria_;
EThrowOnSolveFailure throwOnAdjSolveFailure_;
void assertInitialized() const;
template<class LOWS>
void initializeImpl(
const RCP<LOWS> &lows,
const SolveCriteria<Scalar> *fwdSolveCriteria,
const EThrowOnSolveFailure throwOnFwdSolveFailure,
const SolveCriteria<Scalar> *adjSolveCriteria,
const EThrowOnSolveFailure throwOnAdjSolveFailure
);
// Not defined and not to be called
DefaultInverseLinearOp(const DefaultInverseLinearOp&);
DefaultInverseLinearOp& operator=(const DefaultInverseLinearOp&);
};
/** \brief Form a non-const implicit inverse operator <tt>M = inv(A)</tt>.
*
* \relates DefaultInverseLinearOp
*/
template<class Scalar>
RCP<LinearOpBase<Scalar> >
nonconstInverse(
const RCP<LinearOpWithSolveBase<Scalar> > &A,
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
);
/** \brief Form a const implicit inverse operator <tt>M = inv(A)</tt>.
*
* \relates DefaultInverseLinearOp
*/
template<class Scalar>
RCP<LinearOpBase<Scalar> >
inverse(
const RCP<const LinearOpWithSolveBase<Scalar> > &A,
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
);
// /////////////////////////////////
// Inline members
template<class Scalar>
inline
void DefaultInverseLinearOp<Scalar>::assertInitialized() const
{
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT( !lows_.getConstObj().get() );
#endif
}
} // end namespace Thyra
#endif // THYRA_DEFAULT_INVERSE_LINEAR_OP_DECL_HPP
|