xc
Public Member Functions | Protected Member Functions | Friends | List of all members

Base class for dense unsymmetric matrix systems of equations. More...

#include <FullGenLinSOE.h>

Inheritance diagram for XC::FullGenLinSOE:
XC::FactoredSOEBase XC::LinearSOEData XC::LinearSOE XC::SystemOfEqn XC::MovableObject XC::DistributedBase

Public Member Functions

int setSize (Graph &theGraph)
 Computes the size of the system from the graph data. More...
 
int addA (const Matrix &, const ID &, double fact=1.0)
 Assembles the product of the matrix and the factor on the system matrix. More...
 
void zeroA (void)
 Zeros the entries in the 1d array for \(A\) and marks the system as not having been factored. More...
 
int sendSelf (Communicator &)
 Sends objects through the communicator.
 
int recvSelf (const Communicator &)
 Receives objects through the communicator.
 
- Public Member Functions inherited from XC::LinearSOEData
virtual int getNumEqn (void) const
 Return the current size of the system.
 
virtual void zeroB (void)
 Zeros the entries in the 1d array for \(b\).
 
virtual void zeroX (void)
 Zeros the entries in the 1d array for \(x\).
 
virtual void zero (void)
 Zeros the entries in the 1d array for \(x\) and \(b\).
 
virtual int addB (const Vector &, const double &fact=1.0)
 add v multiplied by factor to vector B. More...
 
virtual int addB (const Vector &, const ID &, const double &fact=1.0)
 assemblies v multiplied by factor into vector B. More...
 
virtual int setB (const XC::Vector &v, const double &fact=1.0)
 Sets B= v*fact. More...
 
virtual void setX (int loc, double value)
 If loc is within the range of \(x\), sets \(x(loc) = value\).
 
virtual void setX (const Vector &x)
 Assigns \(x\).
 
virtual const VectorgetX (void) const
 Returns the Vector object created for \(x\).
 
virtual VectorgetX (void)
 Returns the Vector object created for \(x\).
 
virtual const VectorgetB (void) const
 Returns the Vector object created for \(b\).
 
virtual VectorgetB (void)
 Returns the Vector object created for \(b\).
 
virtual double normRHS (void) const
 Returns the 2-norm of the vector \(x\).
 
void receiveB (const Communicator &)
 
void receiveX (const Communicator &)
 
void receiveBX (const Communicator &)
 
void sendB (Communicator &) const
 
void sendBX (Communicator &) const
 
- Public Member Functions inherited from XC::LinearSOE
virtual ~LinearSOE (void)
 Destructor.
 
virtual int solve (void)
 Computes the solution of the system of equations. More...
 
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...
 
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 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 *)
 Checks if the solver has a suitable type and then it class its parent setSolver method. More...
 
 FullGenLinSOE (AnalysisAggregation *)
 Constructor. More...
 
 FullGenLinSOE (AnalysisAggregation *, int N)
 Constructor. More...
 
SystemOfEqngetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::FactoredSOEBase
 FactoredSOEBase (AnalysisAggregation *, int classTag, int N=0)
 Constructor. More...
 
- Protected Member Functions inherited from XC::LinearSOEData
void inic (const size_t &)
 1d arrays containing coefficients of B and X More...
 
const double & getB (const size_t &i) const
 
double & getB (const size_t &i)
 
const double & getX (const size_t &i) const
 
double & getX (const size_t &i)
 
double * getPtrB (void)
 
const double * getPtrB (void) const
 
double * getPtrX (void)
 
const double * getPtrX (void) const
 
 LinearSOEData (AnalysisAggregation *, int classTag, int N=0)
 Constructor. More...
 
- Protected Member Functions inherited from XC::LinearSOE
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...
 

Friends

class AnalysisAggregation
 
class FEM_ObjectBroker
 
class FullGenLinLapackSolver
 

Additional Inherited Members

- Protected Attributes inherited from XC::FactoredSOEBase
bool factored
 True if the system is factored.
 
- Protected Attributes inherited from XC::LinearSOEData
int size
 
Vector B
 order of A
 
Vector X
 
- Protected Attributes inherited from XC::SystemOfEqn
std::string tmpFileName
 File name to store matrices.
 

Detailed Description

Base class for dense unsymmetric matrix systems of equations.

FullGenLinSOE is class which is used to store a full general system. The \(A\) matrix is stored in a 1d double array with \(n*n\) elements, where \(n\) is the size of the system. \(A_{i,j}\) is stored at location \((i + j*(n)\), where \(i\) and \(j\) range from \(0\) to \(n-1\), i.e. C notation. For example when \(n=3\):

\(\) [ {array}{ccc} a_{0,0} & a_{0,1} & a_{0,2} a_{1,0} & a_{1,1} & a_{1,2} a_{2,0} & a_{2,1} & a_{2,2} {array} ] \(\)

is stored in:

\(\) [ {array}{cccccccccccccccccccc} a_{0,0} & a_{1,0} & a_{2,0} & a_{0,1} & a_{1,1} & a_{2,1} & a_{0,2} & a_{1,2} & a_{2,2} {array} ] \(\)

The \(x\) and \(b\) vectors are stored in 1d double arrays of length \(n\). To allow the solvers access to this data, the solvers that use this class are all declared as friend classes.

Constructor & Destructor Documentation

§ FullGenLinSOE() [1/2]

XC::FullGenLinSOE::FullGenLinSOE ( AnalysisAggregation owr)
protected

Constructor.

Parameters
owranalysis aggregation that owns this object.

§ FullGenLinSOE() [2/2]

XC::FullGenLinSOE::FullGenLinSOE ( AnalysisAggregation owr,
int  N 
)
protected

Constructor.

Parameters
owranalysis aggregation that owns this object.

Member Function Documentation

§ addA()

int XC::FullGenLinSOE::addA ( const Matrix m,
const ID id,
double  fact = 1.0 
)
virtual

Assembles the product of the matrix and the factor on the system matrix.

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\).

Implements XC::LinearSOE.

§ setSize()

int XC::FullGenLinSOE::setSize ( Graph theGraph)
virtual

Computes the size of the system from the graph data.

The size of the system is determined by invoking getNumVertex() on theGraph. If the old space allocated for the 1d arrays is not big enough, it the old space is returned to the heap and new space is allocated from the heap. Prints a warning message, sets size to \(0\) and returns a \(-1\), if not enough memory is available on the heap for the 1d arrays. 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.

Implements XC::LinearSOE.

§ setSolver()

bool XC::FullGenLinSOE::setSolver ( LinearSOESolver newSolver)
protectedvirtual

Checks if the solver has a suitable type and then it class its parent setSolver method.

Parameters
newSolversolver to use.

Reimplemented from XC::LinearSOE.

§ zeroA()

void XC::FullGenLinSOE::zeroA ( void  )
virtual

Zeros the entries in the 1d array for \(A\) and marks the system as not having been factored.

Implements XC::LinearSOE.


The documentation for this class was generated from the following files: