BandGenLinSOE

class BandGenLinSOE : public LinearSOE

Inheritance:

Public Methods
BandGenLinSOE(BandGenLinSolver &theSolver)
BandGenLinSOE(int N, int numSuperDiagonals, int numSubDiagonal, BandGenLinSolver &theSolver)
~BandGenLinSOE()
int getNumEqn(void) const
int setSize(Graph &theGraph)
int addA(const Matrix &, const ID &, double fact = 1.0)
int addB(const Vector &, const ID &, double fact = 1.0)
int setB(const Vector &, double fact = 1.0)
void zeroA(void)
void zeroB(void)
const Vector& getX(void)
const Vector& getB(void)
double normRHS(void)
void setX(int loc, double value)
int setBandGenSolver(BandGenLinSolver &newSolver)
int sendSelf(int commitTag, Channel &theChannel)
int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

Inherited from LinearSOE:

Public Methods
virtual int solve(void)

Protected Methods
int setSolver(LinearSOESolver &newSolver)
LinearSOESolver* getSolver(void)

Inherited from SystemOfEqn:

Inherited from MovableObject:

Public Methods
int getClassTag(void) const
int getDbTag(void) const
void setDbTag(int dbTag)

Documentation

BandGenLinSOE is class which is used to store a banded unsymmetric system with kl subdiagonals and ku superdiagonals. The A matrix is stored in a 1d double array with (kl+ku+1)*n elements, where n is the size of the system. A_{i,j} is stored at location (ku+1+i-j) + j*(ku+1+kl), where i and j range from 0 ton-1, i.e. C notation. For example when n=5, kl = 2 and ku=1:
\left[ \begin{array}{ccccc} a_{0,0} & a_{0,1} & 0 & 0 & 0

BandGenLinSOE(BandGenLinSolver &theSolver)

BandGenLinSOE(int N, int numSuperDiagonals, int numSubDiagonal, BandGenLinSolver \&theSolver);

BandGenLinSOE(int N, int numSuperDiagonals, int numSubDiagonal, BandGenLinSolver &theSolver)

~BandGenLinSOE()

The solver and a unique class tag (defined in <classTags.h>) are passed to the LinearSOE constructor. The system size is set to 0 and the matrix A is marked as not having been factored. Invokes setLinearSOE(*this) on the theSolver. No memory is allocated for the 3 1d arrays.

int getNumEqn(void) const

A method which returns the current size of the system

int setSize(Graph &theGraph)

The size of the system is determined by looking at the adjacency ID of each Vertex in the Graph object G. This is done by first setting kl and ku equal to 0 and then checking for each Vertex in G, whether any of the vertex tags in the Vertices adjacency ID results in kl or ku being increased. Knowing kl, ku and the size of the system (the number of Vertices in G), a check to see if the previously allocated 1d arrays for A, x and b are large enough. If the memory portions allocated for the 1d arrays are not big enough, the old space is returned to the heap and new space is allocated from the heap. Prints a warning message if not enough memory is available on the heap for the 1d arrays and returns a -1. If memory is available, the components of the arrays are zeroed and A is marked as being unfactored. If the system size has increased, new Vector objects for x and b using the (double ,int) Vector constructor are created. Finally, the result of invoking setSize() on the associated Solver object is returned.

int addA(const Matrix &, const ID &, double fact = 1.0)

First tests that loc and M are of compatible sizes; if not a warning message is printed and a -1 is returned. The LinearSOE object then assembles fact times the Matrix M into the matrix A. The Matrix is assembled into A at the locations given by the ID object loc, i.e. a_{loc(i),loc(j)} += fact * M(i,j). If the location specified is outside the range, i.e. (-1,-1) the corresponding entry in M is not added to A. If fact is equal to 0.0 or 1.0, more efficient steps are performed. Returns 0.

int addB(const Vector &, const ID &, double fact = 1.0)

First tests that loc and V are of compatible sizes; if not a warning message is printed and a -1 is returned. The LinearSOE object then assembles fact times the Vector V into the vector b. The Vector is assembled into b at the locations given by the ID object loc, i.e. b_{loc(i)} += fact * V(i). If a location specified is outside the range, e.g. -1, the corresponding entry in V is not added to b. If fact is equal to 0.0, 1.0 or -1.0, more efficient steps are performed. Returns 0.

int setB(const Vector &, double fact = 1.0)

First tests that V and the size of the system are of compatible sizes; if not a warning message is printed and a -1 is returned. The LinearSOE object then sets the vector b to be fact times the Vector V. If fact is equal to 0.0, 1.0 or -1.0, more efficient steps are performed. Returns 0.

void zeroA(void)