SuperLU based solver for distributed sparse matrix linear systems of equations. More...

#include <DistributedSuperLU.h>

Inheritance diagram for XC::DistributedSuperLU:

Public Member Functions
	DistributedSuperLU (int npRow, int npCol)
	Constructor.

	DistributedSuperLU (void)
	Default constructor.

int	solve (void)
	Causes the solver to compute the solution of the system of equations. More...

int	setSize (void)
	Sets the number of equations. More...

virtual int	setProcessID (int domainTag)

virtual int	setChannels (int numChannels, Channel **theChannels)

int	sendSelf (CommParameters &)
	Send the object. More...

int	recvSelf (const CommParameters &)
	Receive the object. More...

Public Member Functions inherited from XC::SparseGenColLinSolver
virtual bool	setLinearSOE (SparseGenColLinSOE &theSOE)
	Sets the link to the SparseGenColLinSOE object `theSOE`. 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 &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 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::SparseGenColLinSolver
	SparseGenColLinSolver (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...

virtual LinearSOESolver *	getCopy (void) const =0
	Virtual constructor.

Protected Member Functions inherited from XC::Solver
	Solver (int classTag)
	Constructor. More...

Protected Attributes inherited from XC::SparseGenColLinSolver
SparseGenColLinSOE *	theSOE
	System of equations to solve.

Detailed Description

SuperLU based solver for distributed sparse matrix linear systems of equations.

It uses Gaussian elimination with partial pivoting (GEPP). The columns of A may be preordered before factorization; the preordering for sparsity is completely separate from the factorization and a number of ordering schemes are provided.

Member Function Documentation

§ recvSelf()

int XC::DistributedSuperLU::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::DistributedSuperLU::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::DistributedSuperLU::setSize ( void )

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()

int XC::DistributedSuperLU::solve ( void )

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/sparseGEN/DistributedSuperLU.h
src/solution/system_of_eqn/linearSOE/sparseGEN/DistributedSuperLU.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

§ recvSelf()

§ sendSelf()

§ setSize()

§ solve()