/usr/include/trilinos/LOCA_MultiContinuation_AbstractStrategy.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 | // $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_MULTICONTINUATION_ABSTRACTSTRATEGY_H
#define LOCA_MULTICONTINUATION_ABSTRACTSTRATEGY_H
#include "Teuchos_RCP.hpp"
#include "LOCA_Extended_MultiAbstractGroup.H" // base class
#include "LOCA_Abstract_Iterator.H" // for StepStatus
// forward declarations
namespace LOCA {
namespace MultiContinuation {
class ExtendedVector;
class ExtendedMultiVector;
}
}
namespace LOCA {
namespace MultiContinuation {
//! Abstract interface class for continuation strategies
/*!
* AbstractStrategy defines an abstract interface for continuation
* strategies. This interface is used by the LOCA::Stepper to manipulate
* continuation groups in a consistent manner. It defines a number
* pure virtual methods that all continuation groups must implement.
*/
class AbstractStrategy :
public virtual LOCA::Extended::MultiAbstractGroup {
public:
//! Constructor
AbstractStrategy() {}
//! Destructor
virtual ~AbstractStrategy() {}
//! Copy
virtual void copy(const NOX::Abstract::Group& source) = 0;
//! Returns number of parameters
virtual int getNumParams() const = 0;
//! Perform any preprocessing before a continuation step starts.
/*!
* The \c stepStatus argument indicates whether the previous step was
* successful.
*/
virtual void
preProcessContinuationStep(
LOCA::Abstract::Iterator::StepStatus stepStatus) = 0;
//! Perform any postprocessing after a continuation step finishes.
/*!
* The \c stepStatus argument indicates whether the step was
* successful.
*/
virtual void
postProcessContinuationStep(
LOCA::Abstract::Iterator::StepStatus stepStatus) = 0;
//! Compute predictor directions
virtual NOX::Abstract::Group::ReturnType
computePredictor() = 0;
//! Is Predictor valid
virtual bool isPredictor() const = 0;
//! Scales tangent to predictor
virtual void scaleTangent() = 0;
//! Sets tangent to predictor
/*!
* This is required by MF which takes the tangent space,
* orthogonalizes it, and then sets it back in the group.
*/
virtual void
setPredictorTangentDirection(
const LOCA::MultiContinuation::ExtendedVector& v,
int i) = 0;
//! Returns tangent to predictor
virtual const LOCA::MultiContinuation::ExtendedMultiVector&
getPredictorTangent() const = 0;
//! Returns scaled tangent to predictor
virtual const LOCA::MultiContinuation::ExtendedMultiVector&
getScaledPredictorTangent() const = 0;
//! Set the previous solution vector y
virtual void setPrevX(const NOX::Abstract::Vector& y) = 0;
//! Gets the previous solution vector
virtual const LOCA::MultiContinuation::ExtendedVector&
getPrevX() const = 0;
//! Set step size for continuation constraint equation \em i
virtual void setStepSize(double deltaS, int i = 0) = 0;
//! Get step size for continuation constraint equation \em i
virtual double getStepSize(int i = 0) const = 0;
//! Sets the value for continuation parameter \em i
virtual void setContinuationParameter(double val, int i = 0) = 0;
//! Returns the value for continuation parameter \em i
virtual double getContinuationParameter(int i = 0) const = 0;
//! Get the continuation parameter id for parameter \em i
virtual int getContinuationParameterID(int i = 0) const = 0;
//! Get the continuation parameter ids
virtual const std::vector<int>& getContinuationParameterIDs() const = 0;
//! Get the continuation parameter id for parameter \em i
virtual std::string getContinuationParameterName(int i = 0) const = 0;
//! Returns step size scale factor for constraint equation \em i
virtual double getStepSizeScaleFactor(int i = 0) const = 0;
//! Prints the group
virtual void printSolution() const = 0;
//! Computes a scaled dot product between two continuation vectors
virtual double computeScaledDotProduct(
const NOX::Abstract::Vector& x,
const NOX::Abstract::Vector& y) const = 0;
//! Returns dimension of project to draw array
virtual int projectToDrawDimension() const = 0;
//! Fills the project to draw array
virtual void projectToDraw(
const LOCA::MultiContinuation::ExtendedVector& x,
double *px) const = 0;
//! Bring NOX::Abstract::Group::operator=() into scope
using NOX::Abstract::Group::operator=;
}; // Class AbstractStrategy
} // Namespace MultiContinuation
} // Namespace LOCA
#endif // LOCA_MULTICONTINUATION_ABSTRACTSTRATEGY_H
|