/usr/include/trilinos/Piro_PerformSolve.hpp is in libtrilinos-piro-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 | // @HEADER
// ************************************************************************
//
// Piro: Strategy package for embedded analysis capabilitites
// Copyright (2010) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Andy Salinger (agsalin@sandia.gov), Sandia
// National Laboratories.
//
// ************************************************************************
// @HEADER
#ifndef PIRO_PERFORMSOLVE_HPP
#define PIRO_PERFORMSOLVE_HPP
#include "Thyra_ResponseOnlyModelEvaluatorBase.hpp"
#include "Thyra_MultiVectorBase.hpp"
#include "Thyra_VectorBase.hpp"
#include "Piro_SolutionObserverBase.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_RCP.hpp"
namespace Piro {
//! \name Top-level Thyra solve drivers
//@{
//! \brief Evaluates the solved model and returns the first response.
//! \details .
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolve(
const Thyra::ResponseOnlyModelEvaluatorBase<Scalar> &piroModel,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response);
//! \brief Evaluates the solved model and returns the specified response.
//! \details Returns the specified (first by default) response.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolve(
const Thyra::ResponseOnlyModelEvaluatorBase<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response);
//! \brief Evaluates the solved model and returns the specified response and sensitivity.
//! \details Returns the specified (first by default) response and optionally the corresponding sensitivity with respect to the first parameter.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolve(
const Thyra::ResponseOnlyModelEvaluatorBase<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response,
Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > &sensitivity);
//! \brief Evaluates the solved model and returns specified responses and sensitivities.
//! \details Returns the requested responses and optionally the corresponding sensitivities with respect to all parameters.
//! This version accepts pointers to non-<tt>const</tt> objects.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolve(
const Thyra::ResponseOnlyModelEvaluatorBase<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::Array<Teuchos::RCP<Thyra::VectorBase<Scalar> > > &responses,
Teuchos::Array<Teuchos::Array<Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > > > &sensitivities);
//! \brief Evaluates the solved model and returns specified responses and sensitivities.
//! \details Returns the requested responses and optionally the corresponding sensitivities with respect to all parameters.
//! This version accepts pointers to <tt>const</tt>-qualified objects.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolve(
const Thyra::ResponseOnlyModelEvaluatorBase<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > > &responses,
Teuchos::Array<Teuchos::Array<Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > > > &sensitivities);
//@}
//! \name Other Thyra solve drivers
//! \brief The drivers do not statically check that the model is of the response-only variety.
//@{
//! \brief Evaluates the solved model and returns the first response.
//! \details Returns the first (i.e. with index 0) reponse.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response);
//! \brief Evaluates the solved model and returns the specified response.
//! \details Returns the specified (first by default) response.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response);
//! \brief Evaluates the solved model and returns the specified response and sensitivity.
//! \details Returns the specified (first by default) response and optionally the corresponding sensitivity with respect to the first parameter.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::RCP<Thyra::VectorBase<Scalar> > &response,
Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > &sensitivity);
//! \brief Evaluates the solved model and returns specified responses and sensitivities.
//! \details Returns the requested responses and optionally the corresponding sensitivities with respect to all parameters.
//! This version accepts pointers to non-<tt>const</tt> objects.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::Array<Teuchos::RCP<Thyra::VectorBase<Scalar> > > &responses,
Teuchos::Array<Teuchos::Array<Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > > > &sensitivities);
//! \brief Evaluates the solved model and returns specified responses and sensitivities.
//! \details Returns the requested responses and optionally the corresponding sensitivities with respect to all parameters.
//! This version accepts pointers to <tt>const</tt>-qualified objects.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > > &responses,
Teuchos::Array<Teuchos::Array<Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > > > &sensitivities);
//! \brief Evaluates the solved model and returns specified responses and sensitivities.
//! \details Returns the requested responses and optionally the corresponding sensitivities with respect to all parameters.
//! This version accepts pointers to <tt>const</tt>-qualified objects.
//! \ingroup Piro_Thyra_solve_driver_grp
template <typename Scalar>
void PerformSolveBase(
const Thyra::ModelEvaluator<Scalar> &piroModel,
Teuchos::ParameterList &solveParams,
Teuchos::Array<Teuchos::RCP<const Thyra::VectorBase<Scalar> > > &responses,
Teuchos::Array<Teuchos::Array<Teuchos::RCP<const Thyra::MultiVectorBase<Scalar> > > > &sensitivities,
Teuchos::RCP<SolutionObserverBase<Scalar, const Thyra::VectorBase<Scalar> > > observer);
//@}
} // namespace Piro
#include "Piro_PerformSolve_Def.hpp"
#endif /* PIRO_PERFORMSOLVE_HPP */
|