/usr/include/trilinos/Thyra_EpetraOperatorViewExtractorBase.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 | // @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_EPETRA_OPERATOR_VIEW_EXTRACTOR_BASE_HPP
#define THYRA_EPETRA_OPERATOR_VIEW_EXTRACTOR_BASE_HPP
#include "Thyra_LinearOpBase.hpp"
#include "Thyra_EpetraTypes.hpp"
namespace Thyra {
/** \brief Strategy interface for extracting an <tt>Epetra_Operator</tt> view
* out of a <tt>Thyra::LinearOpBase<double></tt> object.
*
* ToDo: Finish documentation!
*
* \ingroup Epetra_Thyra_Op_Vec_adapters_grp
*/
class EpetraOperatorViewExtractorBase : virtual public Teuchos::Describable
{
public:
/** \name Pure virtual 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 LinearOpBase<double> &fwdOp ) const = 0;
/** \brief Gat a smart pointer to a non-<tt>const</tt>
* <tt>Epetra_Operator</tt> view of a <tt>Thyra::LinearOpBase</tt> object
* and how the object is applied to implement the forward linear operator.
*
* \param fwdOp [in] The forward linear operator that the view will be
* extracted from. This object may be a wrapped scaled/adjoint operator on
* input. On output this object is "remembered" in the returned RCP for
* <tt>epetraOp</tt>.
*
* \param epetraOp [out] The non-<tt>const</tt> epetra operator view of
* <tt>*this</tt>.
*
* \param epetraOpTransp [out] Determines if the operator is applied as its
* transpose or its non-transpose. The Client should use this value and
* ignore the value in <tt>(*epetraOp)->UseTranspose()</tt> since it has
* been shown to be problematic and error prone.
*
* \param epetraOpApplyAs [out] Determines if the operator should be applied
* using <tt>(*epetraOp)->Apply(...)</tt> or using
* <tt>(*epetraOp)->ApplyInverse(...)</tt>.
*
* \param epetraOpAdjointSupport [out] Determines if the operator supports
* transposes or not.
*
* \param epetraOpScalar [out] The scalar from the wrapped scaled/adjoint
* linear operator
*
* <b>Preconditions:</b></ul>
* <li><tt>epetraOp!=NULL</tt>
* <li><tt>epetraOpOpTransp!=NULL</tt>
* <li><tt>epetraOpApplyAs!=NULL</tt>
* <li><tt>epetraOpAdjointSupport!=NULL</tt>
* </ul>
*
* <b>Posconditions:</b></ul>
* <li><tt>epetraOp->get() != NULL</tt>
* <li><tt>fwdOp.count()</tt> is greater on output than on input and hense
* <tt>fwdOp</tt> is "remembered"
* </ul>
*
* The object accessed from <tt>*epetraOp</tt> is only guaranteed to be
* valid while the returned <tt>Teuchos::RCP</tt> object exits.
* This allows for some very specialized implementations where a
* <tt>Epetra_Operator</tt> view of <tt>*this</tt> can be acquired and
* released according to the lifetime of the returned
* <tt>Teuchos::RCP</tt> object.
*
* The <tt>Epetra_Operator</tt> object may be dynamic casted to more
* specialized interfaces and therefore modified. Then, when the last
* <tt>RCP</tt> object ancestor returned from this function goes
* away, then <tt>*this</tt> will be updated to relect the change.
*/
virtual void getNonconstEpetraOpView(
const RCP<LinearOpBase<double> > &fwdOp,
const Ptr<RCP<Epetra_Operator> > &epetraOp,
const Ptr<EOpTransp> &epetraOpTransp,
const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport,
const Ptr<double> &epetraOpScalar
) const = 0;
/** \brief Gat a smart pointer to a <tt>const</tt>
* <tt>Epetra_Operator</tt> view of a <tt>Thyra::LinearOpBase</tt> object
* and how the object is applied to implement the forward linear operator.
*
* \param fwdOp [in] The forward linear operator that the view will be
* extracted from. This object may be a wrapped scaled/adjoint operator on
* input. On output this object is "remembered" in the returned RCP for
* <tt>epetraOp</tt>.
*
* \param epetraOp [out] The <tt>const</tt> epetra operator view of
* <tt>*this</tt>.
*
* \param epetraOpTransp [out] Determines if the operator is applied as its
* transpose or its non-transpose. The Client should use this value and
* ignore the value in <tt>(*epetraOp)->UseTranspose()</tt> since it has
* been shown to be problematic and error prone.
*
* \param epetraOpApplyAs [out] Determines if the operator should be applied
* using <tt>(*epetraOp)->Apply(...)</tt> or using
* <tt>(*epetraOp)->ApplyInverse(...)</tt>.
*
* \param epetraOpAdjointSupport [out] Determines if the operator supports
* transposes or not.
*
* \param epetraOpScalar [out] The scalar from the wrapped scaled/adjoint
* linear operator.
*
* <b>Preconditions:</b></ul>
* <li><tt>epetraOp!=NULL</tt>
* <li><tt>epetraOpOpTransp!=NULL</tt>
* <li><tt>epetraOpApplyAs!=NULL</tt>
* <li><tt>epetraOpAdjointSupport!=NULL</tt>
* </ul>
*
* <b>Posconditions:</b></ul>
* <li><tt>epetraOp->get() != NULL</tt>
* <li><tt>fwdOp.count()</tt> is greater on output than on input and hense <tt>fwdOp</tt> is "remembered"
* </ul>
*
* The object accessed from <tt>*return</tt> is only guaranteed to be valid
* while the returned <tt>Teuchos::RCP</tt> object exits. This
* allows for some very specialized implementations where a
* <tt>Epetra_Operator</tt> view of <tt>*this</tt> can be acquired and
* released according to the lifetime of the returned
* <tt>Teuchos::RCP</tt> object.
*
* Note that if the client tries to constant cast the returned object and
* modify it that this returned view is not guaranteed to update
* <tt>*this</tt>. If the goal is to modify <tt>*this</tt> then the client
* should call the non-<tt>const</tt> version of this function.
*/
virtual void getEpetraOpView(
const RCP<const LinearOpBase<double> > &fwdOp,
const Ptr<RCP<const Epetra_Operator> > &epetraOp,
const Ptr<EOpTransp> &epetraOpTransp,
const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport,
const Ptr<double> &epetraOpScalar
) const = 0;
//@}
};
} // namespace Thyra
#endif // THYRA_EPETRA_OPERATOR_VIEW_EXTRACTOR_BASE_HPP
|