/usr/include/trilinos/LOCA_PhaseTransition_ExtendedGroup.H is in libtrilinos-nox-dev 12.12.1-5.
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 | // $Id: NOXLOCA_Tramonto_ExtendedGroup.hpp,v 1.3 2007/03/09 20:57:47 ljfrink Exp $
// $Source: /space/CVS-Tramonto/Tramonto/src/NOXLOCA_Tramonto_ExtendedGroup.hpp,v $
//@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_PHASETRANSITION_EXTENDEDGROUP_H
#define LOCA_PHASETRANSITION_EXTENDEDGROUP_H
#include "LOCA_Abstract_Group.H" // base class
#include "LOCA_Parameter_Vector.H"
#include "LOCA_GlobalData.H"
#include "NOX_Common.H" // class data element (std::string)
#include "LOCA_PhaseTransition_ExtendedVector.H"
#include "LOCA_MultiContinuation_AbstractGroup.H" // base class
#include "LOCA_Extended_MultiAbstractGroup.H" // base class
#include "Teuchos_ParameterList.hpp" // base class
//#include "LOCA_Abstract_TransposeSolveGroup.H" // base class
//extern "C" {void fill_resid_and_matrix_control(double **, int, int);}
// Forward declares
namespace NOX {
namespace Parameter {
class List;
}
}
namespace LOCA {
namespace PhaseTransition {
//class Group : public virtual NOX::Abstract::Group {
class ExtendedGroup :
public virtual LOCA::Extended::MultiAbstractGroup,
public virtual LOCA::MultiContinuation::AbstractGroup {
public:
//! Constructor
ExtendedGroup(
const Teuchos::RCP<LOCA::GlobalData> gD,
const Teuchos::RCP<Teuchos::ParameterList>& bifurcationparams_,
const Teuchos::RCP<LOCA::PhaseTransition::AbstractGroup>& grp_);
//! Copy constructor
ExtendedGroup(const LOCA::PhaseTransition::ExtendedGroup& source, NOX::CopyType type = NOX::DeepCopy);
//! Destructor.
~ExtendedGroup();
//Start methods for NOX::ABstract::Group
NOX::Abstract::Group& operator=(const NOX::Abstract::Group& source);
//! See above.
NOX::Abstract::Group& operator=(const LOCA::PhaseTransition::ExtendedGroup& source);
/** @name "Compute" functions. */
//@{
void setX(const NOX::Abstract::Vector& y);
//! See above
void setX(const LOCA::PhaseTransition::ExtendedVector& y);
void computeX(const NOX::Abstract::Group& grp, const NOX::Abstract::Vector& d, double step);
//! See above.
void computeX(const LOCA::PhaseTransition::ExtendedGroup& grp,
const LOCA::PhaseTransition::ExtendedVector& d, double step);
NOX::Abstract::Group::ReturnType computeF();
NOX::Abstract::Group::ReturnType computeJacobian();
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 LOCA::PhaseTransition::ExtendedVector& input,
LOCA::PhaseTransition::ExtendedVector& result) const;
//! See above
NOX::Abstract::Group::ReturnType applyJacobian(const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& result) const;
NOX::Abstract::Group::ReturnType applyJacobianInverse(Teuchos::ParameterList& params,
const LOCA::PhaseTransition::ExtendedVector& input,
LOCA::PhaseTransition::ExtendedVector& result) const;
NOX::Abstract::Group::ReturnType applyJacobianInverse(Teuchos::ParameterList& params,
const NOX::Abstract::Vector& input,
NOX::Abstract::Vector& 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 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& getNewton() const;
const NOX::Abstract::Vector& getGradient() const;
Teuchos::RCP< const NOX::Abstract::Vector > getXPtr() const;
Teuchos::RCP< const NOX::Abstract::Vector > getFPtr() const;
Teuchos::RCP< const NOX::Abstract::Vector > getNewtonPtr() const;
Teuchos::RCP< const NOX::Abstract::Vector > getGradientPtr() const;
//@}
virtual Teuchos::RCP<NOX::Abstract::Group>
clone(NOX::CopyType type = NOX::DeepCopy) const;
//! Print out the group
void print() const;
//! Start methods for LOCA::Abstract::Group
//@{
void copy(const NOX::Abstract::Group& source) { *this = source; }
//! Set the parameter vector in the group to p (pVector = p).
void setParams(const LOCA::ParameterVector& p);
//! Set parameter indexed by (integer) paramID
void setParam(int paramID, double val);
//! Set parameter indexed by (std::string) paramID
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 (integer) paramID
double getParam(int paramID) const;
//! Return copy of parameter indexed by (std::string) paramID
double getParam(std::string paramID) const;
//! Set parameter indexed by (std::string) paramID
void printSolution(const NOX::Abstract::Vector& solution, const double param) const;
void printSolution(const double param) const;
//@}
//! Return underlying group
virtual
Teuchos::RCP<const LOCA::MultiContinuation::AbstractGroup>
getUnderlyingGroup() const { return grp;};
//! Return underlying group
virtual
Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup>
getUnderlyingGroup() { return grp;};
virtual void
setParamsMulti( const std::vector<int>& paramIDs,
const NOX::Abstract::MultiVector::DenseMatrix& vals);
virtual NOX::Abstract::Group::ReturnType
computeDfDpMulti( const std::vector<int>& paramIDs,
NOX::Abstract::MultiVector& dfdp,
bool isValid_F);
protected:
//! resets the isValid flags to false
void resetIsValid();
protected:
//! Solution vector.
Teuchos::RCP<LOCA::PhaseTransition::AbstractGroup> grp;
/** @name Vectors */
//@{
//! Solution vector.
Teuchos::RCP<LOCA::PhaseTransition::ExtendedVector> xVector;
//! Right-hand-side vector (function evaluation).
Teuchos::RCP<LOCA::PhaseTransition::ExtendedVector> fVector;
//! Newton direction vector.
Teuchos::RCP<LOCA::PhaseTransition::ExtendedVector> newtonVector;
//@}
/** @name IsValid flags
*
* True if the current solution is up-to-date with respect to the
* currect xVector. */
//@{
bool isValidF;
bool isValidJacobian;
bool isValidNewton;
//@}
double normF;
const Teuchos::RCP<LOCA::GlobalData> globalData;
int bifParamID;
};
} // namespace
} // namespace NOX
#endif
|