Lapack based band general matrix SOE solver. More...
#include <BandGenLinLapackSolver.h>
Public Member Functions | |
| BandGenLinLapackSolver (void) | |
| A unique class tag defined in classTags.h is passed to the BandGenLinSolver constructor. More... | |
| int | solve (void) |
| Performs the solution of the system of equations. More... | |
| int | setSize (void) |
| Sets the size of #iPiv. More... | |
| int | sendSelf (CommParameters &) |
| Send the object. More... | |
| int | recvSelf (const CommParameters &) |
| Receive the object. More... | |
 Public Member Functions inherited from XC::BandGenLinSolver | |
| BandGenLinSolver (int classTag) | |
| Constructor. More... | |
| virtual bool | setLinearSOE (BandGenLinSOE &theSOE) |
sets up the link between the theBandGenSOE object and the BandGenLinSolver, that it is sets the pointer the subclasses use. More... | |
| Public Member Functions inherited from XC::LinearSOESolver | |
| virtual | ~LinearSOESolver (void) |
| Destructor. | |
| virtual double | getDeterminant (void) |
| Returns the determinant of the system matrix. | |
| 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. | |
Additional Inherited Members | |
| Protected Member Functions inherited from XC::BandGenLinSolver | |
| virtual bool | setLinearSOE (LinearSOE *theSOE) |
sets up the link between the soe object pointer and the BandGenLinSolver, that it is sets the pointer the subclasses use. More... | |
| Protected Member Functions inherited from XC::LinearSOESolver | |
| LinearSOESolver (int classTag=0) | |
| Constructor. More... | |
| Protected Member Functions inherited from XC::Solver | |
| Solver (int classTag) | |
| Constructor. More... | |
| Protected Attributes inherited from XC::BandGenLinSolver | |
| BandGenLinSOE * | theSOE |
Detailed Description
Lapack based band general matrix SOE solver.
A BandGenLinLapackSolver object can be constructed to solve a BandGenLinSOE object. It obtains the solution by making calls on the the LAPACK library. The class is defined to be a friend of the BandGenLinSOE class.
Constructor & Destructor Documentation
§ BandGenLinLapackSolver()
| XC::BandGenLinLapackSolver::BandGenLinLapackSolver | ( | void | ) |
A unique class tag defined in classTags.h is passed to the BandGenLinSolver constructor.
Member Function Documentation
§ 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.
§ setSize()
|
virtual |
Sets the size of #iPiv.
Is used to construct a 1d integer array, #iPiv that is needed by the LAPACK solvers. It checks to see if current size of #iPiv is large enough, if not resizes it. Returns 0 if sucessfull, prints a warning message and returns a -1 if not enough memory is available for this new array.
Implements XC::LinearSOESolver.
§ solve()
|
virtual |
Performs the solution of the system of equations.
The solver first copies the B vector into X and then solves the BandGenLinSOE system by calling the LAPACK routines dgbsv(), if the system is marked as not having been factored, and dgbtrs() if system is marked as having been factored. If the solution is successfully obtained, i.e. the LAPACK routines return 0 in the INFO argument, it marks the system has having been factored and returns $0$, otherwise it prints a warning message and returns INFO. The solve process changes A and X.
Implements XC::BandGenLinSolver.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/linearSOE/bandGEN/BandGenLinLapackSolver.h
- src/solution/system_of_eqn/linearSOE/bandGEN/BandGenLinLapackSolver.cpp
