A class for creating a GeMA solver based on th Lis library. More...

#include <lisSolver.h>

Inheritance diagram for LisSolver:

[legend]

Collaboration diagram for LisSolver:

[legend]

Public Member Functions
	LisSolver (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)
	Constructor. Will be called by the plugin loading code.

virtual	~LisSolver ()
	Destructor.

virtual const char *	pluginName () const

virtual const char *	pluginType () const

virtual bool	loadPrivateData (LuaTable &table)

virtual GmSolverMatrix *	newMatrix (int nlin, int ncol, const GmSolverMatrix *sharedLayout, int numThreads=-1) const

virtual bool	setSolverTolerance (double tol)
	Updates the current solver tolerance. Will be used by any successive calls to solve()

virtual bool	solveImpl (GmSolverMatrix *A, const GmVector &b, GmVector &x, bool xIsGuess=false) const

virtual void	printParameters (const GmLogCategory &logger)

virtual QString	quickDescription () const

virtual int	trackItemId () const

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Public Member Functions inherited from GmNumSolver
	GmNumSolver (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)

virtual const char *	pluginCategory () const

bool	solve (GmSolverMatrix *A, const GmVector &b, GmVector &x, bool xIsGuess=false) const

Public Member Functions inherited from GmPluginObject
	GmPluginObject (GmSimulationData *simulation, QString id, QString description, const GmLogCategory &logger)

QString	id () const

QString	description () const

QString	pluginTypeName () const

Static Public Member Functions
static void	libraryInit (const GmLogCategory &logger)
	Initializes the Lis library on plugin loading.

static void	libraryFinalize ()
	Closes the Lis library on plugin destruction.

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Private Member Functions
bool	armadilloSolve (GmRunProgress ps, GmSolverMatrix A, const GmVector &b, GmVector &x, bool xIsGuess=false) const
	Solve implementation.

bool	loadLisParameters (LuaTable &table)
	Loads LIS options from the given Lua table, filling _solverOptions with the set of options that should be passes to the Lis library. Each list entry ia an option string already formatted according to the Lis syntax.

void	fetchSolveMetrics (GmRunProgress *ps) const
	Get (and possibly print) iterations, residual and time statistics.

Private Attributes
GmSparseMatrixOptions	_lisMatrixOptions
	The set of options used for building the sparse matrix.

LIS_SOLVER	_solver
	The solver.

int	_nthreads
	The configured number of threads for the Lis solver.

QStringList	_solverOptions
	List with the set of options to be configured on the solver.

bool	_printIterations
	Should the solver print, after solving, the number of iterations used by the numeric solver?

bool	_printResidual
	Should the solver print, after solving, the residual?

bool	_printTimes
	Should the solver print, after solving, a breakdown of solving and preconditioning times?

bool	_printLisMsgs
	Enable or disable LIS messages to the CONSOLE only.

bool	_lisAlwaysInitx
	If set to true, the initial guess will always be zero, independently of the value of the xIsGuess parameter in a call to solve()

int	_trackSolveItem = -1

int	_trackSolveIterAttr = -1

int	_trackSolveResidualAttr = -1

int	_trackSolveInternalTimeAttr = -1

int	_trackDetailedVectorMatrixSetupItem = -1

int	_trackDetailedVectorMatrixSolveItem = -1

Static Private Attributes
static int	_maxThreads = 0
	The maximum number of threads used to configure the Lis library.

static int	_numSolvers = 0
	The number of instanced solvers.

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Protected Member Functions inherited from GmNumSolver
Protected Member Functions inherited from GmPluginObject
virtual const GmLogCategory &	logger () const

GmSimulationData *	simulationData () const

Properties inherited from QObject
	objectName

Detailed Description

A class for creating a GeMA solver based on th Lis library.

It inherits from QObject so that we can pass the LisSolver as the owner of the created track item. This allows for track item renaming when more than one solver is used.

Member Function Documentation

◆ loadLisParameters()

bool LisSolver::loadLisParameters ( LuaTable & table )

private

Loads LIS options from the given Lua table, filling _solverOptions with the set of options that should be passes to the Lis library. Each list entry ia an option string already formatted according to the Lis syntax.

Documentation about the configuration of Lis Solver options are detailed in ext\lis\lis-2.0.16\doc\lis-ug-en.pdf pages [29-31]

< The field name on the Lua table

< The corresponding Lis option

< Type of the option data: s = string, d = integer, f = real, b = boolean

< A NULL terminated vector with the set of valid values for string options. NULL if dataType != 's'.

< Different from NULL if this option is valid only for certain other option values

< The value of the option in onlyIf for which this option is valid

◆ loadPrivateData()

bool LisSolver::loadPrivateData ( LuaTable & table )

virtual

Implements GmPluginObject.

◆ newMatrix()

GmSolverMatrix * LisSolver::newMatrix	(	int	nlin,
		int	ncol,
		const GmSolverMatrix *	sharedLayout,
		int	numThreads = -1 ) const

virtual

Implements GmNumSolver.

◆ pluginName()

virtual const char * LisSolver::pluginName ( ) const

inlinevirtual

Implements GmPluginObject.

◆ pluginType()

virtual const char * LisSolver::pluginType ( ) const

inlinevirtual

Implements GmPluginObject.

◆ printParameters()

void LisSolver::printParameters ( const GmLogCategory & logger )

virtual

Reimplemented from GmNumSolver.

◆ quickDescription()

QString LisSolver::quickDescription ( ) const

virtual

Implements GmNumSolver.

◆ setSolverTolerance()

bool LisSolver::setSolverTolerance ( double tol )

virtual

Updates the current solver tolerance. Will be used by any successive calls to solve()

Implements GmNumSolver.

◆ solveImpl()

bool LisSolver::solveImpl	(	GmSolverMatrix *	A,
		const GmVector &	b,
		GmVector &	x,
		bool	xIsGuess = false ) const

virtual

Implements GmNumSolver.

◆ trackItemId()

virtual int LisSolver::trackItemId ( ) const

inlinevirtual

Reimplemented from GmNumSolver.

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

inc/lisSolver.h
src/lisSolver.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ loadLisParameters()

◆ loadPrivateData()

◆ newMatrix()

◆ pluginName()

◆ pluginType()

◆ printParameters()

◆ quickDescription()

◆ setSolverTolerance()

◆ solveImpl()

◆ trackItemId()