sofa::core::componentmodel::behavior::MultiMatrix< Parent > Class Template Reference

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

#include <MultiMatrix.h>

Collaboration diagram for sofa::core::componentmodel::behavior::MultiMatrix< Parent >:

[legend]

Public Types
typedef BaseMechanicalState::VecId	VecId
Public Member Functions
	MultiMatrix (Parent *parent)
	~MultiMatrix ()
void	clear ()
	m = 0
void	reset ()
	m = 0
void	operator= (const MechanicalMatrix &m)
	m = m*M+b*B+k*K
void	solve (MultiVector< Parent > &solution, MultiVector< Parent > &rh)
Protected Member Functions
	MultiMatrix (const MultiMatrix< Parent > &)
	Copy-constructor is forbidden.
Protected Attributes
Parent *	parent
	Solver who is using this vector.
VecId	v
	Identifier of this vector.
Friends
std::ostream &	operator<< (std::ostream &out, const MultiMatrix< Parent > &m)

---

Detailed Description

template<class Parent>
class sofa::core::componentmodel::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.

Definition at line 99 of file MultiMatrix.h.

---

Member Typedef Documentation

template<class Parent >

typedef BaseMechanicalState::VecId sofa::core::componentmodel::behavior::MultiMatrix< Parent >::VecId

Definition at line 102 of file MultiMatrix.h.

---

Constructor & Destructor Documentation

template<class Parent >

sofa::core::componentmodel::behavior::MultiMatrix< Parent >::MultiMatrix

(

const MultiMatrix< Parent > &

)

[protected]

Copy-constructor is forbidden.

template<class Parent >

sofa::core::componentmodel::behavior::MultiMatrix< Parent >::MultiMatrix

(

Parent *

parent

)

[inline]

Definition at line 116 of file MultiMatrix.h.

template<class Parent >

sofa::core::componentmodel::behavior::MultiMatrix< Parent >::~MultiMatrix

(

)

[inline]

Definition at line 120 of file MultiMatrix.h.

---

Member Function Documentation

template<class Parent >

void sofa::core::componentmodel::behavior::MultiMatrix< Parent >::clear

(

)

[inline]

m = 0

Definition at line 125 of file MultiMatrix.h.

References sofa::core::componentmodel::behavior::MultiMatrix< Parent >::parent.

template<class Parent >

void sofa::core::componentmodel::behavior::MultiMatrix< Parent >::operator=

(

const MechanicalMatrix &

m

)

[inline]

m = m*M+b*B+k*K

Definition at line 137 of file MultiMatrix.h.

References sofa::core::componentmodel::behavior::MechanicalMatrix::getBFact(), sofa::core::componentmodel::behavior::MechanicalMatrix::getKFact(), sofa::core::componentmodel::behavior::MechanicalMatrix::getMFact(), and sofa::core::componentmodel::behavior::MultiMatrix< Parent >::parent.

template<class Parent >

void sofa::core::componentmodel::behavior::MultiMatrix< Parent >::reset

(

)

[inline]

m = 0

Definition at line 131 of file MultiMatrix.h.

References sofa::core::componentmodel::behavior::MultiMatrix< Parent >::parent.

template<class Parent >

void sofa::core::componentmodel::behavior::MultiMatrix< Parent >::solve	(	MultiVector< Parent > &	solution,
		MultiVector< Parent > &	rh
	)			[inline]

Definition at line 142 of file MultiMatrix.h.

References sofa::core::componentmodel::behavior::MultiMatrix< Parent >::parent.

Referenced by sofa::component::odesolver::StaticSolver::solve(), and sofa::component::odesolver::EulerImplicitSolver::solve().

---

Friends And Related Function Documentation

template<class Parent >

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

Definition at line 148 of file MultiMatrix.h.

---

Field Documentation

template<class Parent >

Parent* sofa::core::componentmodel::behavior::MultiMatrix< Parent >::parent [protected]

Solver who is using this vector.

Definition at line 106 of file MultiMatrix.h.

Referenced by sofa::core::componentmodel::behavior::MultiMatrix< Parent >::clear(), sofa::core::componentmodel::behavior::MultiMatrix< Parent >::operator=(), sofa::core::componentmodel::behavior::MultiMatrix< Parent >::reset(), and sofa::core::componentmodel::behavior::MultiMatrix< Parent >::solve().

template<class Parent >

VecId sofa::core::componentmodel::behavior::MultiMatrix< Parent >::v [protected]

Identifier of this vector.

Definition at line 109 of file MultiMatrix.h.

---

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

• framework/sofa/core/componentmodel/behavior/MultiMatrix.h