Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_OskiPermutation.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 // Author: Ian Karlin ikarlin@sandia.gov 05-28-2008
45 
46 #ifndef EPETRA_OSKIPERMUTATION_H
47 #define EPETRA_OSKIPERMUTATION_H
48 
49 #if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
50 #ifdef __GNUC__
51 #warning "The Epetra package is deprecated"
52 #endif
53 #endif
54 
55 
56 
57 #include "Epetra_OskiMatrix.h"
58 #include "Epetra_OskiMultiVector.h"
59 extern "C" {
60 #include "oski/oski.h"
61 }
62 
64 class Epetra_OskiMatrix;
65 
67 
72 //=========================================================================
74 
75  public:
76 
78 
79 
82 
86 
90  Epetra_OskiPermutation(bool RowPerm, const Epetra_OskiMatrix& Source);
91 
93  virtual ~Epetra_OskiPermutation();
95 
97 
98  void ReplacePermutation(const oski_perm_t& InPerm);
101 
102 
104 
105 
114  int PermuteVector(const bool TransA, Epetra_OskiMultiVector& Vector) const;
116 
117  protected:
118 
119  private:
120 
121  const oski_perm_t* Permutation_; //this might need to be const and a pointer
122 
123 };
124 
125 #endif /* EPETRA_OSKIPERMUTATION_H */
Epetra_OskiPermutation: A class for storing the permutation performed on a Epetra_OskiMatrix.
Epetra_OskiMultiVector: A class for constructing and using dense Oski multi-vectors on a single proce...
Epetra_OskiPermutation()
Default Constructor.
const oski_perm_t * Permutation_
void ReplacePermutation(const oski_perm_t &InPerm)
Stores a permutation in the data structure.
Epetra_OskiMatrix: A class for constructing and using OSKI Matrices within Epetra. For information on known issues with OSKI see the detailed description.
virtual ~Epetra_OskiPermutation()
Destructor.
int PermuteVector(const bool TransA, Epetra_OskiMultiVector &Vector) const
Permutes Vector according to the Permutation. If a transpose is desired it performs that operation...