Inheritance diagram for SurgSim::Math::MockOdeSolver:

Public Member Functions
	MockOdeSolver (OdeEquation *equation)
	Constructor. More...

virtual	~MockOdeSolver ()
	Virtual destructor.

void	solve (double dt, const OdeState &currentState, OdeState *newState, bool computeCompliance=true) override
	Solves the equation. More...

void	assembleLinearSystem (double dt, const OdeState &state, const OdeState &newState, bool computeRHS) override
	Assemble the linear system (A.x=b) to be solved for the state and new states (useful for certain ode solver). More...

Public Member Functions inherited from SurgSim::Math::OdeSolver
	OdeSolver (OdeEquation *equation)
	Constructor. More...

virtual	~OdeSolver ()
	Virtual destructor.

const std::string	getName () const
	Gets the solver's name. More...

void	setLinearSolver (std::shared_ptr< LinearSparseSolveAndInverse > linearSolver)
	Sets the specialized linear solver to use with this Ode solver. More...

std::shared_ptr< LinearSparseSolveAndInverse >	getLinearSolver () const
	Gets the specialized linear solver used with this Ode solver. More...

void	computeMatrices (double dt, const OdeState &state, bool computeCompliance=true)
	Computes the system and compliance matrices for a given state. More...

const SparseMatrix &	getSystemMatrix () const
	Queries the current system matrix. More...

const Matrix &	getComplianceMatrix () const

Additional Inherited Members
Protected Member Functions inherited from SurgSim::Math::OdeSolver
void	computeComplianceMatrixFromSystemMatrix (const OdeState &state)
	Helper method computing the compliance matrix from the system matrix and setting the boundary conditions. More...

Protected Attributes inherited from SurgSim::Math::OdeSolver
std::string	m_name
	Name for this solver. More...

OdeEquation &	m_equation
	The ode equation (API providing the necessary evaluation methods and the initial state)

std::shared_ptr< LinearSparseSolveAndInverse >	m_linearSolver
	The specialized linear solver to use when solving the ode equation.

SparseMatrix	m_systemMatrix
	Linear system matrix (can be M, K, combination of MDK depending on the solver), including boundary conditions. More...

Vector	m_solution
	Linear system solution and rhs vectors (including boundary conditions)

Vector	m_rhs

Matrix	m_complianceMatrix
	Compliance matrix which is the inverse of the system matrix, including boundary conditions.

Constructor & Destructor Documentation

§ MockOdeSolver()

SurgSim::Math::MockOdeSolver::MockOdeSolver ( OdeEquation * equation )

inlineexplicit

Constructor.

Parameters

equation The ode equation to be solved

void SurgSim::Math::MockOdeSolver::assembleLinearSystem	(	double	dt,
		const OdeState &	state,
		const OdeState &	newState,
		bool	computeRHS
	)

inlineoverridevirtual

Assemble the linear system (A.x=b) to be solved for the state and new states (useful for certain ode solver).

Parameters

dt	The time step used in the system
state,newState	The state and newState to be used to evaluate the system
computeRHS	True to compute the RHS vector, False otherwise

Note: The method should fill up the LHS matrix in m_systemMatrix and the RHS vector in m_b (if requested); The method should take care of the boundary conditions properly on both the matrix and the vector.; The method should prepare the linear solver m_linearSolver to be used with the m_systemMatrix

void SurgSim::Math::MockOdeSolver::solve	(	double	dt,
		const OdeState &	currentState,
		OdeState *	newState,
		bool	computeCompliance = `true`
	)

inlineoverridevirtual

Solves the equation.

Parameters

	dt	The time step
	currentState	State at time t
[out]	newState	State at time t+dt
	computeCompliance	True to explicitly compute the compliance matrix, False otherwise

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