xc
Public Member Functions | Friends | List of all members

Lapack based full (dense) general matrix SOE solver. More...

#include <FullGenLinLapackSolver.h>

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

Public Member Functions

int solve (void)
 Computes the solution. More...
 
int setSize (void)
 Sets the size of #iPiv from the size of the system of equations. More...
 
int sendSelf (Communicator &)
 Does nothing.
 
int recvSelf (const Communicator &)
 Does nothing.
 
- Public Member Functions inherited from XC::FullGenLinSolver
virtual bool setLinearSOE (FullGenLinSOE &theSOE)
 
- 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.
 
const PythonDict & getPropertiesDict (void) const
 Return a std::map container with the properties of the object.
 
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)
 Assigns the owner of the object.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Friends

class FEM_ObjectBroker
 
class LinearSOE
 

Additional Inherited Members

- Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object > PythonDict
 
- 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::FullGenLinSolver
 FullGenLinSolver (int classTag)
 Constructor. More...
 
virtual bool setLinearSOE (LinearSOE *theSOE)
 Sets the link to the soe object. More...
 
- 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::FullGenLinSolver
FullGenLinSOEtheSOE
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Lapack based full (dense) general matrix SOE solver.

Solver for a FullGenLinSOE object. It obtains the solution by making calls on the the LAPACK library. The class is defined to be a friend of the FullGenLinSOE class.

Member Function Documentation

◆ setSize()

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

Sets the size of #iPiv from the size of the system of equations.

Is used to construct a 1d integer array, #iPiv that is needed by the LAPACK solvers. It checks to see if current size of #iPiv is large enough, if not it resizes it. Returns 0 if successful, prints a warning message and returns a -1 if not enough memory is available for this new array.

Implements XC::LinearSOESolver.

◆ solve()

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

Computes the solution.

First copies B into X and then solves the FullGenLinSOE system it is associated with (pointer kept by parent class) by calling the LAPACK routines dgesv(), if the system is marked as not having been factored, or dgetrs(), if system is marked as having been factored. If the solution is successfully obtained, i.e. the LAPACK 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.

Implements XC::Solver.


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