Epetra Package Browser (Single Doxygen Collection)
Development
Toggle main menu visibility
Loading...
Searching...
No Matches
src
Epetra_SerialDenseOperator.h
Go to the documentation of this file.
1
/*
2
//@HEADER
3
// ************************************************************************
4
//
5
// Epetra: Linear Algebra Services Package
6
// Copyright 2011 Sandia Corporation
7
//
8
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9
// the U.S. Government retains certain rights in this software.
10
//
11
// Redistribution and use in source and binary forms, with or without
12
// modification, are permitted provided that the following conditions are
13
// met:
14
//
15
// 1. Redistributions of source code must retain the above copyright
16
// notice, this list of conditions and the following disclaimer.
17
//
18
// 2. Redistributions in binary form must reproduce the above copyright
19
// notice, this list of conditions and the following disclaimer in the
20
// documentation and/or other materials provided with the distribution.
21
//
22
// 3. Neither the name of the Corporation nor the names of the
23
// contributors may be used to endorse or promote products derived from
24
// this software without specific prior written permission.
25
//
26
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37
//
38
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39
//
40
// ************************************************************************
41
//@HEADER
42
*/
43
44
#ifndef _EPETRA_SERIALDENSEOPERATOR_H_
45
#define _EPETRA_SERIALDENSEOPERATOR_H_
46
47
#include "
Epetra_ConfigDefs.h
"
48
class
Epetra_SerialDenseMatrix
;
49
51
57
58
class
EPETRA_LIB_DLL_EXPORT
Epetra_SerialDenseOperator
{
59
60
public
:
61
63
64
65
virtual
~Epetra_SerialDenseOperator
() {};
67
69
70
72
81
virtual
int
SetUseTranspose
(
bool
UseTranspose
) = 0;
83
85
86
88
96
virtual
int
Apply
(
const
Epetra_SerialDenseMatrix
& X,
Epetra_SerialDenseMatrix
& Y) = 0;
97
99
108
virtual
int
ApplyInverse
(
const
Epetra_SerialDenseMatrix
& X,
Epetra_SerialDenseMatrix
& Y) = 0;
109
111
/* Returns the quantity \f$ \| A \|_\infty\f$ such that
112
\f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
113
114
\warning This method must not be called unless HasNormInf() returns true.
115
*/
116
virtual
double
NormInf
()
const
= 0;
118
120
121
123
virtual
const
char
*
Label
()
const
= 0;
124
126
virtual
bool
UseTranspose
()
const
= 0;
127
129
virtual
bool
HasNormInf
()
const
= 0;
130
132
virtual
int
RowDim
()
const
= 0;
133
135
virtual
int
ColDim
()
const
= 0;
137
138
};
139
140
#endif
/* _EPETRA_OPERATOR_H_ */
Epetra_ConfigDefs.h
Epetra_SerialDenseMatrix
Epetra_SerialDenseMatrix: A class for constructing and using real double precision general dense matr...
Definition
Epetra_SerialDenseMatrix.h:107
Epetra_SerialDenseOperator
Epetra_SerialDenseOperator: A pure virtual class for using real-valued double-precision operators.
Definition
Epetra_SerialDenseOperator.h:58
Epetra_SerialDenseOperator::UseTranspose
virtual bool UseTranspose() const =0
Returns the current UseTranspose setting.
Epetra_SerialDenseOperator::RowDim
virtual int RowDim() const =0
Returns the row dimension of operator.
Epetra_SerialDenseOperator::~Epetra_SerialDenseOperator
virtual ~Epetra_SerialDenseOperator()
Destructor.
Definition
Epetra_SerialDenseOperator.h:65
Epetra_SerialDenseOperator::ApplyInverse
virtual int ApplyInverse(const Epetra_SerialDenseMatrix &X, Epetra_SerialDenseMatrix &Y)=0
Returns the result of a Epetra_SerialDenseOperator inverse applied to an Epetra_SerialDenseMatrix X i...
Epetra_SerialDenseOperator::HasNormInf
virtual bool HasNormInf() const =0
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Epetra_SerialDenseOperator::Apply
virtual int Apply(const Epetra_SerialDenseMatrix &X, Epetra_SerialDenseMatrix &Y)=0
Returns the result of a Epetra_SerialDenseOperator applied to a Epetra_SerialDenseMatrix X in Y.
Epetra_SerialDenseOperator::NormInf
virtual double NormInf() const =0
Returns the infinity norm of the global matrix.
Epetra_SerialDenseOperator::ColDim
virtual int ColDim() const =0
Returns the column dimension of operator.
Epetra_SerialDenseOperator::Label
virtual const char * Label() const =0
Returns a character string describing the operator.
Epetra_SerialDenseOperator::SetUseTranspose
virtual int SetUseTranspose(bool UseTranspose)=0
If set true, transpose of this operator will be applied.
Generated by
1.17.0