EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
EpetraExt::TCrsGraph_MapColoringIndex< int_type > Class Template Reference

Generates a std::vector of Epetra_IntVector's to be used to map perturbation contributions to a CrsGraph/CrsMatrix from a perturbed vector. More...

#include <EpetraExt_TCrsGraph_MapColoringIndex.h>

Inheritance diagram for EpetraExt::TCrsGraph_MapColoringIndex< int_type >:
Inheritance graph
[legend]

Public Types

typedef StructuralTransform
< Epetra_CrsGraph, std::vector
< typename
Epetra_GIDTypeVector< int_type >
::impl > > 
Base
 
typedef Base::NewTypeRef NewTypeRef
 Generates a std::vector<Epetra_IntVector> from the input Epetra_CrsGraph. More...
 
typedef Base::OriginalTypeRef OriginalTypeRef
 
- Public Types inherited from EpetraExt::Transform< T, U >
typedef T OriginalType
 
typedef T * OriginalTypePtr
 
typedef Teuchos::RCP< T > OriginalTypeRCP
 
typedef T & OriginalTypeRef
 
typedef U NewType
 
typedef U * NewTypePtr
 
typedef Teuchos::RCP< U > NewTypeRCP
 
typedef U & NewTypeRef
 

Public Member Functions

NewTypeRef operator() (OriginalTypeRef orig)
 Analysis of transform operation on original object and construction of new object. More...
 
- Public Member Functions inherited from EpetraExt::StructuralTransform< Epetra_CrsGraph, std::vector< Epetra_GIDTypeVector< int_type >::impl > >
bool fwd ()
 Forward transfer of data from orig object input in the operator() method call to the new object created in this same call. More...
 
bool rvs ()
 Reverse transfer of data from new object created in the operator() method call to the orig object input to this same method. More...
 
virtual ~StructuralTransform ()
 
- Public Member Functions inherited from EpetraExt::Transform< T, U >
virtual ~Transform ()
 
virtual bool analyze (OriginalTypeRef orig)
 Initial analysis phase of transform. More...
 
virtual NewTypeRef construct ()
 Construction of new object as a result of the transform. More...
 
virtual bool isConstructed ()
 Check for whether transformed object has been constructed. More...
 

Protected Member Functions

 ~TCrsGraph_MapColoringIndex ()
 Destructor. More...
 
 TCrsGraph_MapColoringIndex (const Epetra_MapColoring &ColorMap)
 Constructor input param ColorMap defines the perturbation coloring. More...
 
- Protected Member Functions inherited from EpetraExt::Transform< T, U >
 Transform ()
 Default constructor, protected to allow only derived classes to use. More...
 

Private Attributes

const Epetra_MapColoringColorMap_
 

Additional Inherited Members

- Protected Attributes inherited from EpetraExt::Transform< T, U >
OriginalTypePtr origObj_
 
NewTypePtr newObj_
 

Detailed Description

template<typename int_type>
class EpetraExt::TCrsGraph_MapColoringIndex< int_type >

Generates a std::vector of Epetra_IntVector's to be used to map perturbation contributions to a CrsGraph/CrsMatrix from a perturbed vector.

Definition at line 63 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

Member Typedef Documentation

template<typename int_type>
typedef StructuralTransform< Epetra_CrsGraph,std::vector<typename Epetra_GIDTypeVector<int_type>::impl> > EpetraExt::TCrsGraph_MapColoringIndex< int_type >::Base

Definition at line 83 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

template<typename int_type>
typedef Base::NewTypeRef EpetraExt::TCrsGraph_MapColoringIndex< int_type >::NewTypeRef

Generates a std::vector<Epetra_IntVector> from the input Epetra_CrsGraph.

Definition at line 87 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

template<typename int_type>
typedef Base::OriginalTypeRef EpetraExt::TCrsGraph_MapColoringIndex< int_type >::OriginalTypeRef

Definition at line 88 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

Constructor & Destructor Documentation

template<typename int_type>
EpetraExt::TCrsGraph_MapColoringIndex< int_type >::~TCrsGraph_MapColoringIndex ( )
inlineprotected

Destructor.

Definition at line 73 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

template<typename int_type>
EpetraExt::TCrsGraph_MapColoringIndex< int_type >::TCrsGraph_MapColoringIndex ( const Epetra_MapColoring ColorMap)
inlineprotected

Constructor input param ColorMap defines the perturbation coloring.

Definition at line 79 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

Member Function Documentation

template<typename int_type >
TCrsGraph_MapColoringIndex< int_type >::NewTypeRef EpetraExt::TCrsGraph_MapColoringIndex< int_type >::operator() ( OriginalTypeRef  orig)
virtual

Analysis of transform operation on original object and construction of new object.

Preconditions:

Invariants:

Postconditions:

Returns
Returns a pointer to the newly created object of type NewTypeRef. The Transform object maintains ownership of this new object and deletes as a part of it's destruction.

Implements EpetraExt::Transform< T, U >.

Definition at line 97 of file EpetraExt_TCrsGraph_MapColoringIndex.h.

Member Data Documentation

template<typename int_type>
const Epetra_MapColoring& EpetraExt::TCrsGraph_MapColoringIndex< int_type >::ColorMap_
private

Definition at line 66 of file EpetraExt_TCrsGraph_MapColoringIndex.h.


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