sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector > Class Template Reference

#include <JacobiPreconditioner.h>

Linear solver based on a diagonal matrix (i.e. Jacobi preconditioner) More...

Inheritance diagram for sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >:

Detailed Description

template<class TMatrix, class TVector>
class sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >

Linear solver based on a diagonal matrix (i.e. Jacobi preconditioner)

Public Attributes
sofa::core::objectmodel::lifecycle::RemovedData	f_verbose {this, "v23.12", "v24.06", "verbose", "This Data is no longer used"}

Public Member Functions
	SOFA_CLASS (SOFA_TEMPLATE2(JacobiPreconditioner, TMatrix, TVector), SOFA_TEMPLATE2(sofa::component::linearsolver::MatrixLinearSolver, TMatrix, TVector))
void	setSystemMBKMatrix (const core::MechanicalParams *mparams) override
void	solve (Matrix &M, Vector &x, Vector &b) override
	Solve P^-1 Mx= P^-1 b. More...
void	invert (Matrix &M) override
void	parse (core::objectmodel::BaseObjectDescription *arg) override
Public Member Functions inherited from sofa::component::linearsolver::MatrixLinearSolver< TMatrix, TVector >
void	resetSystem ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	resetSystem ()
void	resizeSystem (Size n)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	resizeSystem (Size)
void	setSystemMBKMatrix (const core::MechanicalParams *mparams)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	setSystemMBKMatrix (const core::MechanicalParams *mparams)
void	rebuildSystem (SReal, SReal)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	rebuildSystem (SReal massFactor, SReal forceFactor)
void	setSystemLHVector (core::MultiVecDerivId v)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	setSystemLHVector (core::MultiVecDerivId v)
void	applySystemSolution ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	applySystemSolution ()
void	applyConstraintForce (const sofa::core::ConstraintParams *, sofa::core::MultiVecDerivId, const linearalgebra::BaseVector *)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	applyConstraintForce (const sofa::core::ConstraintParams *, sofa::core::MultiVecDerivId, const linearalgebra::BaseVector *)
void	computeResidual (const core::ExecParams *, linearalgebra::BaseVector *)
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	computeResidual (const core::ExecParams *params, linearalgebra::BaseVector *f)
GraphScatteredVector *	createPersistentVector ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API GraphScatteredVector *	createPersistentVector ()
linearalgebra::BaseMatrix *	getSystemBaseMatrix ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API linearalgebra::BaseMatrix *	getSystemBaseMatrix ()
linearalgebra::BaseVector *	getSystemRHBaseVector ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API linearalgebra::BaseVector *	getSystemRHBaseVector ()
linearalgebra::BaseVector *	getSystemLHBaseVector ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API linearalgebra::BaseVector *	getSystemLHBaseVector ()
void	checkLinearSystem ()
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void	checkLinearSystem ()
bool	addJMInvJtLocal (GraphScatteredMatrix *M, MatrixLinearSolver< GraphScatteredMatrix, GraphScatteredVector, NoThreadManager >::ResMatrixType *result, const MatrixLinearSolver< GraphScatteredMatrix, GraphScatteredVector, NoThreadManager >::JMatrixType *J, const SReal fact)

Static Public Member Functions
static const std::string	GetCustomTemplateName ()

Protected Member Functions
	JacobiPreconditioner ()

Attribute details

f_verbose

template<class TMatrix , class TVector >

sofa::core::objectmodel::lifecycle::RemovedData sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::f_verbose {this, "v23.12", "v24.06", "verbose", "This Data is no longer used"}

Constructor details

JacobiPreconditioner()

template<class TMatrix , class TVector >

sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::JacobiPreconditioner

protected

Function details

GetCustomTemplateName()

template<class TMatrix , class TVector >

static const std::string sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::GetCustomTemplateName ( )

inlinestatic

Returns the sofa template name. By default the name of the c++ class signature is exposed... so we need to override that by implementing GetCustomTemplateName() function More details on the name customization infrastructure is in NameDecoder.h

invert()

template<class TMatrix , class TVector >

void sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::invert ( Matrix &  M )

override

parse()

template<class TMatrix , class TVector >

void sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::parse ( core::objectmodel::BaseObjectDescription *  arg )

override

setSystemMBKMatrix()

template<class TMatrix , class TVector >

void sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::setSystemMBKMatrix ( const core::MechanicalParams *  mparams )

override

SOFA_CLASS()

template<class TMatrix , class TVector >

sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::SOFA_CLASS	(	SOFA_TEMPLATE2(JacobiPreconditioner< TMatrix, TVector >, TMatrix, TVector)	,
		SOFA_TEMPLATE2(sofa::component::linearsolver::MatrixLinearSolver, TMatrix, TVector)
	)

solve()

template<class TMatrix , class TVector >

void sofa::component::linearsolver::preconditioner::JacobiPreconditioner< TMatrix, TVector >::solve ( Matrix &  M, Vector &  x, Vector &  b  )

override

Solve P^-1 Mx= P^-1 b.