/usr/include/trilinos/Thyra_AmesosLinearOpWithSolveFactory.hpp is in libtrilinos-stratimikos-dev 12.4.2-2.
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 | /*
// @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_AMESOS_LINEAR_OP_WITH_SOLVE_FACTORY_HPP
#define THYRA_AMESOS_LINEAR_OP_WITH_SOLVE_FACTORY_HPP
#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Thyra_AmesosTypes.hpp"
#include "Amesos_BaseSolver.h"
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
namespace Thyra {
/** \brief Concrete <tt>LinearOpWithSolveFactoryBase</tt> adapter subclass that uses
* Amesos direct solvers.
*
* This class creates objects of type <tt>AmesosLinearOpWithSolve</tt>
* (through the <tt>LinearOpWithSolveBase</tt> interface) which can then be
* used to solve for linear systems. The <tt>%AmesosLinearOpWithSolve</tt>
* objects created and initialized by this object are completely independent
* from <tt>*this</tt>. This allows for multiple
* <tt>%AmesosLinearOpWithSolve</tt> objects to be created and maintained
* simultaneously and for <tt>*this</tt> factory object to be destroyed
* without affecting the created <tt>%AmesosLinearOpWithSolve</tt> objects.
*
* ToDo: Mention parameter list usage.
*
* <b>Development notes:</b> This class has been designed to allow for "smart"
* <tt>EpetraLinearOpBase</tt> subclasses that can create an
* <tt>Epetra_Operator</tt> view on command where the underlying storage may
* not be an <tt>Epetra</tt> object. However, the current implementation of
* at least some of the <tt>Amesos_BaseSolver</tt> subclasses do not allow the
* <tt>%Epetra_Operator</tt> object to change after construction. Therefore,
* this current flawed implementation requires that every call to the
* <tt>EpetraLinearOpBase::getEpetraOpView()</tt> function return the same
* <tt>%Epetra_Operator</tt> object.
*
* \ingroup Amesos_Thyra_adapters_grp
*/
class AmesosLinearOpWithSolveFactory : public LinearOpWithSolveFactoryBase<double> {
public:
/** \name Parameter names for Paramter List */
//@{
/** \brief . */
static const std::string SolverType_name;
/** \brief . */
static const std::string RefactorizationPolicy_name;
/** \brief . */
static const std::string ThrowOnPreconditionerInput_name;
/** \brief . */
static const std::string Amesos_Settings_name;
//@}
/** \name Constructors/initializers/accessors */
//@{
/** \brief . */
~AmesosLinearOpWithSolveFactory();
/** \brief Constructor which sets the defaults.
*/
AmesosLinearOpWithSolveFactory(
const Amesos::ESolverType solverType
#ifdef HAVE_AMESOS_KLU
= Amesos::KLU
#else
= Amesos::LAPACK
#endif
,const Amesos::ERefactorizationPolicy refactorizationPolicy = Amesos::REPIVOT_ON_REFACTORIZATION
,const bool throwOnPrecInput = true
);
/** \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 public functions from LinearOpWithSolveFactoryBase */
//@{
/** \brief Returns true if <tt>dynamic_cast<const
* EpetraLinearOpBase*>(fwdOpSrc)!=NULL</tt> .
*/
bool isCompatible( const LinearOpSourceBase<double> &fwdOpSrc ) const;
/** \brief . */
Teuchos::RCP<LinearOpWithSolveBase<double> > createOp() const;
/** \brief . */
void initializeOp(
const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc
,LinearOpWithSolveBase<double> *Op
,const ESupportSolveUse supportSolveUse
) const;
/** \brief Returns <tt>false</tt> . */
bool supportsPreconditionerInputType(const EPreconditionerInputType precOpType) const;
/** \brief Throws exception if <tt>this->throwOnPrecInput()==true</tt> and
* calls <tt>this->initializeOp(fwdOpSrc,Op)</tt> otherwise
*/
void initializePreconditionedOp(
const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc
,const Teuchos::RCP<const PreconditionerBase<double> > &prec
,LinearOpWithSolveBase<double> *Op
,const ESupportSolveUse supportSolveUse
) const;
/** \brief Throws exception if <tt>this->throwOnPrecInput()==true</tt> and
* calls <tt>this->initializeOp(fwdOpSrc,Op)</tt> otherwise
*/
void initializePreconditionedOp(
const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc
,const Teuchos::RCP<const LinearOpSourceBase<double> > &approxFwdOpSrc
,LinearOpWithSolveBase<double> *Op
,const ESupportSolveUse supportSolveUse
) const;
/** \brief . */
void uninitializeOp(
LinearOpWithSolveBase<double> *Op
,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOpSrc
,Teuchos::RCP<const PreconditionerBase<double> > *prec
,Teuchos::RCP<const LinearOpSourceBase<double> > *approxFwdOpSrc
,ESupportSolveUse *supportSolveUse
) const;
//@}
/** @name Overridden from 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 Teuchos::Describable. */
//@{
/** \brief . */
std::string description() const;
//@}
private:
// /////////////////////////
// Private data members
Amesos::ESolverType solverType_;
Amesos::ERefactorizationPolicy refactorizationPolicy_;
bool throwOnPrecInput_;
Teuchos::RCP<Teuchos::ParameterList> paramList_;
// /////////////////////////
// Private member functions
static Teuchos::RCP<const Teuchos::ParameterList>
generateAndGetValidParameters();
};
} // namespace Thyra
#endif // THYRA_AMESOS_LINEAR_OP_WITH_SOLVE_FACTORY_HPP
|