Base class for conjugate gradient linear SOE solvers. More...
#include <ConjugateGradientSolver.h>
Inheritance diagram for XC::ConjugateGradientSolver:
Public Member Functions | |
| virtual int | setSize (void) |
| Sets the number of equations. More... | |
| virtual int | solve (void) |
| Causes the solver to compute the solution of the system of equations. More... | |
| virtual int | formAp (const Vector &p, Vector &Ap)=0 |
 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 | 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. | |
Additional Inherited Members | |
| Protected Member Functions inherited from XC::LinearSOESolver | |
| LinearSOESolver (int classTag=0) | |
| Constructor. More... | |
| virtual LinearSOESolver * | getCopy (void) const =0 |
| Virtual constructor. | |
| virtual bool | setLinearSOE (LinearSOE *theSOE)=0 |
| Sets the systems of equations to solve. | |
| Protected Member Functions inherited from XC::Solver | |
| Solver (int classTag) | |
| Constructor. More... | |
Detailed Description
Base class for conjugate gradient linear SOE solvers.
Member Function Documentation
§ setSize()
|
virtual |
Sets the number of equations.
This is invoked by the LinearSOE object when setSize() has been invoked on it. Solvers may sometimes need to store additional data that needs to be updated if the size of the system of equation changes.
Implements XC::LinearSOESolver.
§ solve()
|
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.
Implements XC::Solver.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/linearSOE/cg/ConjugateGradientSolver.h
- src/solution/system_of_eqn/linearSOE/cg/ConjugateGradientSolver.cpp
