/usr/include/trilinos/Thyra_PreconditionerFactoryBase_decl.hpp is in libtrilinos-thyra-dev 12.12.1-5.
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 | // @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_PRECONDITIONER_FACTORY_BASE_DECL_HPP
#define THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP
#include "Thyra_PreconditionerBase.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_VerboseObject.hpp"
namespace Thyra {
/** \brief Factory interface for creating preconditioner objects from
* <tt>LinearOpBase</tt> objects.
*
* \ingroup Thyra_Op_Solve_fundamental_interfaces_code_grp
*
* ToDo: Finish documentation!
*/
template<class Scalar>
class PreconditionerFactoryBase
: virtual public Teuchos::Describable,
virtual public Teuchos::ParameterListAcceptor,
virtual public Teuchos::VerboseObject<PreconditionerFactoryBase<Scalar> >
{
public:
/** @name Pure virtual public functions that must be overridden in subclasses */
//@{
/** \brief Check that a <tt>LinearOpBase</tt> object is compatible with
* <tt>*this</tt> factory object.
*/
virtual bool isCompatible(const LinearOpSourceBase<Scalar> &fwdOpSrc) const = 0;
/** \brief Create an (uninitialized) <tt>LinearOpBase</tt> object to be
* initalized as the preconditioner later in
* <tt>this->initializePrecOp()</tt>.
*
* Note that on output <tt>return->domain().get()==NULL</tt> may be true
* which means that the operator is not fully initialized. In fact, the
* output operator object is not guaranteed to be fully initialized until
* after it is passed through <tt>this->initializePrecOp()</tt>.
*/
virtual RCP<PreconditionerBase<Scalar> > createPrec() const = 0;
/** \brief Initialize a pre-created <tt>LinearOpBase</tt> preconditioner
* object given a "compatible" <tt>LinearOpBase</tt> object.
*
* \param fwdOpSrc [in] The forward linear operator that will be used to
* create the output <tt>LinearOpBase</tt> preconditioner object. Note that
* this object is remembered by the <tt>*Op</tt> object on output.
*
* \param prec [in/out] The output <tt>PreconditionerBase</tt>
* preconditioner object. This object must have be created first by
* <tt>this->createPrec()</tt>. The object may have also already been
* passed through this function several times. Note that subclasses should
* always first strip off the transpose and scaling by calling
* <tt>unwrap()</tt> before attempting to dynamic cast the object.
*
* \param supportSolveUse [in] Determines if <tt>apply()</tt> and/or
* <tt>applyTranspose()</tt> will be called on the initialized
* preconditioner operators. This allows <tt>*this</tt> factory object
* determine how to best initialize the <tt>*prec</tt> object. Default
* <tt>supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED</tt>
*
* <b>Preconditions:</b><ul>
*
* <li><tt>fwdOpSrc.get()!=NULL</tt>
*
* <li><tt>this->isCompatible(*fwdOpSrc)==true</tt>
*
* <li><tt>prec!=NULL</tt>
*
* <li><tt>*prec</tt> must have been created by <tt>this->createPrec()</tt>
* prior to calling this function.
*
* <li>[<tt>supportSolveUse==SUPPORT_SOLVE_FORWARD_ONLY<tt>]
* <tt>this->applySupportsConj(conj)==true</tt> for any value of
* <tt>conj</tt>
*
* <li>[<tt>supportSolveUse==SUPPORT_SOLVE_TRANSPOSE_ONLY<tt>]
* <tt>this->applyTransposeSupportsConj(conj)==true</tt> for any value of
* <tt>conj</tt>
*
* <li>[<tt>supportSolveUse==SUPPORT_SOLVE_FORWARD_AND_TRANSPOSE<tt>]
* <tt>this->applySupportsConj(conj)==true &&
* this->applyTransposeSupportsConj(conj)==true</tt> for any value of
* <tt>conj</tt>
*
* </ul>
*
* <b>Postconditions:</b><ul>
*
* <li>Throws <tt>CatastrophicSolveFailure</tt> if the preconditioner could
* not be created successfully (e.g. due to a factorization failure or some
* other cause).
*
* <li><tt>precOp->range()->isCompatible(*fwdOpSrc->domain())==true</tt>
*
* <li><tt>precOp->domain()->isCompatible(*fwdOpSrc->range())==true</tt>
*
* <li><t>precOp->applySupportsConj(conj)==this->applySupportsConj(conj)</tt>
*
* <li><t>precOp->applyTransposeSupportsConj(conj) ==
* this->applyTransposeSupportsConj(conj)</tt>
*
* <li><tt>fwdOpSrc.count()</tt> after output is greater than
* <tt>fwdOpSrc.count()</tt> just before this call and therefore the client
* can assume that the <tt>*fwdOpSrc</tt> object will be remembered by the
* <tt>*prec</tt> object. The client must be careful not to modify the
* <tt>*fwdOpSrc</tt> object or else the <tt>*precOp</tt> object may also be
* modified and become invalid.
*
* </ul>
*/
virtual void initializePrec(
const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
PreconditionerBase<Scalar> *precOp,
const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
) const = 0;
/** \brief Uninitialize a <tt>LinearOpBase</tt> preconditioner object and
* return its remembered forward linear operator.
*
* \param prec [in/out] On input, <tt>*precOp</tt> is an initialized or
* uninitialized object and on output is uninitialized. Note that
* "uninitialized" does not mean that <tt>precOp</tt> is completely
* stateless. It may still remember some aspect of the matrix
* <tt>fwdOpSrc</tt> that will allow for a more efficient initialization
* next time through <tt>this->initializePrecOp()</tt>.
*
* \param fwdOpSrc [in/out] If <tt>fwdOpSrc!=NULL</tt> on input, then on
* output this is set to same forward operator passed into
* <tt>this->initializePrecOp()</tt>.
*
* \param ESupportSolveUse [in/out] If <tt>precOpType!=NULL</tt> on input,
* then on output this is set to same option value passed to
* <tt>this->initializePrecOp()</tt>.
*
* <b>Preconditions:</b><ul>
*
* <li><tt>*precOp</tt> must have been created by
* <tt>this->createPrecOp()</tt> prior to calling this function.
*
* <li><tt>precOp</tt> may or may not have been passed through a call to
* <tt>this->initializePrecOp()</tt>.
*
* </ul>
*
* <b>Postconditions:</b><ul>
*
* <li>If <tt>*precOp</tt> on input was initialized through a call to
* <tt>this->initializePrecOp()</tt> then <tt>return.get()!=NULL</tt>.
*
* <li>If <tt>*precOp</tt> was uninitialized on input and
* <tt>fwdOpSrc!=NULL</tt> then <tt>fwdOpSrc->get()==NULL</tt> on output.
*
* <li>On output, <tt>*precOp</tt> can be considered to be uninitialized and
* it is safe to modify the forward operator object <tt>*(*fwdOpSrc)</tt>
* returned in <tt>fwdOpSrc</tt>. The default is <tt>fwdOpSrc==NULL</tt> in
* which case the forward operator will not be returned in
* <tt>*fwdOpSrc</tt>.
*
* </ul>
*
* This function should be called before the forward operator passed in to
* <tt>this->initializePrecOp()</tt> is modified. Otherwise, <tt>*this</tt>
* could be left in an inconsistent state. However, this is not required.
*/
virtual void uninitializePrec(
PreconditionerBase<Scalar> *prec,
RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc = NULL,
ESupportSolveUse *supportSolveUse = NULL
) const = 0;
//@}
/** @name Virtual public functions with default implementations */
//@{
/** \brief Return if <tt>precOp->apply()</tt> supports the argument
* <tt>conj</tt>.
*
* The default implementation returns <tt>true</tt> for real valued scalar
* types or when <tt>conj==NONCONJ_ELE</tt> for complex valued types.
*/
virtual bool applySupportsConj(EConj conj) const;
/** \brief Return if <tt>precOp->solveTranspose()</tt> supports the argument
* <tt>conj</tt>.
*
* The default implementation returns <tt>false</tt>.
*/
virtual bool applyTransposeSupportsConj(EConj conj) const;
//@}
private:
// Not defined and not to be called
PreconditionerFactoryBase<Scalar>&
operator=(const PreconditionerFactoryBase<Scalar>&);
};
} // namespace Thyra
#endif // THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP
|