/usr/include/trilinos/Thyra_MLPreconditionerFactory.hpp is in libtrilinos-stratimikos-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 | // @HEADER
// ***********************************************************************
//
// Stratimikos: Thyra-based strategies for linear solvers
// Copyright (2006) 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 (rabartl@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
#define THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
namespace Thyra {
/** \brief Concrete preconditioner factory subclass based on ML.
*
* For information on ML and its available options, please see the ML <A HREF=http://trilinos.sandia.gov/packages/ml/index.html>home page</A> or the ML User <A HREF="http://trilinos.sandia.gov/packages/ml/manuals.html">manuals</A>.
*/
class MLPreconditionerFactory : public PreconditionerFactoryBase<double> {
public:
/** @name Constructors/initializers/accessors */
//@{
/** \brief . */
MLPreconditionerFactory();
/** \brief Set the strategy object used to extract an
* <tt>Epetra_Operator</tt> view of an input forward operator.
*
* This view will then be dynamically casted to <tt>Epetra_RowMatrix</tt>
* before it is used.
*
* The default implementation used is <tt>EpetraOperatorViewExtractorBase</tt>.
*/
STANDARD_COMPOSITION_MEMBERS(
EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );
//@}
/** @name Overridden from PreconditionerFactoryBase */
//@{
/** \brief . */
bool isCompatible( const LinearOpSourceBase<double> &fwdOp ) const;
/** \brief . */
bool applySupportsConj(EConj conj) const;
/** \brief . */
bool applyTransposeSupportsConj(EConj conj) const;
/** \brief . */
Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
/** \brief . */
void initializePrec(
const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOp,
PreconditionerBase<double> *prec,
const ESupportSolveUse supportSolveUse
) const;
/** \brief . */
void uninitializePrec(
PreconditionerBase<double> *prec
,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOp
,ESupportSolveUse *supportSolveUse
) const;
//@}
/** @name Overridden from Teuchos::ParameterListAcceptor */
//@{
/** \brief . */
void setParameterList(
Teuchos::RCP<Teuchos::ParameterList> const& paramList);
/** \brief . */
Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
/** \brief . */
Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
/** \brief . */
Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
/** \brief . */
Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
//@}
/** \name Public functions overridden from Describable. */
//@{
/** \brief . */
std::string description() const;
// ToDo: Add an override of describe(...) to give more detail!
//@}
private:
Teuchos::RCP<Teuchos::ParameterList> paramList_;
};
} // namespace Thyra
#endif // THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
|