System of equations base class. More...

#include <SystemOfEqn.h>

Inheritance diagram for XC::SystemOfEqn:

Public Member Functions
int	checkSize (Graph &theGraph) const
	Check number of DOFs in the graph.

virtual int	solve (void)=0
	Invoked to cause the system of equation object to solve itself. 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.

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	sendSelf (CommParameters &cp)=0
	Send the object. More...

virtual int	recvSelf (const CommParameters &cp)=0
	Receive the object. 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 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.

Protected Member Functions
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...

virtual SystemOfEqn *	getCopy (void) const =0
	Virtual constructor.

Friends
class	AnalysisAggregation

Detailed Description

System of equations base class.

Responsible for storing the system of equations it represents. A Solver object, which is associated with the SystemOfEqn object, is responsible for performing the numerical operations to solve for the system of equations.

Constructor & Destructor Documentation

§ SystemOfEqn()

XC::SystemOfEqn::SystemOfEqn	(	AnalysisAggregation *	owr,
		int	classTag
	)

protected

Constructor.

The integer classTag is provided to the constructor for the base class MovableObject.

Parameters

owr	analysis aggregation that owns this object.
classTag	identifier of the class.

Member Function Documentation

§ solve()

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

pure virtual

Invoked to cause the system of equation object to solve itself.

To return 0 if successful, negative number if not.

Implemented in XC::LinearSOE, XC::ShadowPetscSOE, XC::DistributedBandGenLinSOE, XC::DistributedSparseGenColLinSOE, XC::DistributedBandSPDLinSOE, XC::DistributedProfileSPDLinSOE, and XC::EigenSOE.

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

src/solution/system_of_eqn/SystemOfEqn.h
src/solution/system_of_eqn/SystemOfEqn.cpp

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

§ SystemOfEqn()

Member Function Documentation

§ solve()