xc
XC::LinearSOE Class Referenceabstract

Linear system of equations. More...

#include <LinearSOE.h>

Inheritance diagram for XC::LinearSOE: ## Public Member Functions

virtual ~LinearSOE (void)
Destructor.

virtual int solve (void)
Computes the solution of the system of equations. More...

virtual int setSize (Graph &theGraph)=0
Determines and sets the size of the system. More...

virtual int getNumEqn (void) const =0
Returns the number of equations in the system.

virtual int addA (const Matrix &M, const ID &loc, double fact=1.0)=0
The LinearSOE object assembles fact times the Matrix M into the matrix $A$. More...

virtual int addB (const Vector &V, const ID &loc, const double &fact=1.0)=0
The LinearSOE object assembles fact times the Vector V into the vector $b$. More...

virtual int setB (const Vector &V, const double &fact=1.0)=0
The LinearSOE object sets the vector b to be fact times the vector V. More...

virtual void zeroA (void)=0
To zero the matrix $A$, i.e. More...

virtual void zeroB (void)=0
To zero the vector $b$, i.e. More...

virtual const VectorgetX (void) const =0
Return a const reference to the vector $x$.

virtual const VectorgetB (void) const =0
Return a const reference to the vector $b$.

virtual double getDeterminant (void)
Returns the determinant of the system matrix.

virtual double getRCond (const char &norm='1')
Returns the reciprocal of the condition number. More...

virtual double normRHS (void) const =0
Return the 2-norm of the vector $x$.

virtual void setX (int loc, double value)=0
The LinearSOE object is responsible for setting $x(loc) = value$. More...

virtual void setX (const Vector &X)=0
Sets the vector $x$.

LinearSOESolvergetSolver (void)
Returns a pointer to the solver.

LinearSOESolvernewSolver (const std::string &) Public Member Functions inherited from XC::SystemOfEqn
int checkSize (Graph &theGraph) const
Check number of DOFs in the graph.

virtual void save (void) const
Stores the matrices and vectors in a temporal file.

virtual void restore (void)
Restore the matrices and vectors from a temporal file. Public Member Functions inherited from XC::MovableObject
MovableObject (int classTag, int dbTag)
Constructor. More...

MovableObject (int classTag)
Constructor. More...

MovableObject (const MovableObject &)
Copy constructor. Doesn't copy the dbTag.

MovableObjectoperator= (const MovableObject &)
Assignment operator. Doesn't copy the dbTag.

int getClassTag (void) const
Return the class identifier.

int getDbTag (void) const
Return the object identifier in the database.

int getDbTag (Communicator &)
Return the object identifier in the database.

void setDbTag (int dbTag)
Sets the object identifier in the database.

void setDbTag (Communicator &)
Sets the object identifier in the database if not already set. More...

virtual int sendSelf (Communicator &comm)=0
Send the object. More...

virtual int recvSelf (const Communicator &comm)=0

virtual int setParameter (const std::vector< std::string > &argv, Parameter &param)
Sets the value param to the parameter argv.

virtual int updateParameter (int parameterID, Information &info)
Updates the parameter identified by parameterID with info.

virtual int activateParameter (int parameterID)
Activates the parameter identified by parameterID.

virtual int setVariable (const std::string &variable, Information &)
Set the value of the variable idenfified by var.

virtual int getVariable (const std::string &variable, Information &)
Return the value of the variable idenfified by var. Public Member Functions inherited from XC::DistributedBase
DistributedBase (void)
Constructor.

virtual ~DistributedBase (void)
Destructor.

virtual DbTagDatagetDbTagData (void) const
Returns a vector to store class dbTags.

const int & getDbTagDataPos (const int &i) const
Returns the data at the i-th position.

void setDbTagDataPos (const int &i, const int &v)
Sets the data at the i-th position.

void inicComm (const int &dataSize) const
Initializes communication.

## Protected Member Functions

virtual bool setSolver (LinearSOESolver *)
Sets the solver for the system of equations. More...

int setSolverSize (void)
invoke setSize() on the Solver

LinearSOE (AnalysisAggregation *, int classTag)
Constructor. More... Protected Member Functions inherited from XC::SystemOfEqn
virtual AnalysisModelgetAnalysisModelPtr (void)
Returns a pointer to the analysis model.

virtual const AnalysisModelgetAnalysisModelPtr (void) const
Returns a const pointer to the analysis model.

SystemOfEqn (AnalysisAggregation *, int classTag)
Constructor. More...

virtual SystemOfEqngetCopy (void) const =0
Virtual constructor.

## Friends

class FEM_ObjectBroker Protected Attributes inherited from XC::SystemOfEqn
std::string tmpFileName
File name to store matrices.

## Detailed Description

Linear system of equations.

Abstract base class and thus no objects of it's type can be instantiated. It has pure virtual functions which must be implemented in it's derived classes. LinearSystemOfEqn is an abstraction of the linear system of equation given by : [A]{X} = {B} - {C}, where A is a matrix and B,C and X are vectors. To solve the equation means given A, B and C to find the unknown X such that the equation is satisfied. LinearSOE object is responsible for storing these equations and for providing methods at the interface to set up and obtain the equations. Each LinearSOE object will be associated with a LinearSOESolver object. It is the LinearSOESolver objects that is responsible for solving the linear system of equations.

## § LinearSOE()

 XC::LinearSOE::LinearSOE ( AnalysisAggregation * owr, int classTag )
protected

Constructor.

Parameters
 owr analysis aggregation that owns this object. classTag identifier of the class.

## Member Function Documentation

 virtual int XC::LinearSOE::addA ( const Matrix & M, const ID & loc, double fact = 1.0 )
pure virtual

The LinearSOE object 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)}+= M(i,j)$. Numbering in $A$ starts at $(0,0)$, i.e. C style. If allocation specified is outside the range, i.e. $(-1,-1)$ the corresponding entry in M is not added to $A$. To return $0$ if successful, a negative number if not.

 virtual int XC::LinearSOE::addB ( const Vector & V, const ID & loc, const double & fact = 1.0 )
pure virtual

The LinearSOE object 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)} += V(i)$. If a location specified is outside the range, e.g. $-1$, the corresponding entry in {V} is not added to $b$. To return $0$ if successful, a negative number if not.

## § getRCond()

 double XC::LinearSOE::getRCond ( const char & norm = '1' )
virtual

Returns the reciprocal of the condition number.

Computes the reciprocal of the condition number using the norm specified by the char argument: if norm = '1' or 'O', then the routine estimates the condition number of matrix in 1-norm, if norm = 'I', then the routine estimates the condition number of matrix in infinity-norm.

## § setB()

 virtual int XC::LinearSOE::setB ( const Vector & V, const double & fact = 1.0 )
pure virtual

The LinearSOE object sets the vector b to be fact times the vector V.

To return $0$ if successful, a negative number if not.

## § setSize()

 virtual int XC::LinearSOE::setSize ( Graph & theGraph )
pure virtual

Determines and sets the size of the system.

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 theGraph. To return $0$ if successful, a negative number if not.

## § setSolver()

 bool XC::LinearSOE::setSolver ( LinearSOESolver * newSolver )
protectedvirtual

Sets the solver for the system of equations.

This is invoked to set the currently associated LinearSOESolver object to be newSolver. Each subclass will provide it's own variation of setSolver() method (needed so subclasses can verify type of Solver object passed). the subclasses in their variation of the setSolver() method (unless they wish to implement their own solve() method) invoke this method. Returns $0$.

## § setX()

 virtual void XC::LinearSOE::setX ( int loc, double value )
pure virtual

The LinearSOE object is responsible for setting $x(loc) = value$.

This is needed in domain decomposition methods and could be useful in iterative solution strategies when an initial approximation is known.

## § solve()

 int XC::LinearSOE::solve ( void )
virtual

Computes the solution of the system of equations.

Causes the SystemOfEqn object to invoke solve() on the currently associated solver 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.

Implements XC::SystemOfEqn.

## § zeroA()

 virtual void XC::LinearSOE::zeroA ( void )
pure virtual

To zero the matrix $A$, i.e.

set all the components of $A$ to $0$.

## § zeroB()

 virtual void XC::LinearSOE::zeroB ( void )
pure virtual

To zero the vector $b$, i.e.

set all the components of $b$ to $0$.