Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

LinearSOESolver Class Reference

#include <LinearSOESolver.h>

Inheritance diagram for LinearSOESolver::

Solver BandGenLinSolver BandSPDLinSolver FullGenLinSolver ProfileSPDLinSolver SparseGenColLinSolver SymSparseLinSolver BandGenLinLapackSolver BandSPDLinLapackSolver FullGenLinLapackSolver ProfileSPDLinDirectBlockSolver ProfileSPDLinDirectSkypackSolver ProfileSPDLinDirectSolver ProfileSPDLinDirectThreadSolver SuperLU List of all members.

Public Methods

 LinearSOESolver (int classTag)
virtual ~LinearSOESolver ()
virtual int solve (void)=0
virtual int setSize (void)=0
 virtual int setLinearSOE(LinearSOE &theSOE) =0;. More...

virtual double getDeterminant (void)

Detailed Description

LinearSOESolver is an abstract class. A LinearSOESolver object is responsible for solving the LinearSOE object that it is associated with. That is, to find such that the matrix equation is satisfied. \

{\bf Interface} \ {// Constructor} \ {LinearSOESolver(int classTag);} \ \ {// Destructor} \ {virtual~ LinearSOESolver();}\ \ {// Public Methods } \ {virtual int solve(void) =0;} \ {virtual int setSize(void) =0;} \

{\bf Constructor} \ {LinearSOESolver(int classTag);} \ The integer {classTag} is passed to the Solver. \

{\bf Destructor} \ {virtual~ LinearSOESolver();}\ Does nothing. Provided so the subclasses destructor will be called. \

{\bf Public Methods } \ {virtual int solve(void) =0;} \ Causes the LinearSOESolver to solve the system of equations for . Returns if successful , negative number if not; the actual value depending on the type of LinearSOESolver. The result of the solve are to be stored in the vector of the LinearSOE by the object.\

{virtual int setSize(void) =0;} \ This is invoked by the {LinearSOE} object when {setSize()} has been invoked on it. Solvers may sometimes need to store additional data that needs to be updated if the size of the system of equation changes. \

Definition at line 88 of file LinearSOESolver.h.


Constructor & Destructor Documentation

LinearSOESolver::LinearSOESolver ( int classTag )
 

Definition at line 43 of file LinearSOESolver.cpp.

LinearSOESolver::~LinearSOESolver ( ) [virtual]
 

Definition at line 49 of file LinearSOESolver.cpp.


Member Function Documentation

double LinearSOESolver::getDeterminant ( void ) [inline, virtual]
 

Reimplemented in ProfileSPDLinDirectSolver.

Definition at line 102 of file LinearSOESolver.h.

Referenced by LinearSOE::getDeterminant().

int LinearSOESolver::setSize ( void ) [pure virtual]
 

virtual int setLinearSOE(LinearSOE &theSOE) =0;.

Reimplemented in BandGenLinLapackSolver, BandSPDLinLapackSolver, FullGenLinLapackSolver, ProfileSPDLinDirectBlockSolver, ProfileSPDLinDirectSkypackSolver, ProfileSPDLinDirectSolver, ProfileSPDLinDirectThreadSolver, SuperLU, and SymSparseLinSolver.

Referenced by BandGenLinSOE::setBandGenSolver(), BandSPDLinSOE::setBandSPDSolver(), FullGenLinSOE::setFullGenSolver(), ProfileSPDLinSOE::setProfileSPDSolver(), SparseGenColLinSOE::setSize(), ProfileSPDLinSOE::setSize(), FullGenLinSOE::setSize(), BandSPDLinSOE::setSize(), BandGenLinSOE::setSize(), and SparseGenColLinSOE::setSparseGenColSolver().

int LinearSOESolver::solve ( void ) [pure virtual]
 

Reimplemented in BandGenLinLapackSolver, BandGenLinSolver, BandSPDLinLapackSolver, BandSPDLinSolver, FullGenLinLapackSolver, ProfileSPDLinDirectBlockSolver, ProfileSPDLinDirectSkypackSolver, ProfileSPDLinDirectSolver, ProfileSPDLinDirectThreadSolver, ProfileSPDLinSolver, SuperLU, and SymSparseLinSolver.

Referenced by LinearSOE::solve().


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