/usr/include/trilinos/LOCA_MultiContinuation_MultiVecConstraint.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 | // $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_MULTIVECCONSTRAINT_H
#define LOCA_MULTICONTINUATION_MULTIVECCONSTRAINT_H
#include "LOCA_MultiContinuation_ConstraintInterfaceMVDX.H" // base class
#include "NOX_Abstract_MultiVector.H" // for dense matrix
namespace LOCA {
namespace MultiContinuation {
/*!
* \brief Implementation of
* LOCA::MultiContinuation::ConstraintInterfaceMVDX for a simple linear
* multivector constraint.
*/
class MultiVecConstraint :
public LOCA::MultiContinuation::ConstraintInterfaceMVDX {
public:
//! Constructor
MultiVecConstraint(
const Teuchos::RCP<const NOX::Abstract::MultiVector>& dx);
//! Copy constructor
MultiVecConstraint(const MultiVecConstraint& source,
NOX::CopyType type = NOX::DeepCopy);
//! Destructor
~MultiVecConstraint();
//! Set constraint vector
virtual void setDx(
const Teuchos::RCP<const NOX::Abstract::MultiVector>& dx);
/*!
* @name Implementation of LOCA::MultiContinuation::ConstraintInterfaceMVDX
* virtual methods
*/
//@{
//! Copy
virtual void copy(const ConstraintInterface& source);
//! Cloning function
virtual
Teuchos::RCP<LOCA::MultiContinuation::ConstraintInterface>
clone(NOX::CopyType type = NOX::DeepCopy) const;
//! Return number of constraints
virtual int numConstraints() const;
//! Set the solution vector to y.
virtual void setX(const NOX::Abstract::Vector& y);
//! Sets parameter indexed by paramID
virtual void setParam(int paramID, double val);
//! Sets parameters indexed by paramIDs
virtual void setParams(
const std::vector<int>& paramIDs,
const NOX::Abstract::MultiVector::DenseMatrix& vals);
//! Compute continuation constraint equations
virtual NOX::Abstract::Group::ReturnType
computeConstraints();
//! Compute derivative of constraints w.r.t. solution vector x
virtual NOX::Abstract::Group::ReturnType
computeDX();
//! Compute derivative of constraints w.r.t. supplied parameters.
/*!
* The first column of \c dgdp should be filled with the constraint
* residuals \f$g\f$ if \c isValidG is \c false. If \c isValidG is
* \c true, then the \c dgdp contains \f$g\f$ on input.
*/
virtual NOX::Abstract::Group::ReturnType
computeDP(const std::vector<int>& paramIDs,
NOX::Abstract::MultiVector::DenseMatrix& dgdp,
bool isValidG);
//! Return \c true if constraint residuals are valid
virtual bool isConstraints() const;
//! Return \c true if derivatives of constraints w.r.t. x are valid
virtual bool isDX() const;
//! Return constraint residuals
virtual const NOX::Abstract::MultiVector::DenseMatrix&
getConstraints() const;
//! Return solution component of constraint derivatives
virtual const NOX::Abstract::MultiVector*
getDX() const;
/*!
* \brief Return \c true if solution component of constraint
* derivatives is zero
*/
virtual bool isDXZero() const;
//! Notify constraint that the continuation step is completed
/*!
* Here we do nothing
*/
virtual void notifyCompletedStep();
//@}
private:
//! Prohibit generation and use of operator=()
MultiVecConstraint& operator=(const MultiVecConstraint& source);
protected:
//! Constraint vector
Teuchos::RCP<NOX::Abstract::MultiVector> dx;
//! Solution vector
Teuchos::RCP<NOX::Abstract::MultiVector> x;
//! Constraint values
NOX::Abstract::MultiVector::DenseMatrix constraints;
//! Flag indicating whether constraints are valid
bool isValidConstraints;
}; // Class MultiVecConstraint
} // namespace MultiContinuation
} // namespace LOCA
#endif // LOCA_MULTICONTINUATION_MULTIVECCONSTRAINT_H
|