/usr/include/trilinos/LOCA_Thyra_Group.H is in libtrilinos-nox-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 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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// LOCA: Library of Continuation Algorithms Package
// Copyright (2005) 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 Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
// CVS Information
// $Source$
// $Author$
// $Date$
// $Revision$
// ************************************************************************
//@HEADER
#ifndef LOCA_THYRA_GROUP_H
#define LOCA_THYRA_GROUP_H
#include "LOCA_Abstract_Group.H" // base class
#include "NOX_Thyra_Group.H" // base class
#include "LOCA_Parameter_Vector.H" // class data element
#include "Thyra_VectorBase.hpp" // class data element
#include "LOCA_Thyra_SaveDataStrategy.H" // class data element
// Forward declares
namespace Teuchos {
class ParameterList;
}
namespace LOCA {
//! %LOCA %Thyra support
namespace Thyra {
//! Extension of the NOX::Thyra::Group to %LOCA.
class Group : public virtual NOX::Thyra::Group,
public virtual LOCA::Abstract::Group {
public:
//! Constructor
Group(const Teuchos::RCP<LOCA::GlobalData>& global_data,
const NOX::Thyra::Vector& initial_guess,
const Teuchos::RCP< ::Thyra::ModelEvaluator<double> >& model,
const LOCA::ParameterVector& p,
int p_index,
bool implement_dfdp = false,
const Teuchos::RCP<const ::Thyra::VectorBase<double> >& weight_vector = Teuchos::null);
/*!
* \brief Copy constructor. If type is DeepCopy, takes ownership of
* valid shared Jacobian.
*/
Group(const Group& source, NOX::CopyType type = NOX::DeepCopy);
//! Destructor.
virtual ~Group();
//! Assignment operator
virtual Group& operator=(const Group& source);
/*!
* @name Overloaded NOX::Thyra::Group methods.
*/
//@{
//! Assignment operator.
virtual NOX::Abstract::Group&
operator=(const NOX::Abstract::Group& source);
//! Assignment operator.
virtual NOX::Abstract::Group&
operator=(const NOX::Thyra::Group& source);
//! Cloning function
virtual Teuchos::RCP<NOX::Abstract::Group>
clone(NOX::CopyType type = NOX::DeepCopy) const;
//! Overloaded computeF()
virtual NOX::Abstract::Group::ReturnType
computeF();
//! Overloaded computeJacobian()
virtual NOX::Abstract::Group::ReturnType
computeJacobian();
//@}
/*!
* @name Implementation of LOCA::MultiContinuation::AbstractGroup virtual methods.
*/
//@{
//! Copy
virtual void copy(const NOX::Abstract::Group& source);
//! Set the parameters
virtual void setParams(const ParameterVector& p);
//! Set parameter indexed by paramID
virtual void setParam(int paramID, double val);
//! Set parameter indexed by paramID
virtual void setParam(std::string paramID, double val);
//! Return a const reference to the ParameterVector owned by the group.
const LOCA::ParameterVector& getParams() const;
//! Return copy of parameter indexed by paramID
virtual double getParam(int paramID) const;
//! Return copy of parameter indexed by paramID
virtual double getParam(std::string paramID) const;
/*!
* Compute \f$\partial F/\partial p\f$ for each parameter \f$p\f$
* indexed by paramIDs. The first column of \em dfdp holds F,
* which is valid if \em isValidF is true. Otherwise F must be
* computed.
*/
virtual NOX::Abstract::Group::ReturnType
computeDfDpMulti(const std::vector<int>& paramIDs,
NOX::Abstract::MultiVector& dfdp,
bool isValidF);
//! Perform any preprocessing before a continuation step starts.
virtual void
preProcessContinuationStep(
LOCA::Abstract::Iterator::StepStatus stepStatus);
//! Perform any postprocessing after a continuation step finishes.
virtual void
postProcessContinuationStep(
LOCA::Abstract::Iterator::StepStatus stepStatus);
//! Projects solution to a few scalars for multiparameter continuation
virtual void projectToDraw(const NOX::Abstract::Vector& x,
double *px) const;
//! Returns the dimension of the project to draw array
virtual int projectToDrawDimension() const;
//! Compute a scaled dot product
/*!
* The implementation here uses the standard dot product divided
* by the length of the vectors.
*/
virtual double
computeScaledDotProduct(const NOX::Abstract::Vector& a,
const NOX::Abstract::Vector& b) const;
//! Call the user interface print() routine, solution vector
virtual void printSolution(const double conParam) const;
//! Call the user interface print() routine, any vector
virtual void printSolution(const NOX::Abstract::Vector& x,
const double conParam) const;
//! Scales a vector using scaling vector
/*!
* The implementation here rescales the vector by the square root of
* its length.
*/
virtual void
scaleVector(NOX::Abstract::Vector& x) const;
//@}
/*!
* @name Implementation of LOCA::TimeDependent::AbstractGroup virtual methods.
*/
//@{
//! Compute the shifted matrix
virtual NOX::Abstract::Group::ReturnType
computeShiftedMatrix(double alpha, double beta);
//! Multiply the shifted matrix by a vector.
virtual NOX::Abstract::Group::ReturnType
applyShiftedMatrix(const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
//! Multiply the shifted matrix by a multi-vector.
virtual NOX::Abstract::Group::ReturnType
applyShiftedMatrixMultiVector(
const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
/*!
* \brief Apply the inverse of the shifted matrix by a multi-vector, as
* needed by the shift-and-invert and generalized Cayley transformations.
*/
virtual NOX::Abstract::Group::ReturnType
applyShiftedMatrixInverseMultiVector(
Teuchos::ParameterList& params,
const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
//@}
//! Set strategy object for saving continuation data
void setSaveDataStrategy(
const Teuchos::RCP<LOCA::Thyra::SaveDataStrategy>& s);
protected:
//! Global data
Teuchos::RCP<LOCA::GlobalData> globalData;
//! Parameter vector
LOCA::ParameterVector params;
//! Parameter index in Thyra::ModelEvaluator
int param_index;
//! Pointer to Thyra vector storing parameters
Teuchos::RCP< const ::Thyra::VectorBase<double> > param_thyra_vec;
//! Pointer to x_dot vector of zeros
Teuchos::RCP< const ::Thyra::VectorBase<double> > x_dot_vec;
//! Strategy object for saving continuation data
Teuchos::RCP<LOCA::Thyra::SaveDataStrategy> saveDataStrategy;
//! Whether we should implement df/dp, or use DerivUtils
bool implement_dfdp;
/** \brief Optional weighting vector for function scaling
This is pulled out of the initial guess vector
*/
Teuchos::RCP<const ::Thyra::VectorBase<double> > weight_vec_;
private:
void updateThyraParamView();
void updateThyraXDot();
};
} // namespace Thyra
} // namespace LOCA
#endif
|