EpetraExt Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
EpetraExt::Perm_traits< Epetra_MultiVector > Struct Reference

A specialization of Perm_traits for the specific type Epetra_MultiVector. More...

#include <EpetraExt_Permutation_impl.h>

Inheritance diagram for EpetraExt::Perm_traits< Epetra_MultiVector >:

Static Public Member Functions

static const char * typeName ()
 typeName implementation
 
static Epetra_MultiVectorclone (Epetra_MultiVector *example, Epetra_DataAccess, const Epetra_BlockMap &map, int)
 clone implementation
 
static void replaceMap (Epetra_MultiVector *mvec, const Epetra_BlockMap &map)
 replaceMap implementation
 
static Epetra_MultiVectorproduceColumnPermutation (Permutation< Epetra_MultiVector > *, Epetra_MultiVector *)
 permute column-indices within a specified row, if applicable
 
static Epetra_MultiVectorproduceColumnPermutation (Permutation64< Epetra_MultiVector > *, Epetra_MultiVector *)
 permute column-indices within a specified row, if applicable
 
static const char * typeName ()
 return a std::string name for the object type
 
static Epetra_MultiVectorclone (Epetra_MultiVector *example, Epetra_DataAccess CV, const Epetra_BlockMap &map, int int_argument)
 clone function accepts an example of the object being cloned, and enough constructor arguments to be able to create any of these: CrsMatrix, CrsGraph, Vector, MultiVector.
 
static void replaceMap (Epetra_MultiVector *obj, const Epetra_BlockMap &map)
 replace the object's row-map (or if it's not a matrix, replace its only map)
 
static Epetra_MultiVectorproduceColumnPermutation (TPermutation< Epetra_MultiVector, int_type > *perm, Epetra_MultiVector *srcObj)
 return new object, which is a column-permutation of srcObj
 

Detailed Description

A specialization of Perm_traits for the specific type Epetra_MultiVector.

Definition at line 382 of file EpetraExt_Permutation_impl.h.

Member Function Documentation

◆ typeName() [1/2]

static const char * EpetraExt::Perm_traits< Epetra_MultiVector >::typeName ( )
inlinestatic

typeName implementation

Definition at line 385 of file EpetraExt_Permutation_impl.h.

◆ clone() [1/2]

static Epetra_MultiVector * EpetraExt::Perm_traits< Epetra_MultiVector >::clone ( Epetra_MultiVector * example,
Epetra_DataAccess ,
const Epetra_BlockMap & map,
int  )
inlinestatic

clone implementation

Definition at line 390 of file EpetraExt_Permutation_impl.h.

◆ replaceMap() [1/2]

static void EpetraExt::Perm_traits< Epetra_MultiVector >::replaceMap ( Epetra_MultiVector * mvec,
const Epetra_BlockMap & map )
inlinestatic

replaceMap implementation

Definition at line 400 of file EpetraExt_Permutation_impl.h.

◆ produceColumnPermutation() [1/3]

static Epetra_MultiVector * EpetraExt::Perm_traits< Epetra_MultiVector >::produceColumnPermutation ( Permutation< Epetra_MultiVector > * ,
Epetra_MultiVector *  )
inlinestatic

permute column-indices within a specified row, if applicable

Definition at line 406 of file EpetraExt_Permutation_impl.h.

◆ produceColumnPermutation() [2/3]

static Epetra_MultiVector * EpetraExt::Perm_traits< Epetra_MultiVector >::produceColumnPermutation ( Permutation64< Epetra_MultiVector > * ,
Epetra_MultiVector *  )
inlinestatic

permute column-indices within a specified row, if applicable

Definition at line 416 of file EpetraExt_Permutation_impl.h.

◆ typeName() [2/2]

static const char * EpetraExt::Perm_traits< Epetra_MultiVector >::typeName ( )
inlinestatic

return a std::string name for the object type

Definition at line 79 of file EpetraExt_Permutation_impl.h.

◆ clone() [2/2]

static Epetra_MultiVector * EpetraExt::Perm_traits< Epetra_MultiVector >::clone ( Epetra_MultiVector * example,
Epetra_DataAccess CV,
const Epetra_BlockMap & map,
int int_argument )
inlinestatic

clone function accepts an example of the object being cloned, and enough constructor arguments to be able to create any of these: CrsMatrix, CrsGraph, Vector, MultiVector.

And probably more later...

Why is an example object needed? For instance, if a MultiVector is created, we may want to know how many vectors it should contain...

Definition at line 89 of file EpetraExt_Permutation_impl.h.

◆ replaceMap() [2/2]

static void EpetraExt::Perm_traits< Epetra_MultiVector >::replaceMap ( Epetra_MultiVector * obj,
const Epetra_BlockMap & map )
inlinestatic

replace the object's row-map (or if it's not a matrix, replace its only map)

Definition at line 98 of file EpetraExt_Permutation_impl.h.

◆ produceColumnPermutation() [3/3]

static Epetra_MultiVector * EpetraExt::Perm_traits< Epetra_MultiVector >::produceColumnPermutation ( TPermutation< Epetra_MultiVector, int_type > * perm,
Epetra_MultiVector * srcObj )
inlinestatic

return new object, which is a column-permutation of srcObj

Definition at line 104 of file EpetraExt_Permutation_impl.h.


The documentation for this struct was generated from the following file: