FEI Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
fei::VectorTraits< FiniteElementData > Struct Reference

#include <fei_VectorTraits_FEData.hpp>

Inheritance diagram for fei::VectorTraits< FiniteElementData >:
Inheritance graph
[legend]

Static Public Member Functions

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

Detailed Description

specialization for FiniteElementData

Definition at line 23 of file fei_VectorTraits_FEData.hpp.

Member Function Documentation

◆ typeName() [1/2]

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

name of VectorTraits type

Definition at line 26 of file fei_VectorTraits_FEData.hpp.

◆ setValues() [1/2]

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

set all vector values to specified scalar

Definition at line 30 of file fei_VectorTraits_FEData.hpp.

◆ putValuesIn() [1/2]

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

sum-into operation for vector data

Definition at line 37 of file fei_VectorTraits_FEData.hpp.

◆ copyOut() [1/2]

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

copy out vector data

Definition at line 48 of file fei_VectorTraits_FEData.hpp.

◆ update() [1/2]

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

vec = b*vec + a*x

Definition at line 58 of file fei_VectorTraits_FEData.hpp.

◆ typeName() [2/2]

static const char * fei::VectorTraits< FiniteElementData >::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< FiniteElementData >::setValues ( FiniteElementData * vec,
int firstLocalOffset,
double scalar,
bool isSolnVector = false )
static

Set a specified scalar value throughout the vector.

◆ putValuesIn() [2/2]

static int fei::VectorTraits< FiniteElementData >::putValuesIn ( FiniteElementData * 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< FiniteElementData >::copyOut ( FiniteElementData * 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< FiniteElementData >::getLocalCoefsPtr ( FiniteElementData * 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< FiniteElementData >::update ( FiniteElementData * vec,
double a,
const FiniteElementData * x,
double b )
static

Update vec = b*vec + a*x

◆ globalAssemble()

static int fei::VectorTraits< FiniteElementData >::globalAssemble ( FiniteElementData * 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:
Generated by doxygen 1.13.2