xc
Public Member Functions | Friends | List of all members

SuperLU based sparse general matrix linear SOE solver. More...

#include <SuperLU.h>

Inheritance diagram for XC::SuperLU:
Inheritance graph
[legend]
Collaboration diagram for XC::SuperLU:
Collaboration graph
[legend]

Public Member Functions

 ~SuperLU (void)
 Destructor.
 
int solve (void)
 Solve the system. More...
 
int setSize (void)
 Set the system size. More...
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
void Print (std::ostream &os) const
 
- 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.
 
- Public Member Functions inherited from XC::Solver
virtual double getDeterminant (void)
 Return the determinant of the system matrix.
 
virtual double getRCond (const char &)
 Estimates the reciprocal of the condition number of the matrix A, in either the 1-norm or the infinity-norm, using the LU factorization computed by DGBTRF. 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.
 
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 (Communicator &)
 Return the object identifier in the database.
 
void setDbTag (int dbTag)
 Sets the object identifier in the database.
 
void setDbTag (Communicator &)
 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 ~DistributedBase (void)
 Destructor.
 
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.
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (void)
 Return the regular output stream wrapper.
 
const std::string & getLogFileName (void) const
 Returns log file name.
 
void setLogFileName (const std::string &)
 Sets log file name.
 
const std::string & getErrFileName (void) const
 Returns err file name.
 
void setErrFileName (const std::string &)
 Sets error file name.
 
const std::string & getOutputFileName (void) const
 Returns regular output file name.
 
void setOutputFileName (const std::string &)
 Sets regular output file name.
 
boost::python::object evalPy (boost::python::object dict, const std::string &)
 Return the Python object that results from evaluating the argument.
 
boost::python::object execPy (boost::python::object dict, const std::string &)
 Return the Python objects that results from executing the code in the string argument.
 
boost::python::object execFilePy (boost::python::object dict, const std::string &)
 Return the Python object that results from executing the code in the file.
 
- Public Member Functions inherited from EntityWithProperties
 EntityWithProperties (EntityWithProperties *owr=nullptr)
 Default constructor.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
void clearPyProps (void)
 Clear python properties map.
 
bool hasPyProp (const std::string &)
 Returns true if property exists.
 
boost::python::object getPyProp (const std::string &str)
 Return the Python object with the name being passed as parameter.
 
void setPyProp (std::string str, boost::python::object val)
 Sets/appends a value tho the Python object's dictionary.
 
void copyPropsFrom (const EntityWithProperties &)
 Copy the properties from the argument.
 
boost::python::list getPropNames (void) const
 Return the names of the object properties weightings.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary containing the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
- Public Member Functions inherited from EntityWithOwner
 EntityWithOwner (EntityWithOwner *owr=nullptr)
 Default constructor.
 
 EntityWithOwner (const EntityWithOwner &)
 Copy constructor.
 
EntityWithOwneroperator= (const EntityWithOwner &)
 Assignment operator.
 
virtual bool operator== (const EntityWithOwner &) const
 Comparison operator.
 
virtual ~EntityWithOwner (void)
 Virtual destructor.
 
virtual std::string getClassName (void) const
 Returns demangled class name.
 
void set_owner (EntityWithOwner *owr)
 Asigna el propietario del objeto.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Friends

class LinearSOE
 
class FEM_ObjectBroker
 

Additional Inherited Members

- Static Public Member Functions inherited from CommandEntity
static void resetStandardOutput (void)
 Reset the standard output streams to its defaults buffers.
 
- Static Public Member Functions inherited from EntityWithOwner
static int getVerbosityLevel (void)
 Get the value of the verbosity level.
 
static void setVerbosityLevel (const int &)
 Set the value of the verbosity level.
 
- 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...
 
- Protected Member Functions inherited from XC::Solver
 Solver (int classTag)
 Constructor. More...
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::SparseGenColLinSolver
SparseGenColLinSOEtheSOE
 System of equations to solve.
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

SuperLU based sparse general matrix linear SOE solver.

A SuperLU object can be constructed to solve a SparseGenColLinSOE object. It obtains the solution by making calls on the the SuperLU library developed at UC Berkeley by Prof. James Demmel, Xiaoye S. Li and John R. Gilbert. The SuperLU library contains a set of subroutines to solve a sparse linear system \(AX=B\). 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::SuperLU::recvSelf ( const Communicator comm)
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::SuperLU::sendSelf ( Communicator comm)
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::SuperLU::setSize ( void  )
virtual

Set the system size.

Obtains the size of the system from it's associaed SparseGenColLinSOE object. With this information it creates space for the integer arrays permR, permC and etree. It then creates the a SuperMatrix for A by calling the SuperLU routine {dCreate_CompCol_Matrix()}, sets the column permutation permR by calling the SuperLU routine {get_perm_c(permSpec, A, permC)}, applies this permutation and determines the elimination tree {etree} by calling the SuperLU routine sp_preorder(). It then creates a SuperMatrix for X by calling the SuperLU routine dCreate_Dense_Matrix(). Returns \(0\) if successful, prints a warning message and returns a \(-1\) if not enough memory is available for the arrays.

Implements XC::LinearSOESolver.

◆ solve()

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

Solve the system.

First copies \(B\) into \(X\) and then solves the FullGenLinSOE system it is associated with (pointer kept by parent class) by calling the SeuperLU routine dgstrf(), if the system is marked as not having been factored, or dgstrs(), if system is marked as having been factored. If the solution is successfully obtained, i.e. the SuperLU routines return \(0\) in the INFO argument, it marks the system has having been factored and returns \(0\), otherwise it prints a warning message and returns INFO. The solve process changes \(A\) and \(X\) and sets the char rafact to Y.

Implements XC::Solver.


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