fei::VectorTraits< CSVec > Struct Reference

#include <fei_VectorTraits_CSVec.hpp>

Inheritance diagram for fei::VectorTraits< CSVec >:

Static Public Member Functions
static const char *	typeName ()
static int	setValues (CSVec *vec, int firstLocalOffset, double scalar, bool isSolnVector=false)
static int	putValuesIn (CSVec *vec, int firstLocalOffset, int numValues, const int *indices, const double *values, bool sum_into, bool isSolnVector=false, int vectorIndex=0)
static int	copyOut (CSVec *vec, int firstLocalOffset, int numValues, const int *indices, double *values, bool isSolnVector=false, int vectorIndex=0)
static int	update (CSVec *vec, double a, const CSVec *x, double b)
static const char *	typeName ()
static int	setValues (CSVec *vec, int firstLocalOffset, double scalar, bool isSolnVector=false)
static int	putValuesIn (CSVec *vec, int firstLocalOffset, int numValues, const int *indices, const double *values, bool sum_into, bool isSolnVector=false, int vectorIndex=0)
static int	copyOut (CSVec *vec, int firstLocalOffset, int numValues, const int *indices, double *values, bool isSolnVector=false, int vectorIndex=0)
static double *	getLocalCoefsPtr (CSVec *vec, bool isSolnVector=false, int vectorIndex=0)
static int	update (CSVec *vec, double a, const CSVec *x, double b)
static int	globalAssemble (CSVec *vec)

Detailed Description

Definition at line 52 of file fei_VectorTraits_CSVec.hpp.

Member Function Documentation

typeName() [1/2]

static const char * fei::VectorTraits< CSVec >::typeName ( )

inlinestatic

Definition at line 53 of file fei_VectorTraits_CSVec.hpp.

setValues() [1/2]

static int fei::VectorTraits< CSVec >::setValues ( CSVec * vec, int firstLocalOffset, double scalar, bool isSolnVector = false )

inlinestatic

Definition at line 56 of file fei_VectorTraits_CSVec.hpp.

References fei::set_values().

putValuesIn() [1/2]

static int fei::VectorTraits< CSVec >::putValuesIn ( CSVec * vec, int firstLocalOffset, int numValues, const int * indices, const double * values, bool sum_into, bool isSolnVector = false, int vectorIndex = 0 )

inlinestatic

Definition at line 63 of file fei_VectorTraits_CSVec.hpp.

References fei::add_entry(), and fei::put_entry().

copyOut() [1/2]

static int fei::VectorTraits< CSVec >::copyOut ( CSVec * vec, int firstLocalOffset, int numValues, const int * indices, double * values, bool isSolnVector = false, int vectorIndex = 0 )

inlinestatic

Definition at line 86 of file fei_VectorTraits_CSVec.hpp.

References fei::get_entry().

update() [1/2]

static int fei::VectorTraits< CSVec >::update ( CSVec * vec, double a, const CSVec * x, double b )

inlinestatic

Definition at line 101 of file fei_VectorTraits_CSVec.hpp.

typeName() [2/2]

static const char * fei::VectorTraits< CSVec >::typeName ( )

static

Return a string type-name for the underlying vector. May appear in debug-output logs, etc. Does not need to exactly correspond to the type, but should be descriptive.

setValues() [2/2]

static int fei::VectorTraits< CSVec >::setValues ( CSVec * vec, int firstLocalOffset, double scalar, bool isSolnVector = false )

static

Set a specified scalar value throughout the vector.

putValuesIn() [2/2]

static int fei::VectorTraits< CSVec >::putValuesIn ( CSVec * vec, int firstLocalOffset, int numValues, const int * indices, const double * values, bool sum_into, bool isSolnVector = false, int vectorIndex = 0 )

static

Put values into the vector. If the 'sum_into' argument is true, then values are added to any values that already exist at the specified indices. If the 'sum_into' argument is false, then incoming values will overwrite any that may already exist at the specified indices. See general comments at the top of this struct regarding the 'isSolnVector' argument.

copyOut() [2/2]

static int fei::VectorTraits< CSVec >::copyOut ( CSVec * vec, int firstLocalOffset, int numValues, const int * indices, double * values, bool isSolnVector = false, int vectorIndex = 0 )

static

Copy values for the specified indices out into the user-allocated array 'values'.

getLocalCoefsPtr()

static double * fei::VectorTraits< CSVec >::getLocalCoefsPtr ( CSVec * vec, bool isSolnVector = false, int vectorIndex = 0 )

static

Get a pointer to the vector object's local coefficients array. Vector objects that can't support this can return NULL.

update() [2/2]

static int fei::VectorTraits< CSVec >::update ( CSVec * vec, double a, const CSVec * x, double b )

static

Update vec = b*vec + a*x

globalAssemble()

static int fei::VectorTraits< CSVec >::globalAssemble ( CSVec * vec )

static

Perform global communication or whatever operations may be necessary to complete the assembly of the vector. Most vector objects will do nothing here. Vectors such as the Epetra_FEVector object may do some operations here.

---

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

• fei_VectorTraits_CSVec.hpp