SOFA API  c76874b7
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

class  GroupData
 
class  TempVectorContainer
 

Protected Attributes

MatrixLinearSolverInternalData< Vector > internalData
 
MatrixInvertDatainvertData
 
simulation::NodecurrentNode
 
GroupData * currentGroup
 
std::vector< simulation::Node * > groups
 
GroupDataMap gData
 
GroupData defaultGroup
 
double currentMFactor
 
double currentBFactor
 
double currentKFactor
 
- 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 resetSystem () override
 Reset the current linear system. More...
 
void resizeSystem (int n)
 Reset the current linear system. More...
 
void setSystemMBKMatrix (const core::MechanicalParams *mparams) override
 
void rebuildSystem (double massFactor, double forceFactor) override
 Rebuild the system using a mass and force factor. More...
 
void setSystemMatrix (Matrix *matrix)
 Set the linear system matrix (only use for bench) More...
 
unsigned getSystemSize ()
 
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...
 
defaulttype::BaseMatrixgetSystemBaseMatrix () override
 Get the linear system matrix, or nullptr if this solver does not build it. More...
 
const core::behavior::MultiMatrixAccessorgetSystemMultiMatrixAccessor () const override
 Get the MultiMatrix view of the linear system, or nullptr if this solved does not build it. More...
 
defaulttype::BaseVectorgetSystemRHBaseVector () override
 Get the linear system right-hand term vector, or nullptr if this solver does not build it. More...
 
defaulttype::BaseVectorgetSystemLHBaseVector () override
 Get the linear system left-hand term vector, or nullptr if this solver does not build it. More...
 
void solveSystem () override
 Solve the system as constructed using the previous methods. 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, double fact)
 
virtual bool addMInvJtLocal (Matrix *, ResMatrixType *result, const JMatrixType *J, double fact)
 
bool addJMInvJt (defaulttype::BaseMatrix *result, defaulttype::BaseMatrix *J, double fact) override
 
bool addMInvJt (defaulttype::BaseMatrix *result, defaulttype::BaseMatrix *J, double fact) override
 
bool buildComplianceMatrix (const core::ConstraintParams *cparams, defaulttype::BaseMatrix *result, double fact) override
 
void applyConstraintForce (const sofa::core::ConstraintParams *cparams, sofa::core::MultiVecDerivId dx, const defaulttype::BaseVector *f) override
 Apply the contactforce dx = Minv * J^t * f and store the resut in dx VecId. More...
 
void computeResidual (const core::ExecParams *params, defaulttype::BaseVector *f) override
 
MatrixInvertDatagetMatrixInvertData (defaulttype::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 void rebuildSystem (SReal, SReal)
 
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< int > &, std::list< int > &, bool)
 
virtual bool addMInvJt (defaulttype::BaseMatrix *result, defaulttype::BaseMatrix *J, SReal fact)
 
virtual bool buildComplianceMatrix (const sofa::core::ConstraintParams *cparams, defaulttype::BaseMatrix *result, SReal fact)
 
virtual bool addJMInvJt (defaulttype::BaseMatrix *result, defaulttype::BaseMatrix *J, SReal fact)
 
virtual defaulttype::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)
 
void * findLinkDestClass (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...
 
template<class T >
T::SPtr searchLocal () const
 Local search of an object of the given type. More...
 
template<class T >
T::SPtr searchUp () const
 Upward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchDown () const
 Downward search of an object of the given type, starting from the local context. More...
 
template<class T >
T::SPtr searchFromRoot () const
 
template<class T >
T::SPtr searchInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal () const
 Local search of all objects of the given type. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp () const
 Upward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown () const
 Downward search of all objects of the given type, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot () const
 Search of all objects of the given type, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents () const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const Tag &t) const
 Local search of all objects of the given type with a given Tag. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const Tag &t) const
 Upward search of all objects of the given type with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const Tag &t) const
 Downward search of all objects of the given typee with a given Tag, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const Tag &t) const
 Search of all objects of the given typee with a given Tag, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const Tag &t) const
 
template<class T >
helper::vector< typename T::SPtr > searchAllLocal (const TagSet &t) const
 Local search of all objects of the given type with a given TagSet. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllUp (const TagSet &t) const
 Upward search of all objects of the given type with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllDown (const TagSet &t) const
 Downward search of all objects of the given typee with a given TagSet, starting from the local context. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllFromRoot (const TagSet &t) const
 Search of all objects of the given typee with a given TagSet, starting from the root. More...
 
template<class T >
helper::vector< typename T::SPtr > searchAllInParents (const TagSet &t) const
 
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 init ()
 Initialization method called at graph creation and modification, during top-down traversal. 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 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...
 
virtual 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
 Get the template type names (if any) used to instantiate this object. More...
 
virtual 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
 
const std::string getWarnings () const
 
const std::string getOutputs () const
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearWarnings ()
 use getLoggedMessageAsString() or getLoggedMessage instead. More...
 
void clearOutputs ()
 use clearLoggedMessages() instead More...
 
void processStream (std::ostream &out)
 use clearLoggedMessages() instead More...
 
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
 
bool IsInheritingFromBase ()
 
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 (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 void dynamicCast (T *&ptr, Base *b)
 
template<class T >
static std::string typeName (const T *ptr=nullptr)
 
template<class T >
static std::string className (const T *ptr=nullptr)
 
template<class T >
static std::string namespaceName (const T *ptr=nullptr)
 
template<class T >
static std::string templateName (const T *ptr=nullptr)
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Protected Member Functions

virtual void partial_solve (Matrix &, Vector &, Vector &, ListIndex &, ListIndex &)
 newPartially solve the system More...
 
Vector * createPersistentVector ()
 
Matrix * createMatrix ()
 
virtual MatrixInvertDatacreateInvertData ()
 
- 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, unsigned int, 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)
 

Additional Inherited Members

- 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
helper::system::SofaOStream< helper::logging::Message::Warningserr
 
helper::system::SofaOStream< helper::logging::Message::Infosout
 
helper::system::SofaEndl< Basesendl
 runs the stream processing More...
 
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 objet belongs to More...
 
Data< sofa::defaulttype::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
DeprecatedAndRemoved m_componentstate
 
DeprecatedAndRemoved d_componentstate
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Attribute details

template<class Matrix , class Vector >
double sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentBFactor
protected
template<class Matrix , class Vector >
GroupData* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentGroup
protected
template<class Matrix , class Vector >
double sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentKFactor
protected
template<class Matrix , class Vector >
double sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentMFactor
protected
template<class Matrix , class Vector >
simulation::Node* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::currentNode
protected
template<class Matrix , class Vector >
GroupData sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::defaultGroup
protected
template<class Matrix , class Vector >
GroupDataMap sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::gData
protected
template<class Matrix , class Vector >
std::vector<simulation::Node*> sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::groups
protected
template<class Matrix , class Vector >
MatrixLinearSolverInternalData<Vector> sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::internalData
protected
template<class Matrix , class Vector >
MatrixInvertData* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::invertData
protected

Constructor details

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

Function details

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addJMInvJt ( defaulttype::BaseMatrix result,
defaulttype::BaseMatrix J,
double  fact 
)
override
template<class Matrix , class Vector >
virtual bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addJMInvJtLocal ( Matrix *  ,
ResMatrixType result,
const JMatrixType J,
double  fact 
)
virtual
template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addMInvJt ( defaulttype::BaseMatrix result,
defaulttype::BaseMatrix J,
double  fact 
)
override
template<class Matrix , class Vector >
virtual bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::addMInvJtLocal ( Matrix *  ,
ResMatrixType result,
const JMatrixType J,
double  fact 
)
virtual
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::applyConstraintForce ( const sofa::core::ConstraintParams ,
sofa::core::MultiVecDerivId  ,
const defaulttype::BaseVector  
)
overridevirtual

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

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

template<class Matrix , class Vector >
bool sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::buildComplianceMatrix ( const core::ConstraintParams cparams,
defaulttype::BaseMatrix result,
double  fact 
)
override
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::computeResidual ( const core::ExecParams ,
defaulttype::BaseVector  
)
overridevirtual

Compute the residual in the newton iterations due to the constraints forces i.e. compute mparams->dF() = J^t lambda the result is written in mparams->dF()

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

template<class Matrix , class Vector >
virtual MatrixInvertData* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createInvertData ( )
protectedvirtual
template<class Matrix , class Vector >
Matrix* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createMatrix ( )
protected
template<class Matrix , class Vector >
Vector* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::createPersistentVector ( )
protected
template<class Matrix , class Vector >
static void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::deleteMatrix ( Matrix *  v)
staticprotected
template<class Matrix , class Vector >
static void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::deletePersistentVector ( Vector *  v)
staticprotected
template<class Matrix , class Vector >
template<class T >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::executeVisitor ( v)
inline
template<class Matrix , class Vector >
template<class T >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::executeVisitor ( T *  v)
inline
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 paremters instead of the default one generated automatically by the SOFA_CLASS() macro.

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

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

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

template<class Matrix , class Vector >
defaulttype::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.

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.

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

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

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

template<class Matrix , class Vector >
const core::behavior::MultiMatrixAccessor* sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemMultiMatrixAccessor ( ) const
inlineoverridevirtual

Get the MultiMatrix view of the linear system, or nullptr if this solved does not build it.

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

template<class Matrix , class Vector >
defaulttype::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.

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.

template<class Matrix , class Vector >
unsigned sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::getSystemSize ( )
inline
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::invert ( Matrix &  )
inlineoverridevirtual
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.

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.

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

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::prepareVisitor ( simulation::Visitor v)
inline
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::prepareVisitor ( simulation::BaseMechanicalVisitor v)
inline
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::rebuildSystem ( double  massFactor,
double  forceFactor 
)
override

Rebuild the system using a mass and force factor.

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.

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

Reset the current linear system.

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.

template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::setSystemMatrix ( Matrix *  matrix)

Set the linear system matrix (only use for bench)

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.

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.

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)   
)
template<class Matrix , class Vector >
void sofa::component::linearsolver::MatrixLinearSolver< Matrix, Vector, NoThreadManager >::solve ( Matrix &  M,
Vector &  solution,
Vector &  rh 
)
overridepure virtual
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.