Solver for a system of equations. More...
#include <Solver.h>
Public Member Functions | |
| virtual int | solve (void)=0 |
| Causes the solver to compute the solution of the system of equations. More... | |
 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 | sendSelf (CommParameters &cp)=0 |
| Send the object. More... | |
| virtual int | recvSelf (const CommParameters &cp)=0 |
| Receive the object. 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 | |
| Solver (int classTag) | |
| Constructor. More... | |
Detailed Description
Solver for a system of equations.
object is responsible for performing the numerical operations on its associated SystemOfEqn object.
Constructor & Destructor Documentation
§ Solver()
|
protected |
Constructor.
The integer classTag is passed to the base class constructor.
Member Function Documentation
§ solve()
|
pure virtual |
Causes the solver to compute the solution of the system of equations.
Return $0$ if successful , negative number if not; the actual value depending on the type of Solver.
Implemented in XC::SuperLU, XC::ItpackLinSolver, XC::DistributedSuperLU, XC::ProfileSPDLinDirectSkypackSolver, XC::ThreadedSuperLU, XC::PetscSolver, XC::PetscSparseSeqSolver, XC::ProfileSPDLinDirectThreadSolver, XC::UmfpackGenLinSolver, XC::ProfileSPDLinDirectBlockSolver, XC::ProfileSPDLinSubstrSolver, XC::FullGenEigenSolver, XC::ProfileSPDLinDirectSolver, XC::BandGenLinSolver, XC::BandSPDLinSolver, XC::ConjugateGradientSolver, XC::FullGenLinLapackSolver, XC::SymBandEigenSolver, XC::BandSPDLinLapackSolver, XC::BandGenLinLapackSolver, XC::BandSPDLinThreadSolver, XC::ProfileSPDLinSolver, XC::DistributedDiagonalSolver, XC::DiagonalSolver, XC::DiagonalDirectSolver, XC::BandArpackSolver, XC::EigenSolver, XC::SymArpackSolver, XC::SymSparseLinSolver, and XC::BandArpackppSolver.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/Solver.h
- src/solution/system_of_eqn/Solver.cpp
