Epetra_FEVbrMatrix Class Reference

#include <Epetra_FEVbrMatrix.h>

Inheritance diagram for Epetra_FEVbrMatrix:

Inheritance graph
[legend]
Collaboration diagram for Epetra_FEVbrMatrix:

Collaboration graph
[legend]
List of all members.

Insertion/Replace/SumInto methods

Epetra_FEVbrMatrixoperator= (const Epetra_FEVbrMatrix &src)
int PutScalar (double ScalarConstant)
 Initialize all values in graph of the matrix with constant value.
int BeginInsertGlobalValues (int BlockRow, int NumBlockEntries, int *BlockIndices)
 Initiate insertion of a list of elements in a given global row of the matrix, values are inserted via SubmitEntry().
int BeginReplaceGlobalValues (int BlockRow, int NumBlockEntries, int *BlockIndices)
 Initiate replacement of current values with this list of entries for a given global row of the matrix, values are replaced via SubmitEntry().
int BeginSumIntoGlobalValues (int BlockRow, int NumBlockEntries, int *BlockIndices)
 Initiate summing into current values with this list of entries for a given global row of the matrix, values are replaced via SubmitEntry().
int SubmitBlockEntry (double *Values, int LDA, int NumRows, int NumCols)
 Submit a block entry to the indicated block row and column specified in the Begin routine.
int EndSubmitEntries ()
 Completes processing of all data passed in for the current block row.
int GlobalAssemble (bool callFillComplete=true)

Public Member Functions

Constructors/Destructor
 Epetra_FEVbrMatrix (Epetra_DataAccess CV, const Epetra_BlockMap &RowMap, int *NumBlockEntriesPerRow, bool ignoreNonLocalEntries=false)
 Epetra_FEVbrMatrix constuctor with variable number of indices per row.
 Epetra_FEVbrMatrix (Epetra_DataAccess CV, const Epetra_BlockMap &RowMap, int NumBlockEntriesPerRow, bool ignoreNonLocalEntries=false)
 Epetra_FEVbrMatrix constuctor with fixed number of indices per row.
 Epetra_FEVbrMatrix (Epetra_DataAccess CV, const Epetra_BlockMap &RowMap, const Epetra_BlockMap &ColMap, int *NumBlockEntriesPerRow, bool ignoreNonLocalEntries=false)
 Epetra_FEVbrMatrix constuctor with variable number of indices per row.
 Epetra_FEVbrMatrix (Epetra_DataAccess CV, const Epetra_BlockMap &RowMap, const Epetra_BlockMap &ColMap, int NumBlockEntriesPerRow, bool ignoreNonLocalEntries=false)
 Epetra_FEVbrMatrix constuctor with fixed number of indices per row.
 Epetra_FEVbrMatrix (Epetra_DataAccess CV, const Epetra_CrsGraph &Graph, bool ignoreNonLocalEntries=false)
 Epetra_FEVbrMatrix (const Epetra_FEVbrMatrix &src)
virtual ~Epetra_FEVbrMatrix ()
 Epetra_VbrMatrix Destructor.

Detailed Description

Epetra Finite-Element VbrMatrix. This class provides the ability to input finite-element style sub-matrix data, including sub-matrices with non-local rows (which could correspond to shared finite-element nodes for example). This class inherits Epetra_VbrMatrix, and so all Epetra_VbrMatrix functionality is also available.


Constructor & Destructor Documentation

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( Epetra_DataAccess  CV,
const Epetra_BlockMap RowMap,
int *  NumBlockEntriesPerRow,
bool  ignoreNonLocalEntries = false 
)

Epetra_FEVbrMatrix constuctor with variable number of indices per row.

Creates a Epetra_FEVbrMatrix object and allocates storage.

Parameters:
In CV - A Epetra_DataAccess enumerated type set to Copy or View.
In RowMap - A Epetra_BlockMap listing the block rows that this processor will contribute to.
In NumBlockEntriesPerRow - An integer array of length NumRows such that NumBlockEntriesPerRow[i] indicates the (approximate) number of Block entries in the ith row.

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( Epetra_DataAccess  CV,
const Epetra_BlockMap RowMap,
int  NumBlockEntriesPerRow,
bool  ignoreNonLocalEntries = false 
)

Epetra_FEVbrMatrix constuctor with fixed number of indices per row.

Creates a Epetra_FEVbrMatrix object and allocates storage.

Parameters:
In CV - A Epetra_DataAccess enumerated type set to Copy or View.
In RowMap - An Epetra_BlockMap listing the block rows that this processor will contribute to.
In NumBlockEntriesPerRow - An integer that indicates the (approximate) number of Block entries in the each Block row. Note that it is possible to use 0 for this value and let fill occur during the insertion phase.

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( Epetra_DataAccess  CV,
const Epetra_BlockMap RowMap,
const Epetra_BlockMap ColMap,
int *  NumBlockEntriesPerRow,
bool  ignoreNonLocalEntries = false 
)

Epetra_FEVbrMatrix constuctor with variable number of indices per row.

Creates a Epetra_FEVbrMatrix object and allocates storage.

Parameters:
In CV - A Epetra_DataAccess enumerated type set to Copy or View.
In RowMap - A Epetra_BlockMap listing the block rows that this processor will contribute to.
In ColMap - A Epetra_BlockMap listing the block columns to be contained on this processor.
In NumBlockEntriesPerRow - An integer array of length NumRows such that NumBlockEntriesPerRow[i] indicates the (approximate) number of Block entries in the ith row.

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( Epetra_DataAccess  CV,
const Epetra_BlockMap RowMap,
const Epetra_BlockMap ColMap,
int  NumBlockEntriesPerRow,
bool  ignoreNonLocalEntries = false 
)

Epetra_FEVbrMatrix constuctor with fixed number of indices per row.

Creates a Epetra_FEVbrMatrix object and allocates storage.

Parameters:
In CV - A Epetra_DataAccess enumerated type set to Copy or View.
In RowMap - An Epetra_BlockMap listing the block rows that this processor will contribute to.
In ColMap - An Epetra_BlockMap listing the block columns to be contained on this processor.
In NumBlockEntriesPerRow - An integer that indicates the (approximate) number of Block entries in the each Block row. Note that it is possible to use 0 for this value and let fill occur during the insertion phase.

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( Epetra_DataAccess  CV,
const Epetra_CrsGraph Graph,
bool  ignoreNonLocalEntries = false 
)

Constructor with pre-constructed Graph.

Epetra_FEVbrMatrix::Epetra_FEVbrMatrix ( const Epetra_FEVbrMatrix src  ) 

Copy Constructor.


Member Function Documentation

int Epetra_FEVbrMatrix::BeginInsertGlobalValues ( int  BlockRow,
int  NumBlockEntries,
int *  BlockIndices 
)

Initiate insertion of a list of elements in a given global row of the matrix, values are inserted via SubmitEntry().

Parameters:
In BlockRow - Block Row number (in global coordinates) to put elements.
In NumBlockEntries - Number of entries.
In Indices - Global column indices corresponding to values.
Returns:
Integer error code, set to 0 if successful.

Reimplemented from Epetra_VbrMatrix.

int Epetra_FEVbrMatrix::BeginReplaceGlobalValues ( int  BlockRow,
int  NumBlockEntries,
int *  BlockIndices 
)

Initiate replacement of current values with this list of entries for a given global row of the matrix, values are replaced via SubmitEntry().

Parameters:
In Row - Block Row number (in global coordinates) to put elements.
In NumBlockEntries - Number of entries.
In Indices - Global column indices corresponding to values.
Returns:
Integer error code, set to 0 if successful.

Reimplemented from Epetra_VbrMatrix.

int Epetra_FEVbrMatrix::BeginSumIntoGlobalValues ( int  BlockRow,
int  NumBlockEntries,
int *  BlockIndices 
)

Initiate summing into current values with this list of entries for a given global row of the matrix, values are replaced via SubmitEntry().

Parameters:
In Row - Block Row number (in global coordinates) to put elements.
In NumBlockEntries - Number of entries.
In Indices - Global column indices corresponding to values.
Returns:
Integer error code, set to 0 if successful.

Reimplemented from Epetra_VbrMatrix.

int Epetra_FEVbrMatrix::EndSubmitEntries (  ) 

Completes processing of all data passed in for the current block row.

This function completes the processing of all block entries submitted via SubmitBlockEntry(). It also checks to make sure that SubmitBlockEntry was called the correct number of times as specified by the Begin routine that initiated the entry process.

Reimplemented from Epetra_VbrMatrix.

int Epetra_FEVbrMatrix::PutScalar ( double  ScalarConstant  ) 

Initialize all values in graph of the matrix with constant value.

Parameters:
In ScalarConstant - Value to use.
Returns:
Integer error code, set to 0 if successful.

Reimplemented from Epetra_VbrMatrix.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:23:29 2010 for Epetra by  doxygen 1.4.7