A base class with the common behavior for creating a GeMA solver based on one of the following SuiteSparse library solvers: cholmod, umfpack and spqr. More...

#include <suiteSparseSolver.h>

Inheritance diagram for SuiteSparseSolver:

[legend]

Collaboration diagram for SuiteSparseSolver:

[legend]

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

virtual	~SuiteSparseSolver ()
	Destructor.

virtual const char *	pluginName () 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)

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

virtual const char *	pluginType () const=0

Protected Member Functions
bool	initTracking (GmSimulationData simulation, QString solverId, const char itemName, int numSolvers)

cholmod_sparse *	cholmodMatrix (GmSolverMatrix *A) const
	Given a matrix A, returns a "cholmod" matrix that wraps A. This can be just a pointer to an existing object if A is a SuiteSparseMatrix object, or a wrapper to a newly created object otherwise. After using the matrix, make sure that you call releaseCholmodMatrix() for the correct disposal of the matrix if necessary (for newly created objects). Returns NULL (and emmits a log message) on error.

void	releaseCholmodMatrix (cholmod_sparse *cA) const
	Releases, if necessary, the matrix created by the call to cholmodMatrix(A)

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
virtual bool	solveImpl (GmSolverMatrix *A, const GmVector &b, GmVector &x, bool xIsGuess) const=0

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

GmSimulationData *	simulationData () const

Protected Attributes
bool	_i64
	Are we using 64 bit indices for sparse matrices?

int	_normType
	The saved norm type (0 = infinite (maximum value), 1 = L1 (value sum), 2 = L2 (quadratic))

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

GmSparseMatrixOptions	_matrixOptions
	The set of options used for building the sparse matrix.

int	_trackSolveItem = -1

int	_trackSolveAnalyzeItem = -1

int	_trackSolveFactorizeItem = -1

int	_trackSolveSolveItem = -1

int	_trackSolveResidualAttr = -1

int	_trackSolveInternalMemAttr = -1

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

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)

Properties inherited from QObject
	objectName

Detailed Description

A base class with the common behavior for creating a GeMA solver based on one of the following SuiteSparse library solvers: cholmod, umfpack and spqr.

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

Member Function Documentation

◆ loadPrivateData()

bool SuiteSparseSolver::loadPrivateData ( LuaTable & table )

virtual

Implements GmPluginObject.

◆ newMatrix()

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

virtual

Implements GmNumSolver.

◆ pluginName()

virtual const char * SuiteSparseSolver::pluginName ( ) const

inlinevirtual

Implements GmPluginObject.

◆ printParameters()

void SuiteSparseSolver::printParameters ( const GmLogCategory & logger )

virtual

Reimplemented from GmNumSolver.

◆ quickDescription()

QString SuiteSparseSolver::quickDescription ( ) const

virtual

Implements GmNumSolver.

◆ setSolverTolerance()

virtual bool SuiteSparseSolver::setSolverTolerance ( double tol )

inlinevirtual

Implements GmNumSolver.

◆ trackItemId()

virtual int SuiteSparseSolver::trackItemId ( ) const

inlinevirtual

Reimplemented from GmNumSolver.

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

inc/suiteSparseSolver.h
src/suiteSparseSolver.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ loadPrivateData()

◆ newMatrix()

◆ pluginName()

◆ printParameters()

◆ quickDescription()

◆ setSolverTolerance()

◆ trackItemId()