SOFA API  b3f2f2a4
Open source framework for multi-physics simuation
sofa::core::behavior::MultiMatrix< Parent > Class Template Reference

#include <MultiMatrix.h>

Detailed Description

template<class Parent>
class sofa::core::behavior::MultiMatrix< Parent >

Helper class providing a high-level view of underlying linear system matrices.

It is used to convert math-like operations to call to computation methods.

Protected Attributes

Parent * parent { nullptr }
 Solver who is using this matrix. More...
 

Public Member Functions

 MultiMatrix (const MultiMatrix< Parent > &)=delete
 Copy-constructor is forbidden. More...
 
 MultiMatrix (Parent *parent)
 
 ~MultiMatrix ()=default
 
void clear ()
 m = 0 More...
 
void reset ()
 m = 0 More...
 
void setSystemMBKMatrix (const MechanicalMatrix &m)
 
void solve (MultiVecDerivId solution, MultiVecDerivId rh)
 

Friends

std::ostream & operator<< (std::ostream &out, const MultiMatrix< Parent > &m)
 

Attribute details

◆ parent

template<class Parent >
Parent* sofa::core::behavior::MultiMatrix< Parent >::parent { nullptr }
protected

Solver who is using this matrix.

Constructor details

◆ MultiMatrix() [1/2]

template<class Parent >
sofa::core::behavior::MultiMatrix< Parent >::MultiMatrix ( const MultiMatrix< Parent > &  )
delete

Copy-constructor is forbidden.

◆ MultiMatrix() [2/2]

template<class Parent >
sofa::core::behavior::MultiMatrix< Parent >::MultiMatrix ( Parent *  parent)
inlineexplicit

◆ ~MultiMatrix()

template<class Parent >
sofa::core::behavior::MultiMatrix< Parent >::~MultiMatrix ( )
default

Function details

◆ clear()

template<class Parent >
void sofa::core::behavior::MultiMatrix< Parent >::clear ( )
inline

m = 0

◆ reset()

template<class Parent >
void sofa::core::behavior::MultiMatrix< Parent >::reset ( )
inline

m = 0

◆ setSystemMBKMatrix()

template<class Parent >
void sofa::core::behavior::MultiMatrix< Parent >::setSystemMBKMatrix ( const MechanicalMatrix m)
inline

◆ solve()

template<class Parent >
void sofa::core::behavior::MultiMatrix< Parent >::solve ( MultiVecDerivId  solution,
MultiVecDerivId  rh 
)
inline

Related details

◆ operator<<

template<class Parent >
std::ostream& operator<< ( std::ostream &  out,
const MultiMatrix< Parent > &  m 
)
friend