/usr/include/trilinos/LOCA_MultiContinuation_FiniteDifferenceGroup.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 | // $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_FINITEDIFFERENCEGROUP_H
#define LOCA_MULTICONTINUATION_FINITEDIFFERENCEGROUP_H
#include "LOCA_MultiContinuation_AbstractGroup.H" // base class
#include "LOCA_DerivUtils.H" // class data element
namespace LOCA {
namespace MultiContinuation {
/*!
* \brief Concrete class that provides a concrete implementation of the
* computeDfDp() method of the LOCA::Continuation::AbstractGroup using
* first-order finite differencing.
*/
/*!
* The finite-differencing calculations are actually implemented by
* the LOCA::DerivUtils class, and a custom DerivUtils object can be
* set by the setDerivUtils() method. However, in the future
* the calculations encapsulated in the DerivUtils class may be
* incorporated directly into this class and other finite-differencing
* child classes.
*/
class FiniteDifferenceGroup :
public virtual LOCA::MultiContinuation::AbstractGroup {
public:
//! Constructor.
FiniteDifferenceGroup();
//! Copy constructor
FiniteDifferenceGroup(const FiniteDifferenceGroup& source,
NOX::CopyType type = NOX::DeepCopy);
//! Destructor.
virtual ~FiniteDifferenceGroup();
//! Copy
virtual void copy(const NOX::Abstract::Group& source);
//! Assignment
virtual NOX::Abstract::Group&
operator=(const NOX::Abstract::Group& source);
//! Set the LOCA::DerivUtils object
virtual void setDerivUtils(
const Teuchos::RCP<LOCA::DerivUtils>& deriv);
/*!
* Compute \f$\partial F/\partial p\f$ for each parameter \f$p\f$
* indexed by paramIDs. The first column of \em dfdp holds F,
* which is valid if \em isValidF is true. Otherwise F must be
* computed.
*/
/*!
* The calculation is implemented by calling the corresponding
* LOCA::DerivUtils::computeDfDp() method of the passed
* LOCA::DerivUtils object.
*/
virtual NOX::Abstract::Group::ReturnType
computeDfDpMulti(const std::vector<int>& paramIDs,
NOX::Abstract::MultiVector& dfdp,
bool isValidF);
private:
//! Prohibit generation and use of operator=()
FiniteDifferenceGroup& operator=(const FiniteDifferenceGroup&);
protected:
//! Pointer to current DerivUtils derivative computation object
Teuchos::RCP<DerivUtils> derivPtr;
};
} // namespace MultiContinuation
} // namespace LOCA
#endif
|