LinearSOE

class LinearSOE : public SystemOfEqn

Inheritance:

Public Methods
LinearSOE(LinearSOESolver &theSolver, int classTag)
virtual ~LinearSOE()
virtual int solve(void)
virtual int setSize(Graph &theGraph)
virtual int getNumEqn(void) const
virtual int addA(const Matrix &, const ID &, double fact = 1.0)
virtual int addB(const Vector &, const ID &, double fact = 1.0)
virtual int setB(const Vector &, double fact = 1.0)
virtual void zeroA(void)
virtual void zeroB(void)
virtual const Vector& getX(void)
virtual const Vector& getB(void)
virtual double normRHS(void)
virtual void setX(int loc, double value)

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)
virtual int sendSelf(int commitTag, Channel &theChannel)
virtual int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

Documentation

LinearSOE is an abstract class. A LinearSOE object provides an abstraction of a system of linear equations. A linear system of equation of order n:
\begin{array}{ccccccccc} a_{0,0}x_0 & + & a_{0,1}x_1 & + & ... & + & a_{0,n-1}x_{n-1} & = & b_0

LinearSOE(LinearSOESolver &theSolver, int classTag)

The integer classTag is passed to the constructor for the SystemOfEqn. The constructor sets sets the pointer for the currently associated LinearSOESolver object to point to theSolver.

virtual ~LinearSOE()

Does nothing

virtual int solve(void)

Causes the SystemOfEqn object to invoke solve() on the currently associated LinearSOESolver object. Returns a 0 if successful, negative number if not; the actual value depending on the LinearSOESolver. To solve a linear system of equations means to find x such that the equation Ax=b is satisfied.

virtual int setSize(Graph &theGraph)

Invoked to allow the LinearSOE object to determine the size and sparsity of the matrix A and vectors x and b. This information can be deduced from the number of vertices and the connectivity between the vertices in the Graph object G. To return 0 if sucessfull, a negative number if not.

virtual int getNumEqn(void) const

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

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

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

virtual void zeroA(void)

virtual void zeroB(void)

virtual const Vector& getX(void)

virtual const Vector& getB(void)

virtual double normRHS(void)

virtual void setX(int loc, double value)

int setSolver(LinearSOESolver &newSolver)

LinearSOESolver* getSolver(void)