xc
|
Uses the LAPACK storage scheme to store the components of the A matrix, which is a banded unsymmetric matrix. More...
#include <BandGenLinSOE.h>
Public Member Functions | |
virtual int | setSize (Graph &theGraph) |
Compute the size of the system from the graph. More... | |
virtual int | addA (const Matrix &, const ID &, double fact=1.0) |
Assembles fact times the matrix m into the matrix A. More... | |
virtual void | zeroA (void) |
Zeros the entries in the 1d array for \(A\) and marks the system as not having been factored. More... | |
virtual int | sendSelf (Communicator &) |
Send the object. More... | |
virtual int | recvSelf (const Communicator &) |
Receive the object. More... | |
Public Member Functions inherited from XC::FactoredSOEBase | |
bool | getFactored (void) const |
void | setFactored (bool b) |
Public Member Functions inherited from XC::LinearSOEData | |
virtual int | getNumEqn (void) const |
Return the current size of the system. | |
virtual void | zeroB (void) |
Zeros the entries in the 1d array for \(b\). | |
virtual void | zeroX (void) |
Zeros the entries in the 1d array for \(x\). | |
virtual void | zero (void) |
Zeros the entries in the 1d array for \(x\) and \(b\). | |
virtual int | addB (const Vector &, const double &fact=1.0) |
add v multiplied by factor to vector B. More... | |
virtual int | addB (const Vector &, const ID &, const double &fact=1.0) |
assemblies v multiplied by factor into vector B. More... | |
virtual int | setB (const XC::Vector &v, const double &fact=1.0) |
Sets B= v*fact. More... | |
virtual void | setX (int loc, double value) |
If loc is within the range of \(x\), sets \(x(loc) = value\). | |
virtual void | setX (const Vector &x) |
Assigns \(x\). | |
virtual const Vector & | getX (void) const |
Returns the Vector object created for \(x\). | |
virtual Vector & | getX (void) |
Returns the Vector object created for \(x\). | |
virtual const Vector & | getB (void) const |
Returns the Vector object created for \(b\). | |
virtual Vector & | getB (void) |
Returns the Vector object created for \(b\). | |
virtual double | normRHS (void) const |
Returns the 2-norm of the vector \(x\). | |
void | receiveB (const Communicator &) |
void | receiveX (const Communicator &) |
void | receiveBX (const Communicator &) |
void | sendB (Communicator &) const |
void | sendBX (Communicator &) const |
Public Member Functions inherited from XC::LinearSOE | |
virtual | ~LinearSOE (void) |
Destructor. | |
virtual int | solve (void) |
Computes the solution of the system of equations. More... | |
virtual double | getDeterminant (void) |
Returns the determinant of the system matrix. | |
virtual double | getRCond (const char &norm='1') |
Returns the reciprocal of the condition number. More... | |
LinearSOESolver * | getSolver (void) |
Returns a pointer to the solver. | |
LinearSOESolver & | newSolver (const std::string &) |
Public Member Functions inherited from XC::SystemOfEqn | |
int | checkSize (Graph &theGraph) const |
Check number of DOFs in the graph. | |
virtual void | save (void) const |
Stores the matrices and vectors in a temporal file. | |
virtual void | restore (void) |
Restore the matrices and vectors from a temporal file. | |
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 (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 ¶m) |
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 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. | |
Public Member Functions inherited from CommandEntity | |
CommandEntity (CommandEntity *owr=nullptr) | |
Default constructor. | |
CommandEntity * | Owner (void) |
Return a pointer to the object owner. | |
const CommandEntity * | Owner (void) const |
Return un puntero al objeto propietario de ESTE. | |
const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
Return the regular output stream wrapper. | |
StandardOutputWrapper & | getStandardOutputWrapper (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. | |
EntityWithOwner & | operator= (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. | |
EntityWithOwner * | Owner (void) |
const EntityWithOwner * | Owner (void) const |
Protected Member Functions | |
virtual bool | setSolver (LinearSOESolver *) |
Sets the solver. More... | |
BandGenLinSOE (SolutionStrategy *) | |
Constructor. More... | |
BandGenLinSOE (SolutionStrategy *, int classTag) | |
Constructor. More... | |
BandGenLinSOE (SolutionStrategy *, int N, int numSuperDiagonals, int numSubDiagonal, BandGenLinSolver *theSolver=nullptr) | |
Constructor. More... | |
SystemOfEqn * | getCopy (void) const |
Virtual constructor. | |
Protected Member Functions inherited from XC::FactoredSOEBase | |
FactoredSOEBase (SolutionStrategy *, int classTag, int N=0) | |
Constructor. More... | |
Protected Member Functions inherited from XC::LinearSOEData | |
void | inic (const size_t &) |
1d arrays containing coefficients of B and X More... | |
const double & | getB (const size_t &i) const |
double & | getB (const size_t &i) |
const double & | getX (const size_t &i) const |
double & | getX (const size_t &i) |
double * | getPtrB (void) |
const double * | getPtrB (void) const |
double * | getPtrX (void) |
const double * | getPtrX (void) const |
LinearSOEData (SolutionStrategy *, int classTag, int N=0) | |
Constructor. More... | |
Protected Member Functions inherited from XC::LinearSOE | |
int | setSolverSize (void) |
invoke setSize() on the Solver | |
LinearSOE (SolutionStrategy *, int classTag) | |
Constructor. More... | |
Protected Member Functions inherited from XC::SystemOfEqn | |
virtual AnalysisModel * | getAnalysisModelPtr (void) |
Returns a pointer to the analysis model. | |
virtual const AnalysisModel * | getAnalysisModelPtr (void) const |
Returns a const pointer to the analysis model. | |
SystemOfEqn (SolutionStrategy *, int classTag) | |
Constructor. More... | |
Protected Member Functions inherited from CommandEntity | |
template<class T > | |
void | string_to (T &, const std::string &) const |
Protected Attributes | |
int | numSuperD |
int | numSubD |
Vector | A |
Protected Attributes inherited from XC::FactoredSOEBase | |
bool | factored |
True if the system is factored. | |
Protected Attributes inherited from XC::LinearSOEData | |
int | size |
Vector | B |
order of A | |
Vector | X |
Protected Attributes inherited from XC::SystemOfEqn | |
std::string | tmpFileName |
File name to store matrices. | |
Friends | |
class | SolutionStrategy |
class | FEM_ObjectBroker |
class | BandGenLinLapackSolver |
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. | |
Static Protected Member Functions inherited from CommandEntity | |
static CommandEntity * | entcmd_cast (boost::any &data) |
Static Protected Attributes inherited from EntityWithOwner | |
static int | verbosity = 1 |
Object that owns THIS ONE. More... | |
Uses the LAPACK storage scheme to store the components of the A matrix, which is a banded unsymmetric matrix.
BandGenLinSOE is class which is used to store a banded unsymmetric system with kl subdiagonals and ku superdiagonals. The \(A\) matrix is stored in a 1d double array with (kl+ku+1)*n elements, where n is the size of the system. \(A_{i,j}\) is stored at location \((ku+1+i-j) + j*(ku+1+kl)\), where \(i\) and \(j\) range from \(0\) to \(n-1\), i.e. C notation. For example when \(n=5\), \(kl = 2\) and \(ku=1\):
\( \left[ \begin{array}{ccccc} a_{0,0} & a_{0,1} & 0 & 0 & 0\\ a_{1,0} & a_{1,1} & a_{1,2} & 0 & 0\\ a_{2,0} & a_{2,1} & a_{2,2} & a_{2,3} & 0\\ 0 & a_{3,1} & a_{3,2} & a_{3,3} & a_{3,4}\\ 0 & 0 & a_{4,2} & a_{4,3} & a_{4,4} \end{array} \right] \)
is stored in:
\( \left[ \begin{array}{ccccccccccccccccccccc} & a_{0,0} & a_{1,0} & a_{2,0} & a_{0,1} & a_{1,1} & a_{2,1} & a_{3,1} & a_{1,2} & a_{2,2} & a_{3,2} & a_{4,2} & a_{2,3} & a_{3,3} & a_{4,3} & * & a_{3,4} & a_{4,4} & * & * \end{array} \right] \)
The \(x\) and \(b\) vectors are stored in 1d double arrays of length \(N\). To allow the solvers access to this data, the solvers that use this class are all declared as friend classes.
|
protected |
Constructor.
owr | analysis aggregation that owns this object. |
|
protected |
Constructor.
owr | analysis aggregation that owns this object. |
classTag | class identifier. |
|
protected |
Constructor.
Sets the size of the system to \(N\), the number of superdiagonals and the number of subdiagonals. Allocates memory for the arrays; if not enough memory is available a warning message is printed and the system size is set to \(0\).
N | size of the system. |
numSuperDiag | number of superdiagonals. |
numSubDiag | number of subdiagonals. |
Assembles fact times the matrix m into the matrix A.
First tests that loc
and M
are of compatible sizes; if not a warning message is printed and a \(-1\) is returned. The LinearSOE object then assembles fact
times the Matrix {M} into the matrix \(A\). The Matrix is assembled into \(A\) at the locations given by the ID object loc
, i.e. \(a_{loc(i),loc(j)} += //! fact * M(i,j)\). If the location specified is outside the range, i.e. \((-1,-1)\) the corresponding entry in M
is not added to \(A\). If fact
is equal to \(0.0\) or \(1.0\), more efficient steps are performed. Returns \(0\).
m | matrix to assemble. |
id | row identifiers. |
fact | factor. |
Implements XC::LinearSOE.
Reimplemented in XC::DistributedBandGenLinSOE.
|
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.
Reimplemented in XC::DistributedBandGenLinSOE.
|
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.
Reimplemented in XC::DistributedBandGenLinSOE.
|
virtual |
Compute the size of the system from the graph.
The size of the system is determined by looking at the adjacency ID of each Vertex in the Graph object G
. This is done by first setting kl
and ku
equal to \(0\) and then checking for each Vertex in G
, whether any of the vertex tags in the Vertices adjacency ID results in kl
or ku
being increased. Knowing kl
, ku
and the size of the system (the number of Vertices in G
), a check to see if the previously allocated 1d arrays for \(A\), \(x\) and \(b\) are large enough. If the memory portions allocated for the 1d arrays are not big enough, the old space is returned to the heap and new space is allocated from the heap. Prints a warning message if not enough memory is available on the heap for the 1d arrays and returns a \(-1\). If memory is available, the components of the arrays are zeroed and \(A\) is marked as being unfactored. If the system size has increased, new Vector objects for \(x\) and \(b\) using the {(do//! uble*,int)} Vector constructor are created. Finally, the result of invoking setSize() on the associated Solver object is returned.
Implements XC::LinearSOE.
Reimplemented in XC::DistributedBandGenLinSOE.
|
protectedvirtual |
Sets the solver.
Checks the compatibility of the solver and invokes {setSOE(*this)} on newSolver
.
Reimplemented from XC::LinearSOE.
|
virtual |
Zeros the entries in the 1d array for \(A\) and marks the system as not having been factored.
Implements XC::LinearSOE.