xc
Public Member Functions | List of all members

Skypakc based linear SOE solver. More...

#include <ProfileSPDLinDirectSkypackSolver.h>

Inheritance diagram for XC::ProfileSPDLinDirectSkypackSolver:
XC::ProfileSPDLinSolver XC::LinearSOESolver XC::Solver XC::MovableObject XC::DistributedBase

Public Member Functions

 ProfileSPDLinDirectSkypackSolver ()
 Default constructor. More...
 
 ProfileSPDLinDirectSkypackSolver (int mCols, int mRows)
 Constructor. More...
 
virtual LinearSOESolvergetCopy (void) const
 Virtual constructor.
 
virtual int solve (void)
 Solve the system of equations. More...
 
virtual int setSize (void)
 Set the size of the system. More...
 
virtual int setProfileSOE (ProfileSPDLinSOE &theSOE)
 
int sendSelf (CommParameters &)
 Send the object. More...
 
int recvSelf (const CommParameters &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::ProfileSPDLinSolver
virtual bool setLinearSOE (ProfileSPDLinSOE &theSOE)
 Sets the system of equations to solve.
 
- 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.
 
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 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.
 

Additional Inherited Members

- Protected Member Functions inherited from XC::ProfileSPDLinSolver
 ProfileSPDLinSolver (int classTag)
 Constructor. More...
 
virtual bool setLinearSOE (LinearSOE *theSOE)
 Sets the system of equations to solve.
 
- 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::ProfileSPDLinSolver
ProfileSPDLinSOEtheSOE
 

Detailed Description

Skypakc based linear SOE solver.

A ProfileSPDLinDirectSkypackSolver object can be constructed to solve a ProfileSPDLinSOE object. It does this by direct means using the routines supplied in the SKYPACK library, a library which uses the BLAS levels 1,2 and 3 for the factorization and substitution. The routines in SKYPACK require a number of work areas: {int block[3]} and {double invD[size]}. In addition, to allow the use of the BLAS 2 and 3, work areas {double rw[mRows x mCols]}, {double tw[mRows x mRows]} and {int index[max(mCols,mRows)]} are created.

Constructor & Destructor Documentation

§ ProfileSPDLinDirectSkypackSolver() [1/2]

XC::ProfileSPDLinDirectSkypackSolver::ProfileSPDLinDirectSkypackSolver ( void  )

Default constructor.

Sets mCols and mRows equal to \(0\) and does not try and allocate any memory for the work arrays.

§ ProfileSPDLinDirectSkypackSolver() [2/2]

XC::ProfileSPDLinDirectSkypackSolver::ProfileSPDLinDirectSkypackSolver ( int  Mcols,
int  Mrows 
)

Constructor.

Sets mCols and mRows and allocates space in memory for the work arrays rw, tw and index. If not enough memory is available in memory, mCols and mRows is set equal to \(0\) and an error message is printed.

Member Function Documentation

§ recvSelf()

int XC::ProfileSPDLinDirectSkypackSolver::recvSelf ( const CommParameters cp)
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()

int XC::ProfileSPDLinDirectSkypackSolver::sendSelf ( CommParameters cp)
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()

int XC::ProfileSPDLinDirectSkypackSolver::setSize ( void  )
virtual

Set the size of the system.

Is responsible for setting the block information required by the SKYPACK routines (block[0]=1; block[1]=size, block[2]=1) and for creating space for the invD work array. Returns \(0\) if successfull, otherwise a warning message is printed and a \(-1\) is returned.

Implements XC::LinearSOESolver.

§ solve()

int XC::ProfileSPDLinDirectSkypackSolver::solve ( void  )
virtual

Solve the system of equations.

The solver first copies the B vector into X and then solves the BandSPDLinSOE system. If the matrix has not been factored, the matrix is first factored using the SKYPACK routine skysf2(), if {mCols} and mRows equal \(0\), or skypf2()}. {skysf2() is a routine which uses the BLAS level 1 routines, skypf2() is a routine which uses BLAS levels 2 and 3. If skypf2() has been called, invD is set up. Once the matrix has been factored, skyss() is called. If the solution is sucessfully obtained, i.e. the skyss() routine returns \(0\) in the INFO argument, \(0\) is returned, otherwise it prints a warning message and returns INFO. The solve process changes \(A\) and \(X\).

Implements XC::ProfileSPDLinSolver.


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