ITPACK based systems of equations. More...
#include <ItpackLinSOE.h>
Public Member Functions | |
| int | setSize (Graph &theGraph) |
| Sets the size of the system from the number of vertices in the graph. | |
| int | addA (const Matrix &, const ID &, double fact=1.0) |
The LinearSOE object assembles fact times the Matrix M into the matrix $A$. More... | |
| void | zeroA (void) |
| To zero the matrix $A$, i.e. set all the components of $A$ to $0$. | |
| int | sendSelf (CommParameters &) |
| Send the object. More... | |
| int | recvSelf (const CommParameters &) |
| Receive the object. More... | |
 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 Vector & | getX (void) const |
| Returns the Vector object created for \(x\). | |
| virtual Vector & | getX (void) |
| Returns the Vector object created for \(x\). | |
| virtual const Vector & | getB (void) const |
| Returns the Vector object created for \(b\). | |
| virtual Vector & | getB (void) |
| Returns the Vector object created for \(b\). | |
| virtual double | normRHS (void) const |
| Returns the 2-norm of the vector \(x\). | |
| void | receiveB (const CommParameters &) |
| void | receiveX (const CommParameters &) |
| void | receiveBX (const CommParameters &) |
| void | sendB (CommParameters &) const |
| void | sendBX (CommParameters &) 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. | |
| LinearSOESolver * | getSolver (void) |
| Returns a pointer to the solver. | |
| LinearSOESolver & | newSolver (const std::string &) |
| Public Member Functions inherited from XC::SystemOfEqn | |
| int | checkSize (Graph &theGraph) const |
| Check number of DOFs in the graph. | |
| 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. | |
| MovableObject & | operator= (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 (CommParameters &) |
| Return the object identifier in the database. | |
| void | setDbTag (int dbTag) |
| Sets the object identifier in the database. | |
| void | setDbTag (CommParameters &) |
| Sets the object identifier in the database if not already set. More... | |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
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 DbTagData & | getDbTagData (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... | |
| ItpackLinSOE (AnalysisAggregation *) | |
| SystemOfEqn * | getCopy (void) const |
| Virtual constructor. | |
| 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 AnalysisModel * | getAnalysisModelPtr (void) |
| Returns a pointer to the analysis model. | |
| virtual const AnalysisModel * | getAnalysisModelPtr (void) const |
| Returns a const pointer to the analysis model. | |
| SystemOfEqn (AnalysisAggregation *, int classTag) | |
| Constructor. More... | |
Friends | |
| class | AnalysisAggregation |
| class | ItpackLinSolver |
Additional Inherited Members | |
| Protected Attributes inherited from XC::LinearSOEData | |
| int | size |
| Vector | B |
| order of A | |
| Vector | X |
Detailed Description
ITPACK based systems of equations.
Member Function Documentation
§ addA()
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 sucessfull, a negative number if not.
Implements XC::LinearSOE.
§ recvSelf()
|
virtual |
Receive the object.
Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.
Implements XC::MovableObject.
§ sendSelf()
|
virtual |
Send the object.
Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.
Implements XC::MovableObject.
§ setSolver()
|
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$.
Reimplemented from XC::LinearSOE.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/linearSOE/itpack/ItpackLinSOE.h
- src/solution/system_of_eqn/linearSOE/itpack/ItpackLinSOE.cpp
