SOFA API  ea9ab574
Open source framework for multi-physics simuation
sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager > Class Template Referenceabstract

#include <MatrixLinearSolver.h>

Inheritance diagram for sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >:

Classes

struct  LinearSystemData
 
class  TempVectorContainer
 

Public Attributes

Data< boold_parallelInverseProduct
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the object belongs to More...
 
Data< sofa::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Protected Attributes

MatrixLinearSolverInternalData< Vector > internalData
 
std::unique_ptr< MatrixInvertDatainvertData
 
LinearSystemData linearSystem
 
SReal currentMFactor
 
SReal currentBFactor
 
SReal currentKFactor
 
SingleLink< MatrixLinearSolver< Matrix, Vector, NoThreadManager >, sofa::component::linearsystem::TypedMatrixLinearSystem< Matrix, Vector >, BaseLink::FLAG_STOREPATH|BaseLink::FLAG_STRONGLINKl_linearSystem
 
- Protected Attributes inherited from sofa::core::behavior::LinearSolver
bool frozen
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_internalEngine
 
VecData m_vecData
 List of fields (Data instances) More...
 
MapData m_aliasData
 name -> Data multi-map (includes names and aliases) More...
 
VecLink m_vecLink
 List of links. More...
 
MapLink m_aliasLink
 name -> Link multi-map (includes names and aliases) More...
 

Public Member Functions

 SOFA_ABSTRACT_CLASS (SOFA_TEMPLATE3(MatrixLinearSolver, Matrix, Vector, NoThreadManager), SOFA_TEMPLATE2(BaseMatrixLinearSolver, Matrix, Vector))
 
 MatrixLinearSolver ()
 
 ~MatrixLinearSolver () override
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void resetSystem () override
 Reset the current linear system. More...
 
void resizeSystem (Size n)
 Reset the current linear system. More...
 
void setSystemMBKMatrix (const core::MechanicalParams *mparams) override
 
void rebuildSystem (SReal massFactor, SReal forceFactor) override
 Rebuild the system using a mass and force factor. More...
 
void setSystemRHVector (core::MultiVecDerivId v) override
 Set the linear system right-hand term vector, from the values contained in the (Mechanical/Physical)State objects. More...
 
void setSystemLHVector (core::MultiVecDerivId v) override
 
Matrix * getSystemMatrix () override
 Get the linear system matrix, or nullptr if this solver does not build it. More...
 
Vector * getSystemRHVector ()
 Get the linear system right-hand term vector, or nullptr if this solver does not build it. More...
 
Vector * getSystemLHVector ()
 Get the linear system left-hand term vector, or nullptr if this solver does not build it. More...
 
linearalgebra::BaseMatrixgetSystemBaseMatrix () override
 Get the linear system matrix, or nullptr if this solver does not build it. More...
 
linearalgebra::BaseVectorgetSystemRHBaseVector () override
 Get the linear system right-hand term vector, or nullptr if this solver does not build it. More...
 
linearalgebra::BaseVectorgetSystemLHBaseVector () override
 Get the linear system left-hand term vector, or nullptr if this solver does not build it. More...
 
sofa::component::linearsystem::TypedMatrixLinearSystem< Matrix, Vector > * getLinearSystem () const
 Returns the linear system component associated to the linear solver. More...
 
void solveSystem () override
 Solve the system as constructed using the previous methods. More...
 
void applySystemSolution ()
 Apply the solution of the system to all the objects. More...
 
void invertSystem () override
 Invert the system, this method is optional because it's call when solveSystem() is called for the first time. More...
 
void prepareVisitor (simulation::Visitor *v)
 
void prepareVisitor (simulation::BaseMechanicalVisitor *v)
 
template<class T >
void executeVisitor (T v)
 
template<class T >
void executeVisitor (T *v)
 
bool isAsyncSolver () override
 Indicate if the solver update the system in parallel. More...
 
void invert (Matrix &) override
 
void solve (Matrix &M, Vector &solution, Vector &rh) override=0
 
virtual bool addJMInvJtLocal (Matrix *, ResMatrixType *result, const JMatrixType *J, SReal fact)
 
virtual bool addMInvJtLocal (Matrix *, ResMatrixType *result, const JMatrixType *J, SReal fact)
 
bool addJMInvJt (linearalgebra::BaseMatrix *result, linearalgebra::BaseMatrix *J, SReal fact) override
 
bool addMInvJt (linearalgebra::BaseMatrix *result, linearalgebra::BaseMatrix *J, SReal fact) override
 
bool buildComplianceMatrix (const core::ConstraintParams *cparams, linearalgebra::BaseMatrix *result, SReal fact) override
 
void applyConstraintForce (const sofa::core::ConstraintParams *cparams, sofa::core::MultiVecDerivId dx, const linearalgebra::BaseVector *f) override
 Apply the contactforce dx = Minv * J^t * f and store the result in dx VecId. More...
 
void computeResidual (const core::ExecParams *params, linearalgebra::BaseVector *f) override
 
MatrixInvertDatagetMatrixInvertData (linearalgebra::BaseMatrix *m)
 
- Public Member Functions inherited from sofa::component::linearsolver::BaseMatrixLinearSolver< Matrix, Vector >
 SOFA_CLASS (SOFA_TEMPLATE2(BaseMatrixLinearSolver, Matrix, Vector), sofa::core::behavior::LinearSolver)
 
- Public Member Functions inherited from sofa::core::behavior::LinearSolver
 SOFA_ABSTRACT_CLASS (LinearSolver, BaseLinearSolver)
 
virtual bool supportNonSymmetricSystem () const
 Returns true if the solver supports non-symmetric systems. More...
 
virtual bool hasUpdatedMatrix ()
 Indicate if the solver updated the system after the last call of setSystemMBKMatrix (should return true if isParallelSolver return false) More...
 
virtual void updateSystemMatrix ()
 This function is use for the preconditioner it must be called at each time step event if setSystemMBKMatrix is not called. More...
 
virtual void init_partial_solve ()
 
virtual void partial_solve (std::list< linearalgebra::BaseMatrix::Index > &, std::list< linearalgebra::BaseMatrix::Index > &, bool)
 
virtual linearalgebra::BaseMatrixgetSystemInverseBaseMatrix ()
 Get the linear system inverse matrix, or nullptr if this solver does not build it. More...
 
virtual bool readFile (std::istream &)
 Read the Matrix solver from a file. More...
 
virtual bool writeFile (std::ostream &)
 Read the Matrix solver from a file. More...
 
virtual void freezeSystemMatrix ()
 Ask the solver to no longer update the system matrix. More...
 
- Public Member Functions inherited from sofa::core::behavior::BaseLinearSolver
 SOFA_ABSTRACT_CLASS (BaseLinearSolver, objectmodel::BaseObject)
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void draw (const core::visual::VisualParams *)
 Render internal data of this object, for debugging purposes. More...
 
virtual void computeBBox (const core::ExecParams *, bool=false)
 
void setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
 Sets a source Object and parses it to collect dependent Data. More...
 
void setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
 
BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const override
 Return the full path name of this object. More...
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
virtual void handleEvent (Event *)
 Handle an event. More...
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual void bwdInit ()
 Initialization method called at graph creation and modification, during bottom-up traversal. More...
 
virtual void reinit ()
 Update method called when variables used in precomputation are modified. More...
 
void updateInternal ()
 Update method called when variables (used to compute other internal variables) are modified. More...
 
virtual void storeResetState ()
 Save the initial state for later uses in reset() More...
 
virtual void reset ()
 Reset to initial state. More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
void addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
 
void addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
 
void addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
 
const std::string & getName () const
 Accessor to the object name. More...
 
void setName (const std::string &n)
 Set the name of this object. More...
 
void setName (const std::string &n, int counter)
 Set the name of this object, adding an integer counter. More...
 
std::string getTypeName () const
 Get the type name of this object (i.e. class and template types) More...
 
virtual std::string getClassName () const
 Get the class name of this object. More...
 
virtual std::string getTemplateName () const final
 Get the template type names (if any) used to instantiate this object. More...
 
std::string getNameSpaceName () const
 Get the template type names (if any) used to instantiate this object. More...
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 Set the source filename (where the component is implemented) More...
 
const std::string & getDefinitionSourceFileName () const
 Get the source filename (where the component is implemented) More...
 
void setDefinitionSourceFilePos (const int)
 Set the source location (where the component is implemented) More...
 
int getDefinitionSourceFilePos () const
 Get the source location (where the component is implemented) More...
 
void setInstanciationSourceFileName (const std::string &sourceFileName)
 
const std::string & getInstanciationSourceFileName () const
 
void setInstanciationSourceFilePos (const int)
 
int getInstanciationSourceFilePos () const
 
void addMessage (const sofa::helper::logging::Message &m) const
 
size_t countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
const std::deque< sofa::helper::logging::Message > & getLoggedMessages () const
 
const std::string getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
void clearLoggedMessages () const
 
bool notMuted () const
 
const sofa::core::objectmodel::TagSetgetTags () const
 Represents the subsets the object belongs to. More...
 
bool hasTag (Tag t) const
 Return true if the object belong to the given subset. More...
 
void addTag (Tag t)
 Add a subset qualification to the object. More...
 
void removeTag (Tag t)
 Remove a subset qualification to the object. More...
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 Assign one field value (Data or Link) More...
 
virtual bool hasField (const std::string &attribute) const
 Check if a given Data field or Link exists. More...
 
void parseFields (const std::list< std::string > &str)
 Assign the field values stored in the given list of name + value pairs of strings. More...
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 Assign the field values stored in the given map of name -> value pairs. More...
 
void writeDatas (std::map< std::string, std::string * > &str)
 Write the current field values to the given map of name -> value pairs. More...
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 Find data fields given a name: several can be found as we look into the alias map. More...
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 Find link fields given a name: several can be found as we look into the alias map. More...
 
virtual void updateLinks (bool logErrors=true)
 Update pointers in case the pointed-to objects have appeared. More...
 
template<class T >
BaseData::BaseInitData initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 Remove a data field. More...
 
void addAlias (BaseData *field, const char *alias)
 Add an alias to a Data. More...
 
void addLink (BaseLink *l)
 Add a link. More...
 
void addAlias (BaseLink *link, const char *alias)
 Add an alias to a Link. More...
 
const VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Static Public Member Functions

static std::string GetCustomTemplateName ()
 
- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 Pre-construction check method called by ObjectFactory. More...
 
template<class T >
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 Construction method called by ObjectFactory. More...
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Protected Member Functions

virtual void checkLinearSystem ()
 
template<class TLinearSystemType >
void doCheckLinearSystem ()
 
template<class TLinearSystemType >
void createDefaultLinearSystem ()
 
virtual void partial_solve (Matrix &, Vector &, Vector &, ListIndex &, ListIndex &)
 newPartially solve the system More...
 
Vector * createPersistentVector ()
 
Matrix * createMatrix ()
 
virtual MatrixInvertDatacreateInvertData ()
 
bool singleThreadAddJMInvJtLocal (Matrix *, ResMatrixType *result, const JMatrixType *J, SReal fact)
 
- Protected Member Functions inherited from sofa::core::behavior::LinearSolver
 LinearSolver ()
 
 ~LinearSolver () override
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 Implementation of the internal update. More...
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
 This method insures that slaves objects have master and context links set correctly. More...
 
void trackInternalData (const BaseData &data)
 Method called to add the Data to the DataTracker (listing the Data to track) More...
 
void cleanTracker ()
 
bool hasDataChanged (const BaseData &data)
 Method called to know if a tracked Data has changed. More...
 
- Protected Member Functions inherited from sofa::core::objectmodel::Base
 Base ()
 
virtual ~Base ()
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
 Helper method used by initData() More...
 
template<class T >
void initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 

Static Protected Member Functions

static void deletePersistentVector (Vector *v)
 
static void deleteMatrix (Matrix *v)
 

Attribute details

◆ currentBFactor

template<class Matrix , class Vector >
SReal sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentBFactor
protected

◆ currentKFactor

template<class Matrix , class Vector >
SReal sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentKFactor
protected

◆ currentMFactor

template<class Matrix , class Vector >
SReal sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentMFactor
protected

◆ d_parallelInverseProduct

template<class Matrix , class Vector >
Data<bool> sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::d_parallelInverseProduct

◆ internalData

template<class Matrix , class Vector >
MatrixLinearSolverInternalData<Vector> sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::internalData
protected

◆ invertData

template<class Matrix , class Vector >
std::unique_ptr<MatrixInvertData> sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::invertData
protected

◆ l_linearSystem

◆ linearSystem

template<class Matrix , class Vector >
LinearSystemData sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::linearSystem
protected

Constructor details

◆ MatrixLinearSolver()

template<class Matrix , class Vector >
sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::MatrixLinearSolver ( )

◆ ~MatrixLinearSolver()

template<class Matrix , class Vector >
sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::~MatrixLinearSolver ( )
override

Function details

◆ addJMInvJt()

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addJMInvJt ( linearalgebra::BaseMatrix result,
linearalgebra::BaseMatrix J,
SReal  fact 
)
overridevirtual

Multiply the inverse of the system matrix by the transpose of the given matrix, and multiply the result with the given matrix J

This method can compute the Schur complement of the constrained system: W = H A^{-1} H^T, where:

  • A is the mechanical matrix
  • H is the constraints matrix
  • W is the compliance matrix projected in the constraints space
Parameters
resultthe variable where the result will be added
Jthe matrix J to use
factintegrator parameter
Returns
false if the solver does not support this operation, of it the system matrix is not invertible

Reimplemented from sofa::core::behavior::LinearSolver.

◆ addJMInvJtLocal()

template<class Matrix , class Vector >
virtual bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addJMInvJtLocal ( Matrix *  ,
ResMatrixType result,
const JMatrixType J,
SReal  fact 
)
virtual

◆ addMInvJt()

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addMInvJt ( linearalgebra::BaseMatrix result,
linearalgebra::BaseMatrix J,
SReal  fact 
)
overridevirtual

Multiply the inverse of the system matrix by the transpose of the given matrix J

Parameters
resultthe variable where the result will be added
Jthe matrix J to use
factintegrator parameter
Returns
false if the solver does not support this operation, of it the system matrix is not invertible

Reimplemented from sofa::core::behavior::LinearSolver.

◆ addMInvJtLocal()

template<class Matrix , class Vector >
virtual bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addMInvJtLocal ( Matrix *  ,
ResMatrixType result,
const JMatrixType J,
SReal  fact 
)
virtual

◆ applyConstraintForce()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::applyConstraintForce ( const sofa::core::ConstraintParams ,
sofa::core::MultiVecDerivId  ,
const linearalgebra::BaseVector  
)
overridevirtual

Apply the contactforce dx = Minv * J^t * f and store the result in dx VecId.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ applySystemSolution()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::applySystemSolution

Apply the solution of the system to all the objects.

◆ buildComplianceMatrix()

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::buildComplianceMatrix ( const core::ConstraintParams cparams,
linearalgebra::BaseMatrix result,
SReal  fact 
)
overridevirtual

Build the jacobian of the constraints using a visitor

Parameters
cparamscontains the MultiMatrixDerivId which allows to retrieve the constraint jacobian to use for each mechanical object.
resultthe variable where the result will be added
factintegrator parameter
Returns
false if the solver does not support this operation, of it the system matrix is not invertible

Reimplemented from sofa::core::behavior::LinearSolver.

◆ checkLinearSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::checkLinearSystem
protectedvirtual

◆ computeResidual()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::computeResidual ( const core::ExecParams params,
linearalgebra::BaseVector f 
)
overridevirtual

Parallelize the computation of the product J*M^{-1}*J^T where M is the matrix of the linear system and J is any matrix with compatible dimensions

Reimplemented from sofa::core::behavior::LinearSolver.

◆ createDefaultLinearSystem()

template<class Matrix , class Vector >
template<class TLinearSystemType >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createDefaultLinearSystem ( )
protected

◆ createInvertData()

template<class Matrix , class Vector >
virtual MatrixInvertData* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createInvertData ( )
protectedvirtual

◆ createMatrix()

template<class Matrix , class Vector >
Matrix* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createMatrix ( )
protected

◆ createPersistentVector()

template<class Matrix , class Vector >
Vector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createPersistentVector ( )
protected

◆ deleteMatrix()

template<class Matrix , class Vector >
static void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::deleteMatrix ( Matrix *  v)
staticprotected

◆ deletePersistentVector()

template<class Matrix , class Vector >
static void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::deletePersistentVector ( Vector *  v)
staticprotected

◆ doCheckLinearSystem()

template<class Matrix , class Vector >
template<class TLinearSystemType >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::doCheckLinearSystem
protected

Check if compatible linear systems are available in the current context. Otherwise, a linear system of type TLinearSystemType is created, with a warning to the user.

Template Parameters
TLinearSystemTypeType of linear system created if no linear system found in the current context.

◆ executeVisitor() [1/2]

template<class Matrix , class Vector >
template<class T >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::executeVisitor ( T *  v)
inline

◆ executeVisitor() [2/2]

template<class Matrix , class Vector >
template<class T >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::executeVisitor ( v)
inline

◆ GetCustomTemplateName()

template<class Matrix , class Vector >
static std::string sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::GetCustomTemplateName ( )
inlinestatic

Implementing the GetCustomTemplateName is mandatory to have a custom template name parameters instead of the default one generated automatically by the SOFA_CLASS() macro.

◆ getLinearSystem()

template<class Matrix , class Vector >
sofa::component::linearsystem::TypedMatrixLinearSystem<Matrix, Vector>* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getLinearSystem ( ) const
inline

Returns the linear system component associated to the linear solver.

◆ getMatrixInvertData()

template<class Matrix , class Vector >
MatrixInvertData* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getMatrixInvertData ( linearalgebra::BaseMatrix m)

◆ getSystemBaseMatrix()

template<class Matrix , class Vector >
linearalgebra::BaseMatrix * sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemBaseMatrix
overridevirtual

Get the linear system matrix, or nullptr if this solver does not build it.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ getSystemLHBaseVector()

template<class Matrix , class Vector >
linearalgebra::BaseVector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemLHBaseVector ( )
inlineoverridevirtual

Get the linear system left-hand term vector, or nullptr if this solver does not build it.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ getSystemLHVector()

template<class Matrix , class Vector >
Vector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemLHVector ( )
inline

Get the linear system left-hand term vector, or nullptr if this solver does not build it.

◆ getSystemMatrix()

template<class Matrix , class Vector >
Matrix * sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemMatrix
overridevirtual

Get the linear system matrix, or nullptr if this solver does not build it.

Implements sofa::component::linearsolver::BaseMatrixLinearSolver< Matrix, Vector >.

◆ getSystemRHBaseVector()

template<class Matrix , class Vector >
linearalgebra::BaseVector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemRHBaseVector ( )
inlineoverridevirtual

Get the linear system right-hand term vector, or nullptr if this solver does not build it.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ getSystemRHVector()

template<class Matrix , class Vector >
Vector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemRHVector ( )
inline

Get the linear system right-hand term vector, or nullptr if this solver does not build it.

◆ init()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::init ( void  )
overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ invert()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::invert ( Matrix &  )
inlineoverridevirtual

◆ invertSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::invertSystem ( )
overridevirtual

Invert the system, this method is optional because it's call when solveSystem() is called for the first time.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ isAsyncSolver()

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::isAsyncSolver ( )
inlineoverridevirtual

Indicate if the solver update the system in parallel.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ partial_solve()

template<class Matrix , class Vector >
virtual void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::partial_solve ( Matrix &  ,
Vector &  ,
Vector &  ,
ListIndex ,
ListIndex  
)
inlineprotectedvirtual

newPartially solve the system

◆ prepareVisitor() [1/2]

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::prepareVisitor ( simulation::BaseMechanicalVisitor v)
inline

◆ prepareVisitor() [2/2]

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::prepareVisitor ( simulation::Visitor v)
inline

◆ rebuildSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::rebuildSystem ( SReal  massFactor,
SReal  forceFactor 
)
overridevirtual

Rebuild the system using a mass and force factor.

Reimplemented from sofa::core::behavior::LinearSolver.

◆ resetSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::resetSystem ( )
overridevirtual

Reset the current linear system.

Implements sofa::core::behavior::LinearSolver.

◆ resizeSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::resizeSystem ( Size  n)

Reset the current linear system.

◆ setSystemLHVector()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::setSystemLHVector ( core::MultiVecDerivId  v)
overridevirtual

Set the initial estimate of the linear system left-hand term vector, from the values contained in the (Mechanical/Physical)State objects This vector will be replaced by the solution of the system once solveSystem is called

Implements sofa::core::behavior::LinearSolver.

◆ setSystemMBKMatrix()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::setSystemMBKMatrix ( const core::MechanicalParams mparams)
overridevirtual

Set the linear system matrix, combining the mechanical M,B,K matrices using the given coefficients

Note that this automatically resizes the linear system to the number of active degrees of freedoms

Implements sofa::core::behavior::LinearSolver.

◆ setSystemRHVector()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::setSystemRHVector ( core::MultiVecDerivId  v)
overridevirtual

Set the linear system right-hand term vector, from the values contained in the (Mechanical/Physical)State objects.

Implements sofa::core::behavior::LinearSolver.

◆ singleThreadAddJMInvJtLocal()

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::singleThreadAddJMInvJtLocal ( Matrix *  ,
ResMatrixType result,
const JMatrixType J,
SReal  fact 
)
protected

◆ SOFA_ABSTRACT_CLASS()

template<class Matrix , class Vector >
sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::SOFA_ABSTRACT_CLASS ( SOFA_TEMPLATE3(MatrixLinearSolver< Matrix, Vector, NoThreadManager >, Matrix, Vector, NoThreadManager ,
SOFA_TEMPLATE2(BaseMatrixLinearSolver< Matrix, Vector, NoThreadManager >, Matrix, Vector)   
)

◆ solve()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::solve ( Matrix &  M,
Vector &  solution,
Vector &  rh 
)
overridepure virtual

◆ solveSystem()

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::solveSystem ( )
overridevirtual

Solve the system as constructed using the previous methods.

Implements sofa::core::behavior::LinearSolver.