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

Solver for band matrix linear systems of equations. More...

#include <BandSPDLinSolver.h>

Inheritance diagram for XC::BandSPDLinSolver:
XC::LinearSOESolver XC::Solver XC::MovableObject XC::DistributedBase XC::BandSPDLinLapackSolver XC::BandSPDLinThreadSolver

Public Member Functions

virtual int solve (void)=0
 Causes the solver to compute the solution of the system of equations. More...
 
virtual bool setLinearSOE (BandSPDLinSOE &theSOE)
 Set up the link between the BandSPDLinSOE object and the BandSPDLinSolver, that it is sets the pointer the subclasses use. More...
 
- Public Member Functions inherited from XC::LinearSOESolver
virtual ~LinearSOESolver (void)
 Destructor.
 
virtual int setSize (void)=0
 Sets the number of equations. More...
 
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.
 
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 (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 &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 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

 BandSPDLinSolver (int classTag)
 Constructor. More...
 
virtual bool setLinearSOE (LinearSOE *theSOE)
 Set up the link between the BandSPDLinSOE object and the BandSPDLinSolver, that it is sets the pointer the subclasses use. More...
 
- Protected Member Functions inherited from XC::LinearSOESolver
 LinearSOESolver (int classTag=0)
 Constructor. More...
 
virtual LinearSOESolvergetCopy (void) const =0
 Virtual constructor.
 
- Protected Member Functions inherited from XC::Solver
 Solver (int classTag)
 Constructor. More...
 

Protected Attributes

BandSPDLinSOEtheSOE
 Pointer to the solver.
 

Detailed Description

Solver for band matrix linear systems of equations.

The BandSPDLinSolver class provides access for each subclass to the BandSPDLinSOE object through the pointer theSOE, which is a protected pointer.

Constructor & Destructor Documentation

§ BandSPDLinSolver()

XC::BandSPDLinSolver::BandSPDLinSolver ( int  classTag)
protected

Constructor.

Parameters
classTagclass identifier.

Member Function Documentation

§ setLinearSOE() [1/2]

bool XC::BandSPDLinSolver::setLinearSOE ( LinearSOE soe)
protectedvirtual

Set up the link between the BandSPDLinSOE object and the BandSPDLinSolver, that it is sets the pointer the subclasses use.

Implements XC::LinearSOESolver.

§ setLinearSOE() [2/2]

bool XC::BandSPDLinSolver::setLinearSOE ( BandSPDLinSOE theBandSPDSOE)
virtual

Set up the link between the BandSPDLinSOE object and the BandSPDLinSolver, that it is sets the pointer the subclasses use.

§ solve()

virtual int XC::BandSPDLinSolver::solve ( void  )
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.

Implements XC::Solver.

Implemented in XC::BandSPDLinLapackSolver, and XC::BandSPDLinThreadSolver.


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