xc
Public Member Functions | Friends | List of all members

??. More...

#include <ShadowPetscSOE.h>

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

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. More...
 
void zeroB (void)
 To zero the vector \(b\), i.e. More...
 
const VectorgetX (void) const
 Return a const reference to the vector \(x\).
 
const VectorgetB (void) const
 Return a const reference to the vector \(b\).
 
double normRHS (void) const
 Return the 2-norm of the vector \(x\).
 
void setX (int loc, double value)
 The LinearSOE object is responsible for setting \(x(loc) = value\). More...
 
void setX (const Vector &x)
 Sets the vector \(x\).
 
int setSolver (PetscSolver &)
 
int sendSelf (Communicator &)
 Send the object. More...
 
int recvSelf (const Communicator &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::LinearSOE
virtual ~LinearSOE (void)
 Destructor.
 
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...
 
LinearSOESolvergetSolver (void)
 Returns a pointer to the solver.
 
LinearSOESolvernewSolver (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.
 
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 SolutionStrategy
 

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::LinearSOE
virtual bool setSolver (LinearSOESolver *)
 Sets the solver for the system of equations. More...
 
int setSolverSize (void)
 invoke setSize() on the Solver
 
 LinearSOE (SolutionStrategy *, int classTag)
 Constructor. More...
 
- Protected Member Functions inherited from XC::SystemOfEqn
virtual AnalysisModelgetAnalysisModelPtr (void)
 Returns a pointer to the analysis model.
 
virtual const AnalysisModelgetAnalysisModelPtr (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
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::SystemOfEqn
std::string tmpFileName
 File name to store matrices.
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

??.

Member Function Documentation

◆ addA()

int XC::ShadowPetscSOE::addA ( const Matrix M,
const ID loc,
double  fact = 1.0 
)
virtual

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 successful, a negative number if not.

Implements XC::LinearSOE.

◆ addB()

int XC::ShadowPetscSOE::addB ( const Vector V,
const ID loc,
const double &  fact = 1.0 
)
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 successful, a negative number if not.

Implements XC::LinearSOE.

◆ recvSelf()

int XC::ShadowPetscSOE::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::ShadowPetscSOE::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.

◆ setB()

int XC::ShadowPetscSOE::setB ( const Vector V,
const double &  fact = 1.0 
)
virtual

The LinearSOE object sets the vector b to be fact times the vector V.

To return $0$ if successful, a negative number if not.

Implements XC::LinearSOE.

◆ setSize()

int XC::ShadowPetscSOE::setSize ( Graph theGraph)
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 successful, a negative number if not.

Implements XC::LinearSOE.

◆ setX()

void XC::ShadowPetscSOE::setX ( int  loc,
double  value 
)
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()

int XC::ShadowPetscSOE::solve ( void  )
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.

◆ zeroA()

void XC::ShadowPetscSOE::zeroA ( void  )
virtual

To zero the matrix \(A\), i.e.

set all the components of \(A\) to \(0\).

Implements XC::LinearSOE.

◆ zeroB()

void XC::ShadowPetscSOE::zeroB ( void  )
virtual

To zero the vector \(b\), i.e.

set all the components of \(b\) to \(0\).

Implements XC::LinearSOE.


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