/usr/include/trilinos/Piro_PerformAnalysis.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 | // @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_PERFORMANALYSIS
#define PIRO_PERFORMANALYSIS
#include "Piro_ConfigDefs.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"
#include "Thyra_ModelEvaluatorDefaultBase.hpp"
#include "Thyra_VectorStdOps.hpp"
namespace Piro {
//! \name Top-level Thyra analysis driver
//@{
//! \brief Performs analysis of a solved model.
//! \details This function can either call one of the package-specific drivers
//! or perform a \link Piro_Thyra_solve_driver_grp forward solve\endlink.
//! \ingroup Piro_Thyra_analysis_driver_grp
int PerformAnalysis(
Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
Teuchos::ParameterList& analysisParams,
Teuchos::RCP< Thyra::VectorBase<double> >& result
);
//@}
//! \name Package-specific Thyra analysis drivers
//! \brief The package-specific routines are called by the top-level driver.
//@{
//! \brief Performs analysis of a solved model using MOOCHO.
//! \details Requires that the MOOCHO package is available.
//! \ingroup Piro_Thyra_analysis_driver_grp
int PerformMoochoAnalysis(
Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
Teuchos::ParameterList& moochoParams,
Teuchos::RCP< Thyra::VectorBase<double> >& p
);
//! \brief Performs analysis of a solved model using Dakota via %TriKota.
//! \details Requires that the %TriKota package is available.
//! \ingroup Piro_Thyra_analysis_driver_grp
int PerformDakotaAnalysis(
Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
Teuchos::ParameterList& dakotaParams,
Teuchos::RCP< Thyra::VectorBase<double> >& p
);
//! \brief Performs analysis of a solved model using Optipack.
//! \details Requires that the OptiPack package is available.
//! \ingroup Piro_Thyra_analysis_driver_grp
int PerformOptiPackAnalysis(
Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
Teuchos::ParameterList& optipackParams,
Teuchos::ParameterList& globipackParams,
Teuchos::RCP< Thyra::VectorBase<double> >& p
);
//! \brief Performs analysis of a solved model using ROL.
//! \details Requires that the ROL package is available.
//! \ingroup Piro_Thyra_analysis_driver_grp
int PerformROLAnalysis(
Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
Teuchos::ParameterList& rolParams,
Teuchos::RCP< Thyra::VectorBase<double> >& p
);
//@}
//! \name Analysis parameter list validation
//@{
//! Valid parameters for the list sent to PerformAnalysis
//! \ingroup Piro_analysis_driver_grp
Teuchos::RCP<const Teuchos::ParameterList>
getValidPiroAnalysisParameters();
//! Valid parameters for the list sent to PerformDakotaAnalysis
//! \ingroup Piro_analysis_driver_grp
Teuchos::RCP<const Teuchos::ParameterList>
getValidPiroAnalysisDakotaParameters();
//@}
}
#endif //PIRO_PERFORMANALYSIS
|