/usr/include/trilinos/LOCA_Abstract_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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | // $Id: LOCA_Abstract_Group.H,v 1.42 2007/06/21 16:22:52 rhoope Exp $
// $Source: /space/CVS/Trilinos/packages/nox/src-loca/src/LOCA_Abstract_Group.H,v $
//@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: /space/CVS/Trilinos/packages/nox/src-loca/src/LOCA_Abstract_Group.H,v $
// $Author: rhoope $
// $Date: 2007/06/21 16:22:52 $
// $Revision: 1.42 $
// ************************************************************************
//@HEADER
#ifndef LOCA_ABSTRACT_GROUP_H
#define LOCA_ABSTRACT_GROUP_H
#include "Teuchos_RCP.hpp"
#include "LOCA_Homotopy_AbstractGroup.H"
#include "LOCA_TurningPoint_MinimallyAugmented_FiniteDifferenceGroup.H"
#include "LOCA_Pitchfork_MinimallyAugmented_AbstractGroup.H"
#include "LOCA_Hopf_MinimallyAugmented_FiniteDifferenceGroup.H"
#include "LOCA_PhaseTransition_AbstractGroup.H"
namespace LOCA {
//! %LOCA abstract interface namespace
namespace Abstract {
/*!
* \brief Compatiblity class for AbstractGroup hierarchy.
*/
/*!
* This class is derived from all %LOCA AbstractGroup abstract base
* classes as well as all FiniteDifference groups and any other groups
* that provided default implementations for AbstractGroup pure virtual
* methods. This class provides definitions for all needed assignment
* operators and provides definitions for some pure virtual methods by
* printing error messages. This class exists primarily for compatiblity
* to an older class hierarchy and will most likely be removed in the
* future.
*/
class Group :
public virtual LOCA::Homotopy::AbstractGroup,
public virtual LOCA::TurningPoint::MinimallyAugmented::FiniteDifferenceGroup,
public virtual LOCA::Pitchfork::MinimallyAugmented::AbstractGroup,
public virtual LOCA::Hopf::MinimallyAugmented::FiniteDifferenceGroup,
public virtual LOCA::PhaseTransition::AbstractGroup
{
public:
//! Constructor
Group(const Teuchos::RCP<LOCA::GlobalData>& global_data);
//! Constructor
Group(const Teuchos::RCP<LOCA::GlobalData>& global_data,
const Teuchos::RCP<LOCA::DerivUtils>& deriv);
//! Copy constructor
Group(const Group& source, NOX::CopyType type = NOX::DeepCopy);
//! Destructor.
virtual ~Group();
/*!
* @name Implementation of LOCA::Homotopy::AbstractGroup virtual methods.
*/
//@{
/*!
* \brief Replace Jacobian \f$J\f$ by \f$aJ+bI\f$ where \f$I\f$ is
* the identity matrix and \f$p\f$ is a scalar.
*/
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
augmentJacobianForHomotopy(double a, double b);
//@}
/*!
* @name Implementation of LOCA::TimeDependent::AbstractGroup virtual methods.
*/
//@{
//! Compute the shifted matrix
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
computeShiftedMatrix(double alpha, double beta);
//! Multiply the shifted matrix by a vector.
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyShiftedMatrix(const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
//! Multiply the shifted matrix by a multi-vector.
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
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.
*/
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyShiftedMatrixInverseMultiVector(
Teuchos::ParameterList& params,
const NOX::Abstract::MultiVector& input,
NOX::Abstract::MultiVector& result) const;
//@}
/*!
* @name Implementation of LOCA::Hopf::Moorespence::AbstractGroup virtual methods.
*/
//@{
//! Is \f$J+i\omega B\f$ valid
/*!
* The implementation here always returns false.
*/
virtual bool isComplex() const;
//! Compute \f$J+i\omega B\f$
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
computeComplex(double frequency);
//! Compute \f$(J+i\omega B)(y+iz)\f$
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyComplex(const NOX::Abstract::Vector& input_real,
const NOX::Abstract::Vector& input_imag,
NOX::Abstract::Vector& result_real,
NOX::Abstract::Vector& result_imag) const;
//! Compute \f$(J+i\omega B)(y+iz)\f$
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyComplexMultiVector(const NOX::Abstract::MultiVector& input_real,
const NOX::Abstract::MultiVector& input_imag,
NOX::Abstract::MultiVector& result_real,
NOX::Abstract::MultiVector& result_imag) const;
//! Solve \f$(J+i\omega B)(y+iz) = a+ib\f$
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyComplexInverseMultiVector(
Teuchos::ParameterList& params,
const NOX::Abstract::MultiVector& input_real,
const NOX::Abstract::MultiVector& input_imag,
NOX::Abstract::MultiVector& result_real,
NOX::Abstract::MultiVector& result_imag) const;
//@}
/*!
* @name Implementation of LOCA::Hopf::MinimallyAugmented::AbstractGroup virtual methods.
*/
//@{
/*!
* Computes conjugate-tranpose matrix vector product
* \f$ (J+i\omega B)^H (x + iy) \f$.
*/
/*!
* Implementation here prints an error message and returns
* NOX::Abstract::Group::NotDefined.
*/
virtual NOX::Abstract::Group::ReturnType
applyComplexTranspose(const NOX::Abstract::Vector& input_real,
const NOX::Abstract::Vector& input_imag,
NOX::Abstract::Vector& result_real,
NOX::Abstract::Vector& result_imag) const;
/*!
* Computes conjugate-tranpose matrix vector product
* \f$ (J+i\omega B)^H (x + iy) \f$.
*/
virtual NOX::Abstract::Group::ReturnType
applyComplexTransposeMultiVector(
const NOX::Abstract::MultiVector& input_real,
const NOX::Abstract::MultiVector& input_imag,
NOX::Abstract::MultiVector& result_real,
NOX::Abstract::MultiVector& result_imag) const;
//! Solve \f$(J+i\omega B)^H (x + iy) = a+ib\f$
virtual NOX::Abstract::Group::ReturnType
applyComplexTransposeInverseMultiVector(
Teuchos::ParameterList& params,
const NOX::Abstract::MultiVector& input_real,
const NOX::Abstract::MultiVector& input_imag,
NOX::Abstract::MultiVector& result_real,
NOX::Abstract::MultiVector& result_imag) const;
//@}
/*!
* @name Implementation of LOCA::MultiContinuation::AbstractGroup virtual methods.
*/
//@{
//! Assignment operator
virtual void copy(const NOX::Abstract::Group& source);
//! Set parameters indexed by (integer) paramIDs
virtual void
setParamsMulti(const vector<int>& paramIDs,
const NOX::Abstract::MultiVector::DenseMatrix& vals);
//! Notify group that the continuation step is completed
//! The default implementation here is to do nothing.
virtual void notifyCompletedStep();
//@}
/*!
* @name Implementation of NOX::Abstract::Group virtual methods.
*/
//@{
virtual NOX::Abstract::Group&
operator=(const NOX::Abstract::Group& source);
//@}
/*!
* @name Implementation of LOCA::PhaseTransition::AbstractGroup virtual methods.
*/
//@{
virtual double computeFreeEnergy();
//@}
private:
//! Prohibit generation and use of operator=()
Group& operator=(const Group& source);
protected:
//! Global data
Teuchos::RCP<LOCA::GlobalData> globalData;
};
} // namespace Abstract
} // namespace LOCA
#endif
|