/usr/include/trilinos/NOX_Thyra_Group.H is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
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 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// NOX: An Object-Oriented Nonlinear Solver Package
// Copyright (2002) Sandia Corporation
//
// 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.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
//
// Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
// CVS Information
// $Source$
// $Author$
// $Date$
// $Revision$
// ************************************************************************
//@HEADER
#ifndef NOX_THYRA_GROUP_H
#define NOX_THYRA_GROUP_H
#include "Teuchos_RCP.hpp"
#include "Thyra_ModelEvaluator.hpp"
#include "NOX_Abstract_Group.H" // base class
#include "NOX_Common.H" // class data element (string)
#include "NOX_Thyra_Vector.H" // class data element
#include "NOX_SharedObjectTemplate.H" // class data element
// Forward declares
namespace NOX {
namespace Parameter {
class List;
}
}
namespace Thyra {
template <class T> class ModelEvaluator;
template <class T> class MultiVectorBase;
template <class Scalar> class LinearOpWithSolveBase;
}
namespace NOX {
namespace Thyra {
//! A simple example of a group structure, based on Thyra.
class Group : public virtual NOX::Abstract::Group {
public:
//! Constructor
Group(const NOX::Thyra::Vector& initial_guess,
const Teuchos::RCP< const ::Thyra::ModelEvaluator<double> >& model);
//! Copy constructor
Group(const NOX::Thyra::Group& source, NOX::CopyType type = DeepCopy);
//! Destructor.
~Group();
NOX::Abstract::Group& operator=(const NOX::Abstract::Group& source);
//! See above.
NOX::Abstract::Group& operator=(const NOX::Thyra::Group& source);
/** \brief . */
Teuchos::RCP<const ::Thyra::VectorBase<double> > get_current_x() const;
/** \brief . */
Teuchos::RCP< ::Thyra::LinearOpWithSolveBase<double> >
getNonconstJacobian();
/** \brief . */
Teuchos::RCP<const ::Thyra::LinearOpWithSolveBase<double> > getJacobian() const;
/** @name "Compute" functions. */
//@{
void setX(const NOX::Abstract::Vector& y);
//! See above
void setX(const NOX::Thyra::Vector& y);
void computeX(const NOX::Abstract::Group& grp,
const NOX::Abstract::Vector& d,
double step);
//! See above.
void computeX(const NOX::Thyra::Group& grp,
const NOX::Thyra::Vector& d,
double step);
NOX::Abstract::Group::ReturnType computeF();
NOX::Abstract::Group::ReturnType computeJacobian();
NOX::Abstract::Group::ReturnType computeGradient();
NOX::Abstract::Group::ReturnType
computeNewton(Teuchos::ParameterList& params);
//@}
/** @name Jacobian operations.
*
* Operations using the Jacobian matrix. These may not be defined in
* matrix-free scenarios. */
//@{
NOX::Abstract::Group::ReturnType
applyJacobian(const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobian(const NOX::Thyra::Vector& input,
NOX::Thyra::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianMultiVector(const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianTranspose(const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianTranspose(const NOX::Thyra::Vector& input,
NOX::Thyra::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianTransposeMultiVector(
const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianInverse(Teuchos::ParameterList& params,
const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianInverse(Teuchos::ParameterList& params,
const NOX::Thyra::Vector& input,
NOX::Thyra::Vector& result) const;
NOX::Abstract::Group::ReturnType
applyJacobianInverseMultiVector(
Teuchos::ParameterList& params,
const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
//@}
/** @name "Is" functions
*
* Checks to see if various objects have been computed. Returns true
* if the corresponding "compute" function has been called since the
* last update to the solution vector (via instantiation or
* computeX). */
//@{
bool isF() const;
bool isJacobian() const;
bool isGradient() const;
bool isNewton() const;
//@}
/** @name "Get" functions
*
* Note that these function do not check whether or not the vectors
* are valid. Must use the "Is" functions for that purpose. */
//@{
const NOX::Abstract::Vector& getX() const;
const NOX::Abstract::Vector& getF() const;
double getNormF() const;
const NOX::Abstract::Vector& getGradient() const;
const NOX::Abstract::Vector& getNewton() const;
//@}
virtual Teuchos::RCP<NOX::Abstract::Group>
clone(NOX::CopyType type = NOX::DeepCopy) const;
//! Print out the group
void print() const;
protected:
//! resets the isValid flags to false
void resetIsValidFlags();
//! Apply Jacobian inverse using Thyra objects
NOX::Abstract::Group::ReturnType
applyJacobianInverseMultiVector(
Teuchos::ParameterList& p,
const ::Thyra::MultiVectorBase<double>& input,
::Thyra::MultiVectorBase<double>& result) const;
::Thyra::ESolveMeasureNormType
getThyraNormType(const string& name) const;
protected:
//! Problem interface
Teuchos::RCP< const ::Thyra::ModelEvaluator<double> > model_;
/** @name IsValid flags
*
* True if the current solution is up-to-date with respect to the
* currect solution vector. */
//@{
bool is_valid_f_;
bool is_valid_jacobian_;
bool is_valid_newton_dir_;
bool is_valid_gradient_dir_;
//@}
//! Solution vector
Teuchos::RCP<NOX::Thyra::Vector> x_vec_;
//! Residual vector
Teuchos::RCP<NOX::Thyra::Vector> f_vec_;
//! Newton direction vector
Teuchos::RCP<NOX::Thyra::Vector> newton_vec_;
//! Gradient direction vector
Teuchos::RCP<NOX::Thyra::Vector> gradient_vec_;
//! Shared Jacobian operator
Teuchos::RCP<
NOX::SharedObject<
::Thyra::LinearOpWithSolveBase<double>,
NOX::Thyra::Group
>
> shared_jacobian_;
//! Residual InArgs
::Thyra::ModelEvaluatorBase::InArgs<double> in_args_;
//! Residual OutArgs
::Thyra::ModelEvaluatorBase::OutArgs<double> out_args_;
};
} // namespace LAPACK
} // namespace NOX
#endif
|