/usr/include/trilinos/Stokhos_EpetraMultiVectorOperator.hpp is in libtrilinos-stokhos-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 | // $Id$
// $Source$
// @HEADER
// ***********************************************************************
//
// Stokhos Package
// Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER
#ifndef STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
#define STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
#include "Teuchos_RCP.hpp"
#include "Epetra_Operator.h"
#include "Epetra_MultiVector.h"
namespace Stokhos {
/*!
* \brief An adaptor that supplies the operator interface to a multi-vector
*/
/*!
* Supplies the operator interface for the operator C = op(A)*B
* where A, B, and C are multi-vectors, and op() is the identity or
* transpose operator. The convention is when the transpose is not
* requested, A is treated as a row-oriented multi-vector and therefore
* the domain map is the map of A. The corresponding range map is a local
* map of size given by the number of vectors When the transpose
* is selected, these are reversed.
*
* This should really live somewhere else as it has nothing to do with
* Stokhos.
*/
class EpetraMultiVectorOperator : public Epetra_Operator {
public:
//! Constructor
EpetraMultiVectorOperator(
const Teuchos::RCP<const Epetra_MultiVector>& multi_vec,
bool is_multi_vec_transposed);
//! Constructor
EpetraMultiVectorOperator(
const Teuchos::RCP<Epetra_MultiVector>& multi_vec,
bool is_multi_vec_transposed);
//! Destructor
virtual ~EpetraMultiVectorOperator();
Teuchos::RCP<const Epetra_MultiVector>
getMultiVector() const { return multi_vec; }
Teuchos::RCP<Epetra_MultiVector>
getMultiVector() { return nonconst_multi_vec; }
//! Set to true if the transpose of the operator is requested
virtual int SetUseTranspose(bool UseTranspose);
/*!
* \brief Returns the result of a Epetra_Operator applied to a
* Epetra_MultiVector Input in Result as described above.
*/
virtual int Apply(const Epetra_MultiVector& Input,
Epetra_MultiVector& Result) const;
/*!
* \brief Returns the result of the inverse of the operator applied to a
* Epetra_MultiVector Input in Result as described above.
*/
virtual int ApplyInverse(const Epetra_MultiVector& X,
Epetra_MultiVector& Y) const;
//! Returns an approximate infinity norm of the operator matrix.
virtual double NormInf() const;
//! Returns a character string describing the operator
virtual const char* Label () const;
//! Returns the current UseTranspose setting.
virtual bool UseTranspose() const;
/*!
* \brief Returns true if the \e this object can provide an
* approximate Inf-norm, false otherwise.
*/
virtual bool HasNormInf() const;
/*!
* \brief Returns a reference to the Epetra_Comm communicator
* associated with this operator.
*/
virtual const Epetra_Comm & Comm() const;
/*!
* \brief Returns the Epetra_Map object associated with the
* domain of this matrix operator.
*/
virtual const Epetra_Map& OperatorDomainMap () const;
/*!
* \brief Returns the Epetra_Map object associated with the
* range of this matrix operator.
*/
virtual const Epetra_Map& OperatorRangeMap () const;
private:
//! Private to prohibit copying
EpetraMultiVectorOperator(const EpetraMultiVectorOperator&);
//! Private to prohibit copying
EpetraMultiVectorOperator& operator=(const EpetraMultiVectorOperator&);
protected:
//! Label for operator
std::string label;
//! Multi-vector
Teuchos::RCP<const Epetra_MultiVector> multi_vec;
//! Non-const multi-vector
Teuchos::RCP<Epetra_MultiVector> nonconst_multi_vec;
//! Whether the multivector is already transposed
bool is_multi_vec_transposed;
//! Flag indicating whether transpose was selected
bool useTranspose;
//! Domain map ( = number of columns of multi_vec)
Teuchos::RCP<Epetra_Map> domain_map;
}; // class EpetraMultiVectorOperator
} // namespace Stokhos
#endif // STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
|