Detailed Description

Collection of basic methods every equation system must provide.

Definition at line 30 of file EquationSystem.h.

Inheritance diagram for NumLib::EquationSystem:

[legend]

Collaboration diagram for NumLib::EquationSystem:

[legend]

Public Member Functions
virtual bool	isLinear () const =0

virtual void	preIteration (const unsigned iter, GlobalVector const &x)

virtual IterationResult	postIteration (GlobalVector const &x)

Public Member Functions inherited from NumLib::MatrixSpecificationsProvider
virtual MathLib::MatrixSpecifications	getMatrixSpecifications (const int process_id) const =0

virtual	~MatrixSpecificationsProvider ()=default

Member Function Documentation

virtual bool NumLib::EquationSystem::isLinear ( ) const

pure virtual

Check whether this is actually a linear equation system.

Remarks: Depending on its parameters an in general nonlinear equation system can be linear in special cases. With this method it is possible to detect that at runtime and thus save some computations.

virtual IterationResult NumLib::EquationSystem::postIteration ( GlobalVector const & x )

inlinevirtual

Post-processes an iteration in the solution process of this equation.

Parameters

x	the current approximate solution of the equation.

Definition at line 59 of file EquationSystem.h.

     {
         (void)x;  // by default do nothing
         return IterationResult::SUCCESS;
     }

virtual void NumLib::EquationSystem::preIteration	(	const unsigned	iter,
		GlobalVector const &	x
	)

inlinevirtual

Prepares a new iteration in the solution process of this equation.

Parameters

iter	the current iteration number, starting from 1.
x	the current approximate solution of the equation.

Definition at line 47 of file EquationSystem.h.

     {
         (void)iter;
         (void)x;  // by default do nothing
     }

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