??. More...
#include <ShadowPetscSOE.h>
Public Member Functions | |
| int | solve (void) |
| Computes the solution of the system of equations. More... | |
| int | getNumEqn (void) const |
| Returns the number of equations in the system. | |
| int | setSize (Graph &theGraph) |
| Determines and sets the size of the system. More... | |
| int | addA (const Matrix &, const ID &, double fact=1.0) |
The LinearSOE object assembles fact times the Matrix M into the matrix $A$. More... | |
| int | addB (const Vector &, const ID &, const double &fact=1.0) |
The LinearSOE object assembles fact times the Vector V into the vector $b$. More... | |
| int | setB (const Vector &, const double &fact=1.0) |
The LinearSOE object sets the vector b to be fact times the vector V. More... | |
| void | zeroA (void) |
| To zero the matrix $A$, i.e. set all the components of $A$ to $0$. | |
| void | zeroB (void) |
| To zero the vector $b$, i.e. set all the components of $b$ to $0$. | |
| const Vector & | getX (void) |
| const Vector & | getB (void) |
| double | normRHS (void) |
| void | setX (int loc, double value) |
| The LinearSOE object is responsible for setting $x(loc) = value$. More... | |
| int | setSolver (PetscSolver &) |
| int | sendSelf (CommParameters &) |
| Send the object. More... | |
| int | recvSelf (const CommParameters &) |
| Receive the object. More... | |
 Public Member Functions inherited from XC::LinearSOE | |
| virtual | ~LinearSOE (void) |
| Destructor. | |
| virtual const Vector & | getX (void) const =0 |
| Return a const reference to the vector $x$. | |
| virtual const Vector & | getB (void) const =0 |
| Return a const reference to the vector $b$. | |
| virtual double | getDeterminant (void) |
| Returns the determinant of the system matrix. | |
| virtual double | normRHS (void) const =0 |
| Return the 2-norm of the vector $x$. | |
| virtual void | setX (const Vector &X)=0 |
| Sets the vector $x$. | |
| 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. | |
| 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 ¶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 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. | |
Friends | |
| class | AnalysisAggregation |
Additional Inherited Members | |
| Protected Member Functions inherited from XC::LinearSOE | |
| virtual bool | setSolver (LinearSOESolver *) |
| Sets the solver for the system of equations. More... | |
| int | setSolverSize (void) |
| invoke setSize() on the Solver | |
| LinearSOE (AnalysisAggregation *, 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 (AnalysisAggregation *, int classTag) | |
| Constructor. More... | |
Detailed Description
??.
Member Function Documentation
§ addA()
The LinearSOE object 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)}+= M(i,j)$. Numbering in $A$ starts at $(0,0)$, i.e. C style. If allocation specified is outside the range, i.e. $(-1,-1)$ the corresponding entry in M is not added to $A$. To return $0$ if sucessfull, a negative number if not.
Implements XC::LinearSOE.
§ addB()
|
virtual |
The LinearSOE object assembles fact times the Vector V into the vector $b$.
The Vector is assembled into $b$ at the locations given by the ID object {loc}, i.e. $b_{loc(i)} += V(i)$. If a location specified is outside the range, e.g. $-1$, the corresponding entry in {V} is not added to $b$. To return $0$ if sucessfull, a negative number if not.
Implements XC::LinearSOE.
§ recvSelf()
|
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()
|
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.
§ setB()
|
virtual |
The LinearSOE object sets the vector b to be fact times the vector V.
To return $0$ if sucessfull, a negative number if not.
Implements XC::LinearSOE.
§ setSize()
|
virtual |
Determines and sets the size of the system.
Invoked to allow the LinearSOE object to determine the size and sparsity of the matrix $A$ and vectors $x$ and $b$. This information can be deduced from the number of vertices and the connectivity between the vertices in the Graph object theGraph. To return $0$ if sucessfull, a negative number if not.
Implements XC::LinearSOE.
§ setX()
|
virtual |
The LinearSOE object is responsible for setting $x(loc) = value$.
This is needed in domain decomposition methods and could be useful in iterative solution strategies when an initial approximation is known.
Implements XC::LinearSOE.
§ solve()
|
virtual |
Computes the solution of the system of equations.
Causes the SystemOfEqn object to invoke solve() on the currently associated solver object. Returns a $0$ if successful, negative number if not; the actual value depending on the LinearSOESolver. To solve a linear system of equations means to find $x$ such that the equation $Ax=b$ is satisfied.
Reimplemented from XC::LinearSOE.
The documentation for this class was generated from the following files:
- src/solution/system_of_eqn/linearSOE/petsc/ShadowPetscSOE.h
- src/solution/system_of_eqn/linearSOE/petsc/ShadowPetscSOE.cpp
