Base class for band general linear SOE solvers. More...

#include <BandGenLinSolver.h>

Inheritance diagram for XC::BandGenLinSolver:

Public Member Functions
	BandGenLinSolver (int classTag)
	Constructor. More...

virtual int	solve (void)=0
	Causes the solver to compute the solution of the system of equations. More...

virtual bool	setLinearSOE (BandGenLinSOE &theSOE)
	sets up the link between the `theBandGenSOE` object and the BandGenLinSolver, that it is sets the pointer the subclasses use. More...

Public Member Functions inherited from XC::LinearSOESolver
virtual	~LinearSOESolver (void)
	Destructor.

virtual int	setSize (void)=0
	Sets the number of equations. More...

virtual double	getDeterminant (void)
	Returns the determinant of the system matrix.

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 bool	setLinearSOE (LinearSOE *theSOE)
	sets up the link between the `soe` object pointer and the BandGenLinSolver, that it is sets the pointer the subclasses use. More...

Protected Member Functions inherited from XC::LinearSOESolver
	LinearSOESolver (int classTag=0)
	Constructor. More...

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

Protected Member Functions inherited from XC::Solver
	Solver (int classTag)
	Constructor. More...

Protected Attributes
BandGenLinSOE *	theSOE

Detailed Description

Base class for band general linear SOE solvers.

BandGenLinSolver is an abstract class. The BandGenLinSolver class provides access for each subclass to the BandGenLinSOE object through the pointer #theSOE, which is a protected pointer.

Constructor & Destructor Documentation

§ BandGenLinSolver()

XC::BandGenLinSolver::BandGenLinSolver ( int classTags )

Constructor.

The integer classTag is passed to the base class constructor.

Member Function Documentation

§ setLinearSOE() [1/2]

bool XC::BandGenLinSolver::setLinearSOE ( LinearSOE * soe )

protectedvirtual

sets up the link between the soe object pointer and the BandGenLinSolver, that it is sets the pointer the subclasses use.

Implements XC::LinearSOESolver.

§ setLinearSOE() [2/2]

bool XC::BandGenLinSolver::setLinearSOE ( BandGenLinSOE & theBandGenSOE )

virtual

sets up the link between the theBandGenSOE object and the BandGenLinSolver, that it is sets the pointer the subclasses use.

§ solve()

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

pure virtual

Causes the solver to compute the solution of the system of equations.

Return $0$ if successful , negative number if not; the actual value depending on the type of Solver.

Implements XC::Solver.

Implemented in XC::BandGenLinLapackSolver.

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

src/solution/system_of_eqn/linearSOE/bandGEN/BandGenLinSolver.h
src/solution/system_of_eqn/linearSOE/bandGEN/BandGenLinSolver.cpp

Public Member Functions

Protected Member Functions