Epetra_FEVector Class Reference

#include <Epetra_FEVector.h>

Inheritance diagram for Epetra_FEVector:

Collaboration diagram for Epetra_FEVector:

List of all members.

Public Member Functions
	Epetra_FEVector (const Epetra_BlockMap &Map, int numVectors=1, bool ignoreNonLocalEntries=false)
	Epetra_FEVector (Epetra_DataAccess CV, const Epetra_BlockMap &Map, double *A, int MyLDA, int NumVectors, bool ignoreNonLocalEntries=false)
	Set multi-vector values from two-dimensional array.
	Epetra_FEVector (Epetra_DataAccess CV, const Epetra_BlockMap &Map, double **ArrayOfPointers, int NumVectors, bool ignoreNonLocalEntries=false)
	Set multi-vector values from array of pointers.
	Epetra_FEVector (const Epetra_FEVector &source)
virtual	~Epetra_FEVector ()
int	SumIntoGlobalValues (int numIDs, const int *GIDs, const double *values, int vectorIndex=0)
int	SumIntoGlobalValues (const Epetra_IntSerialDenseVector &GIDs, const Epetra_SerialDenseVector &values, int vectorIndex=0)
int	ReplaceGlobalValues (int numIDs, const int *GIDs, const double *values, int vectorIndex=0)
int	ReplaceGlobalValues (const Epetra_IntSerialDenseVector &GIDs, const Epetra_SerialDenseVector &values, int vectorIndex=0)
int	SumIntoGlobalValues (int numIDs, const int *GIDs, const int *numValuesPerID, const double *values, int vectorIndex=0)
int	ReplaceGlobalValues (int numIDs, const int *GIDs, const int *numValuesPerID, const double *values, int vectorIndex=0)
int	GlobalAssemble (Epetra_CombineMode mode=Add, bool reuse_map_and_exporter=false)
void	setIgnoreNonLocalEntries (bool flag)
Epetra_FEVector &	operator= (const Epetra_FEVector &source)
Protected Member Functions
int	inputValues (int numIDs, const int *GIDs, const double *values, bool suminto, int vectorIndex)
int	inputValues (int numIDs, const int *GIDs, const int *numValuesPerID, const double *values, bool suminto, int vectorIndex)
int	inputNonlocalValue (int GID, double value, bool suminto, int vectorIndex)
int	inputNonlocalValues (int GID, int numValues, const double *values, bool suminto, int vectorIndex)
void	createNonlocalMapAndExporter ()
void	destroyNonlocalMapAndExporter ()
void	zeroNonlocalData ()
void	destroyNonlocalData ()
Protected Attributes
int	myFirstID_
int	myNumIDs_
int *	nonlocalIDs_
int *	nonlocalElementSize_
int	numNonlocalIDs_
int	numNonlocalIDsAlloc_
double **	nonlocalCoefs_
int	numNonlocalCoefs_
int	numNonlocalCoefsAlloc_
Epetra_BlockMap *	nonlocalMap_
Epetra_Export *	exporter_
Epetra_MultiVector *	nonlocalVector_
bool	ignoreNonLocalEntries_

---

Detailed Description

Epetra Finite-Element Vector. This class inherits Epetra_MultiVector and thus provides all Epetra_MultiVector functionality.

The added functionality provided by Epetra_FEVector is the ability to perform finite-element style vector assembly. It accepts sub-vector contributions, such as those that would come from element-load vectors, etc., and these sub-vectors need not be owned by the local processor. In other words, the user can assemble overlapping data (e.g., corresponding to shared finite-element nodes). When the user is finished assembling their vector data, they then call the method Epetra_FEVector::GlobalAssemble() which gathers the overlapping data (all non-local data that was input on each processor) into the data-distribution specified by the map that the Epetra_FEVector is constructed with.

---

Constructor & Destructor Documentation

Epetra_FEVector::Epetra_FEVector	(	const Epetra_BlockMap &	Map,
		int	numVectors = 1,
		bool	ignoreNonLocalEntries = false
	)

Constructor that requires a map specifying a non-overlapping data layout.

Parameters:

Map	Map describing a non-overlapping distribution for the underlying Epetra_MultiVector that this Epetra_FEVector will be funnelling data into.
numVectors	Optional argument, default value is 1. (See the documentation for Epetra_MultiVector for the meaning of this argument.
ignoreNonLocalEntries	Optional argument, default value is false. Under certain special circumstances it is desirable to have non-local contributions ignored rather than saving them for the GlobalAssemble step.

Epetra_FEVector::Epetra_FEVector	(	Epetra_DataAccess	CV,
		const Epetra_BlockMap &	Map,
		double *	A,
		int	MyLDA,
		int	NumVectors,
		bool	ignoreNonLocalEntries = false
	)

Set multi-vector values from two-dimensional array.

Parameters:

In	Epetra_DataAccess - Enumerated type set to Copy or View.
In	Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap.
In	A - Pointer to an array of double precision numbers. The first vector starts at A. The second vector starts at A+MyLDA, the third at A+2*MyLDA, and so on.
In	MyLDA - The "Leading Dimension", or stride between vectors in memory.

Warning:

This value refers to the stride on the calling processor. Thus it is a local quantity, not a global quantity.

Parameters:

In	NumVectors - Number of vectors in multi-vector.

Returns:

Integer error code, set to 0 if successful.

See Detailed Description section for further discussion.

Epetra_FEVector::Epetra_FEVector	(	Epetra_DataAccess	CV,
		const Epetra_BlockMap &	Map,
		double **	ArrayOfPointers,
		int	NumVectors,
		bool	ignoreNonLocalEntries = false
	)

Set multi-vector values from array of pointers.

Parameters:

In	Epetra_DataAccess - Enumerated type set to Copy or View.
In	Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap.
In	ArrayOfPointers - An array of pointers such that ArrayOfPointers[i] points to the memory location containing ith vector to be copied.
In	NumVectors - Number of vectors in multi-vector.

Returns:

Integer error code, set to 0 if successful.

See Detailed Description section for further discussion.

Epetra_FEVector::Epetra_FEVector

(

const Epetra_FEVector &

source

)

Copy constructor.

virtual Epetra_FEVector::~Epetra_FEVector

(

)

[virtual]

Destructor

---

Member Function Documentation

int Epetra_FEVector::GlobalAssemble	(	Epetra_CombineMode	mode = Add,
		bool	reuse_map_and_exporter = false
	)

Gather any overlapping/shared data into the non-overlapping partitioning defined by the Map that was passed to this vector at construction time. Data imported from other processors is stored on the owning processor with a "sumInto" or accumulate operation. This is a collective method -- every processor must enter it before any will complete it.

Optimization for power-users: The optional parameter 'reuse_map_and_exporter' defaults to false. By default, a map that describes the non-local data is re-created at each call to GlobalAssemble, along with an exporter used to do the communication. This is expensive. If you know that the layout of your nonlocal data has not changed since your previous call to GlobalAssemble, you can set this flag to true and it will reuse the previously created map and exporter rather than creating new ones.

int Epetra_FEVector::ReplaceGlobalValues	(	const Epetra_IntSerialDenseVector &	GIDs,
		const Epetra_SerialDenseVector &	values,
		int	vectorIndex = 0
	)

Copy values into the vector, replacing any values that already exist for the specified GIDs.

Parameters:

GIDs	List of global ids. Must be the same length as the accompanying list of values.
values	List of coefficient values. Must be the same length as the accompanying list of GIDs.

int Epetra_FEVector::ReplaceGlobalValues	(	int	numIDs,
		const int *	GIDs,
		const double *	values,
		int	vectorIndex = 0
	)

Copy values into the vector overwriting any values that already exist for the specified indices.

void Epetra_FEVector::setIgnoreNonLocalEntries

(

bool

flag

)

[inline]

Set whether or not non-local data values should be ignored.

int Epetra_FEVector::SumIntoGlobalValues	(	const Epetra_IntSerialDenseVector &	GIDs,
		const Epetra_SerialDenseVector &	values,
		int	vectorIndex = 0
	)

Accumulate values into the vector, adding them to any values that already exist for the specified GIDs.

Parameters:

GIDs	List of global ids. Must be the same length as the accompanying list of values.
values	List of coefficient values. Must be the same length as the accompanying list of GIDs.

int Epetra_FEVector::SumIntoGlobalValues	(	int	numIDs,
		const int *	GIDs,
		const double *	values,
		int	vectorIndex = 0
	)

Accumulate values into the vector, adding them to any values that already exist for the specified indices.

---

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

• Epetra_FEVector.h