Diffpack Documentation

---

              Search  

---

LinEqSolver_prm Class Reference

parameters for the "LinEqSolver" hierarchy. More...

#include <LinEqSolver_prm.h>

Inheritance diagram for LinEqSolver_prm::

List of all members.

Public Methods
virtual	~LinEqSolver_prm ()
void	scan (MenuSystem &menu)
void	define (MenuSystem &menu, int level=MAIN)
void	print (Os os, const char *solver_name=NULL) const
bool	ok () const
virtual LinEqSolver*	create () const
const StringList&	hier () const
Static Public Methods
LinEqSolver_prm*	construct ()
void	defineStatic (MenuSystem &menu, int level=MAIN)
const StringList&	hierStatic ()
void	registerPrmSubclass (LinEqSolver_prm &sc)
void	unregisterPrmSubclass ()
Public Attributes
String	basic_method
PivotType	pivot_tp
int	nsearchv
NUMT	shift
bool	restart
real	relaxation
StartVectorMode	startmode
bool	default_criterion
int	nextern_crit
int	max_iterations
bool	estimate_eigvals
int	update_frequency
Protected Methods
virtual LinEqSolver_prm*	clone ()
	LinEqSolver_prm ()
Protected Attributes
StringList	subclasses
Static Protected Attributes
Handle(LinEqSolver_prm)	master

---

Detailed Description

parameters for the "LinEqSolver" hierarchy.

NAME: LinEqSolver_prm - parameters for the "LinEqSolver" hierarchy

DESCRIPTION:

The class contains all parameters needed for initialization of an object derived from "LinEqSolver".

---

Constructor & Destructor Documentation

LinEqSolver_prm::LinEqSolver_prm ( ) [protected]

See documentation of one of the overloaded constructor.

LinEqSolver_prm::~LinEqSolver_prm ( ) [inline, virtual]

---

Member Function Documentation

LinEqSolver_prm * LinEqSolver_prm::clone ( ) [inline, protected, virtual]

Reimplemented in LinEqSolver2_prm.

LinEqSolver_prm * LinEqSolver_prm::construct ( ) [static]

LinEqSolver * LinEqSolver_prm::create ( ) const [virtual]

Reimplemented in LinEqSolver2_prm.

void LinEqSolver_prm::define ( MenuSystem & menu, int level = MAIN ) [inline]

void LinEqSolver_prm::defineStatic ( MenuSystem & menu, int level = MAIN ) [static]

const StringList & LinEqSolver_prm::hier ( ) const [inline]

const StringList & LinEqSolver_prm::hierStatic ( ) [inline, static]

bool LinEqSolver_prm::ok ( ) const [inline]

void LinEqSolver_prm::print ( Os os, const char * solver_name = NULL ) const

void LinEqSolver_prm::registerPrmSubclass ( LinEqSolver_prm & sc ) [inline, static]

void LinEqSolver_prm::scan ( MenuSystem & menu )

void LinEqSolver_prm::unregisterPrmSubclass ( ) [inline, static]

---

Member Data Documentation

String LinEqSolver_prm::basic_method

bool LinEqSolver_prm::default_criterion

bool LinEqSolver_prm::estimate_eigvals

Handle(LinEqSolver_prm) LinEqSolver_prm::master [static, protected]

int LinEqSolver_prm::max_iterations

int LinEqSolver_prm::nextern_crit

int LinEqSolver_prm::nsearchv

PivotType LinEqSolver_prm::pivot_tp

real LinEqSolver_prm::relaxation

bool LinEqSolver_prm::restart

NUMT LinEqSolver_prm::shift

StartVectorMode LinEqSolver_prm::startmode

StringList LinEqSolver_prm::subclasses [protected]

int LinEqSolver_prm::update_frequency

---

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

• LinEqSolver_prm.h

---