#include <itkFEMLinearSystemWrapperItpack.h>

Inheritance diagram for itk::fem::LinearSystemWrapperItpack:

Collaboration diagram for itk::fem::LinearSystemWrapperItpack:

Detailed Description

LinearSystemWrapper class that uses Itpack numeric library functions to define and solve a sparse linear system of equations.

See Also: LinearSystemWrapper

Definition at line 51 of file itkFEMLinearSystemWrapperItpack.h.

Public Types
typedef std::vector < MatrixRepresentation >	MatrixHolder

typedef ItpackSparseMatrix	MatrixRepresentation

typedef LinearSystemWrapperItpack	Self

typedef LinearSystemWrapper	Superclass

typedef std::vector < VectorRepresentation >	VectorHolder

typedef double *	VectorRepresentation

Public Types inherited from itk::fem::LinearSystemWrapper
typedef std::vector< unsigned int >	ColumnArray

typedef const Self *	ConstPointer

typedef Self *	Pointer

typedef LinearSystemWrapper	Self

typedef Solution	Superclass

Public Types inherited from itk::fem::Solution
typedef const Self *	ConstPointer

typedef double	Float

typedef Self *	Pointer

typedef Solution	Self

typedef Solution	Superclass

Public Member Functions
virtual void	AddMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex) ITK_OVERRIDE

virtual void	AddSolutionValue (unsigned int i, Float value, unsigned int solutionIndex) ITK_OVERRIDE

virtual void	AddVectorValue (unsigned int i, Float value, unsigned int vectorIndex) ITK_OVERRIDE

virtual void	CopySolution2Vector (unsigned solutionIndex, unsigned int vectorIndex) ITK_OVERRIDE

virtual void	CopyVector2Solution (unsigned int vectorIndex, unsigned int solutionIndex) ITK_OVERRIDE

virtual void	DestroyMatrix (unsigned int matrixIndex) ITK_OVERRIDE

virtual void	DestroySolution (unsigned int solutionIndex) ITK_OVERRIDE

virtual void	DestroyVector (unsigned int vectorIndex) ITK_OVERRIDE

double	GetAccuracy () const

int	GetAdaptiveCaseSwitch () const

int	GetAdaptiveSwitch () const

virtual void	GetColumnsOfNonZeroMatrixElementsInRow (unsigned int row, ColumnArray &cols, unsigned int matrixIndex) ITK_OVERRIDE

int	GetCommunicationSwitch () const

double	GetDampingFactor () const

double	GetDigitsInError () const

double	GetDigitsInResidual () const

int	GetErrorAnalysisSwitch () const

int	GetErrorReportingLevel () const

double	GetEstimatedSpectralRadiusLU () const

double	GetEstimatedSpectralRadiusSSOR () const

double	GetLargestJacobiEigenvalueEstimate () const

virtual Float	GetMatrixValue (unsigned int i, unsigned int j, unsigned int matrixIndex) const ITK_OVERRIDE

int	GetMaximumNumberIterations () const

int	GetOutputNumber () const

double	GetOverrelaxationParameter ()

int	GetRedBlackOrderingSwitch ()

int	GetRemoveSwitch ()

double	GetSmallestJacobiEigenvalueEstimate ()

virtual Float	GetSolutionValue (unsigned int i, unsigned int solutionIndex) const ITK_OVERRIDE

int	GetSymmetricMatrixFlag ()

double	GetTimeForCall ()

double	GetTimeToConvergence ()

int	GetTimingSwitch ()

double	GetTolerance ()

virtual Float	GetVectorValue (unsigned int i, unsigned int vectorIndex) const ITK_OVERRIDE

int	GetWorkspaceUsed ()

virtual void	InitializeMatrix (unsigned int matrixIndex) ITK_OVERRIDE

virtual void	InitializeSolution (unsigned int solutionIndex) ITK_OVERRIDE

virtual void	InitializeVector (unsigned int vectorIndex) ITK_OVERRIDE

virtual bool	IsMatrixInitialized (unsigned int matrixIndex) ITK_OVERRIDE

virtual bool	IsSolutionInitialized (unsigned int solutionIndex) ITK_OVERRIDE

virtual bool	IsVectorInitialized (unsigned int vectorIndex) ITK_OVERRIDE

void	JacobianConjugateGradient ()

void	JacobianSemiIterative ()

	LinearSystemWrapperItpack ()

virtual void	MultiplyMatrixMatrix (unsigned int resultMatrixIndex, unsigned int leftMatrixIndex, unsigned int rightMatrixIndex) ITK_OVERRIDE

virtual void	MultiplyMatrixSolution (unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int solutionIndex) ITK_OVERRIDE

virtual void	MultiplyMatrixVector (unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int vectorIndex) ITK_OVERRIDE

void	ReducedSystemConjugateGradient ()

void	ReducedSystemSemiIteration ()

virtual void	ScaleMatrix (Float scale, unsigned int matrixIndex) ITK_OVERRIDE

void	SetAccuracy (double i)

void	SetAdaptiveCaseSwitch (int i)

void	SetAdaptiveSwitch (int i)

void	SetCommunicationSwitch (int i)

void	SetDampingFactor (double i)

void	SetDigitsInError (double i)

void	SetDigitsInResidual (double i)

void	SetErrorAnalysisSwitch (int i)

void	SetEstimatedSpectralRadiusLU (double i)

void	SetEstimatedSpectralRadiusSSOR (double i)

void	SetLargestJacobiEigenvalueEstimate (double i)

virtual void	SetMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex) ITK_OVERRIDE

virtual void	SetMaximumNonZeroValuesInMatrix (unsigned int maxNonZeroValues)

void	SetMaximumNumberIterations (int i)

void	SetOverrelaxationParameter (double i)

void	SetRedBlackOrderingSwitch (int i)

void	SetRemoveSwitch (int i)

void	SetSmallestJacobiEigenvalueEstimate (double i)

virtual void	SetSolutionValue (unsigned int i, Float value, unsigned int solutionIndex) ITK_OVERRIDE

void	SetSymmetricMatrixFlag (int i)

void	SetTimeForCall (double i)

void	SetTimeToConvergence (double i)

void	SetTimingSwitch (int i)

void	SetTolerance (double i)

virtual void	SetVectorValue (unsigned int i, Float value, unsigned int vectorIndex) ITK_OVERRIDE

void	SetWorkspaceUsed (int i)

virtual void	Solve (void) ITK_OVERRIDE

void	SuccessiveOverrelaxation ()

virtual void	SwapMatrices (unsigned int matrixIndex1, unsigned int matrixIndex2) ITK_OVERRIDE

virtual void	SwapSolutions (unsigned int solutionIndex1, unsigned int solutionIndex2) ITK_OVERRIDE

virtual void	SwapVectors (unsigned int vectorIndex1, unsigned int vectorIndex2) ITK_OVERRIDE

void	SymmetricSuccessiveOverrelaxationConjugateGradient ()

void	SymmetricSuccessiveOverrelaxationSuccessiveOverrelaxation ()

	~LinearSystemWrapperItpack ()

Public Member Functions inherited from itk::fem::LinearSystemWrapper
virtual void	AddMatrixMatrix (unsigned int matrixIndex1, unsigned int matrixIndex2)

virtual void	AddVectorVector (unsigned int vectorIndex1, unsigned int vectorIndex2)

virtual void	Clean (void)

virtual void	CopyMatrix (unsigned int matrixIndex1, unsigned int matrixIndex2)

virtual void	CopySolution2Vector (unsigned int solutionIndex, unsigned int vectorIndex)=0

virtual void	CopyVector (unsigned int vectorSource, unsigned int vectorDestination)

unsigned int	GetNumberOfMatrices () const

unsigned int	GetNumberOfSolutions () const

unsigned int	GetNumberOfVectors () const

unsigned int	GetSystemOrder () const

virtual void	OptimizeMatrixStorage (unsigned int matrixIndex, unsigned int tempMatrixIndex)

virtual void	ReverseCuthillMckeeOrdering (ColumnArray &newNumbering, unsigned int matrixIndex=0)

void	ScaleSolution (Float scale, unsigned int solutionIndex=0)

void	ScaleVector (Float scale, unsigned int vectorIndex=0)

void	SetNumberOfMatrices (unsigned int nMatrices)

void	SetNumberOfSolutions (unsigned int nSolutions)

void	SetNumberOfVectors (unsigned int nVectors)

void	SetSystemOrder (unsigned int N)

virtual	~LinearSystemWrapper ()

	LinearSystemWrapper ()

Public Member Functions inherited from itk::fem::Solution
virtual	~Solution ()

Private Attributes
integer	m_IPARM [12]

MatrixHolder *	m_Matrices

unsigned int	m_MaximumNonZeroValues

integer	m_Method

ItkItpackSolverFunction	m_Methods [7]

doublereal	m_RPARM [12]

VectorHolder *	m_Solutions

VectorHolder *	m_Vectors

Additional Inherited Members
Protected Attributes inherited from itk::fem::LinearSystemWrapper
unsigned int	m_NumberOfMatrices

unsigned int	m_NumberOfSolutions

unsigned int	m_NumberOfVectors

unsigned int	m_Order

Member Typedef Documentation

typedef std::vector<MatrixRepresentation> itk::fem::LinearSystemWrapperItpack::MatrixHolder

vector of matrices typedef

Definition at line 65 of file itkFEMLinearSystemWrapperItpack.h.

typedef ItpackSparseMatrix itk::fem::LinearSystemWrapperItpack::MatrixRepresentation

matrix representatin typedef

Definition at line 62 of file itkFEMLinearSystemWrapperItpack.h.

typedef LinearSystemWrapperItpack itk::fem::LinearSystemWrapperItpack::Self

Standard "Self" typedef.

Definition at line 56 of file itkFEMLinearSystemWrapperItpack.h.

typedef LinearSystemWrapper itk::fem::LinearSystemWrapperItpack::Superclass

Standard "Superclass" typedef.

Definition at line 59 of file itkFEMLinearSystemWrapperItpack.h.

typedef std::vector<VectorRepresentation> itk::fem::LinearSystemWrapperItpack::VectorHolder

vector of vector typedef

Definition at line 75 of file itkFEMLinearSystemWrapperItpack.h.

typedef double* itk::fem::LinearSystemWrapperItpack::VectorRepresentation

vector representation typedef

Definition at line 72 of file itkFEMLinearSystemWrapperItpack.h.

Constructor & Destructor Documentation

itk::fem::LinearSystemWrapperItpack::LinearSystemWrapperItpack ( )

Functions required by LinearSystemWrapper

constructor

itk::fem::LinearSystemWrapperItpack::~LinearSystemWrapperItpack ( )

destructor

Member Function Documentation

virtual void itk::fem::LinearSystemWrapperItpack::AddMatrixValue	(	unsigned int	i,
		unsigned int	j,
		Float	value,
		unsigned int	matrixIndex
	)

virtual

Virtual function to add a value to a specific element of the A matrix.

Parameters

i	row of the element
j	column of the element
value	value to add to the existing element
matrixIndex	index of matrix to add value to

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::AddSolutionValue	(	unsigned int	i,
		Float	value,
		unsigned int	solutionIndex
	)

virtual

Virtual function to add a value of specific element of the solution vector.

Parameters

i	element Index in solution vector
value	new value of the element
solutionIndex	index of solution vector to add value to

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::AddVectorValue	(	unsigned int	i,
		Float	value,
		unsigned int	vectorIndex
	)

virtual

Virtual function to add a value to a specific element of the B vector.

Parameters

i	row of the element
value	value to add to the existing element
vectorIndex	index of vector to add value to

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::CopySolution2Vector	(	unsigned	solutionIndex,
		unsigned int	vectorIndex
	)

virtual

virtual void itk::fem::LinearSystemWrapperItpack::CopyVector2Solution	(	unsigned int	vectorIndex,
		unsigned int	solutionIndex
	)

virtual

Copy a vector to a solution vector

Parameters

vectorIndex	index of a vector to copy
solutionIndex	index of a solution to copy the solution to

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::DestroyMatrix ( unsigned int matrixIndex )

virtual

Free the memory from a matrix

Parameters

matrixIndex index of matrix to destroy

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::DestroySolution ( unsigned int solutionIndex )

virtual

Free the memory from a solution vector

Parameters

solutionIndex index of solution vector to destroy

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::DestroyVector ( unsigned int vectorIndex )

virtual

Free the memory from a vector

Parameters

vectorIndex index of vector to destroy

Implements itk::fem::LinearSystemWrapper.

double itk::fem::LinearSystemWrapperItpack::GetAccuracy ( ) const

inline

Get the level of accuracy

Definition at line 294 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

int itk::fem::LinearSystemWrapperItpack::GetAdaptiveCaseSwitch ( ) const

inline

Get flag indicating ??

Definition at line 190 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

int itk::fem::LinearSystemWrapperItpack::GetAdaptiveSwitch ( ) const

inline

Get flag indicating ??

Definition at line 173 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

virtual void itk::fem::LinearSystemWrapperItpack::GetColumnsOfNonZeroMatrixElementsInRow	(	unsigned int	row,
		ColumnArray &	cols,
		unsigned int	matrixIndex
	)

virtual

Returns the column index (zero based) of the i-th non zero (non allocated)element in a given row of A matrix. This function is useful for optimizations when sparse matrices are used. Note that the value of an element with returned column index may actually be equal zero.

Parameters

row	Row number
cols	Which element in that row. Can range from 0 to number of elements allocated in a row. If this is out of range, the function returns -1.
matrixIndex	Index of matrix (defaults to 0)

Reimplemented from itk::fem::LinearSystemWrapper.

int itk::fem::LinearSystemWrapperItpack::GetCommunicationSwitch ( ) const

inline

Get the communication flag - meaningless in this implementation

Definition at line 129 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetDampingFactor ( ) const

inline

Get the damping factor used by ??

Definition at line 345 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

double itk::fem::LinearSystemWrapperItpack::GetDigitsInError ( ) const

inline

Get the number of digits in the error

Definition at line 464 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

double itk::fem::LinearSystemWrapperItpack::GetDigitsInResidual ( ) const

inline

Get the number of digits in the residual

Definition at line 481 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

int itk::fem::LinearSystemWrapperItpack::GetErrorAnalysisSwitch ( ) const

inline

Get the flag for level of error reporting - meaningless in this implementation

Definition at line 277 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

int itk::fem::LinearSystemWrapperItpack::GetErrorReportingLevel ( ) const

inline

Get a flag indicating the type of error reporting

Definition at line 112 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetEstimatedSpectralRadiusLU ( ) const

inline

Get the ??

Definition at line 396 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

double itk::fem::LinearSystemWrapperItpack::GetEstimatedSpectralRadiusSSOR ( ) const

inline

Get the ??

Definition at line 379 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

double itk::fem::LinearSystemWrapperItpack::GetLargestJacobiEigenvalueEstimate ( ) const

inline

Get ??

Definition at line 311 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual Float itk::fem::LinearSystemWrapperItpack::GetMatrixValue	(	unsigned int	i,
		unsigned int	j,
		unsigned int	matrixIndex
	)		const

virtual

Virtual function to get a value of a specific element of a matrix.

Parameters

i	row of the element
j	column of the element
matrixIndex	index of matrix to get value from

Implements itk::fem::LinearSystemWrapper.

int itk::fem::LinearSystemWrapperItpack::GetMaximumNumberIterations ( ) const

inline

Get the maximum number iterations that may be performed

Definition at line 102 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

int itk::fem::LinearSystemWrapperItpack::GetOutputNumber ( ) const

inline

Get the output number - meaningless in this implementation

Definition at line 139 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetOverrelaxationParameter ( )

inline

Get the over-relaxation parameter ??

Definition at line 362 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

int itk::fem::LinearSystemWrapperItpack::GetRedBlackOrderingSwitch ( )

inline

Get the flag indicating use of red black ordering

Definition at line 226 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

int itk::fem::LinearSystemWrapperItpack::GetRemoveSwitch ( )

inline

Get flag indicating ??

Definition at line 243 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetSmallestJacobiEigenvalueEstimate ( )

inline

Get ??

Definition at line 328 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual Float itk::fem::LinearSystemWrapperItpack::GetSolutionValue	(	unsigned int	i,
		unsigned int	solutionIndex
	)		const

virtual

Returns value of i-th element in a solution vector. This value is calculated generalized displacement of the i-th degree of freedom in a FEM problem. Note that in general there may be several solution vectors. You can select which one do you want by passing the second parameter.

Parameters

i	element index in solution vector
solutionIndex	index of solution vector to get value from

Note: If the solution vector doesn't exist (problem was not yet solved), or the index i is out of range, the function returns 0.0.

Implements itk::fem::Solution.

int itk::fem::LinearSystemWrapperItpack::GetSymmetricMatrixFlag ( )

inline

Get flag indicating use of symmetric matrix (1=symmetric, 0=non-symmetric)

Definition at line 156 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetTimeForCall ( )

inline

Get the time for call

Definition at line 447 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

double itk::fem::LinearSystemWrapperItpack::GetTimeToConvergence ( )

inline

Get the time to convergence

Definition at line 430 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

int itk::fem::LinearSystemWrapperItpack::GetTimingSwitch ( )

inline

Get the flag indicating use of the timer routines - meaningless in this implementation

Definition at line 260 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

double itk::fem::LinearSystemWrapperItpack::GetTolerance ( )

inline

Get the tolerance level

Definition at line 413 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual Float itk::fem::LinearSystemWrapperItpack::GetVectorValue	(	unsigned int	i,
		unsigned int	vectorIndex
	)		const

virtual

Virtual function to get a value of a specific element of the B vector.

Parameters

i	row of the element
vectorIndex	index of vector to get value from

Implements itk::fem::LinearSystemWrapper.

int itk::fem::LinearSystemWrapperItpack::GetWorkspaceUsed ( )

inline

Get the size of the workspace used by solver

Note: after solver is called this is the amount of workspace actually used

Definition at line 209 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

virtual void itk::fem::LinearSystemWrapperItpack::InitializeMatrix ( unsigned int matrixIndex )

virtual

Initialization of the A matrix. First any existing data for matrix A must be be destroyed, and then a new matrix is created in the memory. All elements in A must be set to zero.

Parameters

matrixIndex index of matrix to initialize

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::InitializeSolution ( unsigned int solutionIndex )

virtual

Initialization of a solution vector. Existing memory must be destroyed and the new solution vector is created in memory. All values should be set to zero.

Parameters

solutionIndex index of solution vector to initialize

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::InitializeVector ( unsigned int vectorIndex )

virtual

Initialization of the a vector. First any existing data for vector B must be destroyed, then new vector is created in the memory. All elements in B must be set to zero.

Implements itk::fem::LinearSystemWrapper.

virtual bool itk::fem::LinearSystemWrapperItpack::IsMatrixInitialized ( unsigned int matrixIndex )

virtual

Check to see if matrix is initialized

Parameters

matrixIndex index of matrix to examine

Implements itk::fem::LinearSystemWrapper.

virtual bool itk::fem::LinearSystemWrapperItpack::IsSolutionInitialized ( unsigned int solutionIndex )

virtual

Check to see if solution vector is initialized

Parameters

solutionIndex index of solution vector to examine

Implements itk::fem::LinearSystemWrapper.

virtual bool itk::fem::LinearSystemWrapperItpack::IsVectorInitialized ( unsigned int vectorIndex )

virtual

Check to see if vector is initialized

Parameters

vectorIndex vector of index to examine

Implements itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::JacobianConjugateGradient ( )

inline

Set numerical solving method to jacobian conjugate gradient

Definition at line 489 of file itkFEMLinearSystemWrapperItpack.h.

References m_Method.

void itk::fem::LinearSystemWrapperItpack::JacobianSemiIterative ( )

inline

Set numerical solving method to jacobian semi iterative

Definition at line 497 of file itkFEMLinearSystemWrapperItpack.h.

References m_Method.

virtual void itk::fem::LinearSystemWrapperItpack::MultiplyMatrixMatrix	(	unsigned int	resultMatrixIndex,
		unsigned int	leftMatrixIndex,
		unsigned int	rightMatrixIndex
	)

virtual

Perform a matrix*matrix operation and store the result in the linear system

Parameters

leftMatrixIndex	index of left matrix
rightMatrixIndex	index of right matrix
resultMatrixIndex	index of matrix where solution is stored

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::MultiplyMatrixSolution	(	unsigned int	resultVectorIndex,
		unsigned int	matrixIndex,
		unsigned int	solutionIndex
	)

virtual

Perform a matrix*solution operation and store the result in the linear system

Parameters

matrixIndex	index of matrix to multiply
solutionIndex	index of solution to multiply
resultVectorIndex	index of vector where result is store

Reimplemented from itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::MultiplyMatrixVector	(	unsigned int	resultVectorIndex,
		unsigned int	matrixIndex,
		unsigned int	vectorIndex
	)

virtual

Perform a matrix*vector operation and store the result in the linear system

Parameters

matrixIndex	index of matrix to multiply
vectorIndex	index of vector to multiply
resultVectorIndex	index of vector where result is store

Reimplemented from itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::ReducedSystemConjugateGradient ( )

inline

Set numerical solving method to reduced system conjugate gradient

Definition at line 531 of file itkFEMLinearSystemWrapperItpack.h.

References m_Method.

void itk::fem::LinearSystemWrapperItpack::ReducedSystemSemiIteration ( )

inline

Set numerical solving method to reduced system semi-iteration

Definition at line 538 of file itkFEMLinearSystemWrapperItpack.h.

References m_Method.

virtual void itk::fem::LinearSystemWrapperItpack::ScaleMatrix	(	Float	scale,
		unsigned int	matrixIndex
	)

virtual

Multiplies all elements of a matrix by a scalar

Parameters

scale	scalar to multiply all matrix values by
matrixIndex	index of matrix to modify

Reimplemented from itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::SetAccuracy ( double i )

inline

Set the level of accuracy for an acceptable solution

Parameters

i	accuracy desired

Definition at line 286 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetAdaptiveCaseSwitch ( int i )

inline

Set flag for ??

Parameters

i ??

Definition at line 182 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetAdaptiveSwitch ( int i )

inline

Set flag for ???

Parameters

i ??

Definition at line 165 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetCommunicationSwitch ( int i )

inline

Set the communication switch - meaningless in this implementation

Parameters

i	flag value

Definition at line 121 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetDampingFactor ( double i )

inline

Set the damping factor used by ??

Parameters

i	damping factor

Definition at line 337 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetDigitsInError ( double i )

inline

Set digits in error

Parameters

i	number of digits in error

Definition at line 456 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetDigitsInResidual ( double i )

inline

Set the number of digits in the residual

Parameters

i	number of digits in the residual

Definition at line 473 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetErrorAnalysisSwitch ( int i )

inline

Set the flag for level of error reporting - meaningless in this implementation

Parameters

i	flag for level of error analysis

Definition at line 269 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetEstimatedSpectralRadiusLU ( double i )

inline

Set the ??

Parameters

i ??

Definition at line 388 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetEstimatedSpectralRadiusSSOR ( double i )

inline

Set the ??

Parameters

i ??

Definition at line 371 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetLargestJacobiEigenvalueEstimate ( double i )

inline

Set ??

Parameters

i	larges jacobian eigenvalue estimate

Definition at line 303 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual void itk::fem::LinearSystemWrapperItpack::SetMatrixValue	(	unsigned int	i,
		unsigned int	j,
		Float	value,
		unsigned int	matrixIndex
	)

virtual

Virtual function to set a value of a specific element of the A matrix.

Parameters

i	row of the element
j	column of the element
value	new value of the element
matrixIndex	index of matrix to set value in

Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::SetMaximumNonZeroValuesInMatrix ( unsigned int maxNonZeroValues )

inlinevirtual

Redefine methods defined in LinearSystemWrapper

set maximum number of entires in a matrix

Parameters

maxNonZeroValues maximum number of entries allowed in matrix

Note: this must be called before any matrices are initialized

Definition at line 555 of file itkFEMLinearSystemWrapperItpack.h.

References m_MaximumNonZeroValues.

void itk::fem::LinearSystemWrapperItpack::SetMaximumNumberIterations ( int i )

inline

Set the maximum number of iterations

Parameters

i	maximum number of iterations that may be performed

Definition at line 94 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetOverrelaxationParameter ( double i )

inline

Set the over-relaxation parameter ??

Parameters

i parameter

Definition at line 354 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetRedBlackOrderingSwitch ( int i )

inline

Set flag indicating use of red black ordering

Parameters

i	1=red black ordering used, 0=not

Definition at line 218 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetRemoveSwitch ( int i )

inline

Set flag indicating ??

Parameters

i ??

Definition at line 235 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetSmallestJacobiEigenvalueEstimate ( double i )

inline

Set ??

Parameters

i	smalles jacobian eigenvalue estimate

Definition at line 320 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual void itk::fem::LinearSystemWrapperItpack::SetSolutionValue	(	unsigned int	i,
		Float	value,
		unsigned int	solutionIndex
	)

virtual

Virtual function to set a value of specific element of the solution vector.

Parameters

i	element Index in solution vector
value	new value of the element
solutionIndex	index of solution vector to set value in

Implements itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::SetSymmetricMatrixFlag ( int i )

inline

Set flag indicating symmetric matrix is being used

Parameters

i	1=symmetric, 0=non-symmetric

Definition at line 148 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetTimeForCall ( double i )

inline

Set the time for call

Parameters

i ??

Definition at line 439 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetTimeToConvergence ( double i )

inline

Set the time to convergence

Parameters

i ??

Definition at line 422 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

void itk::fem::LinearSystemWrapperItpack::SetTimingSwitch ( int i )

inline

Set the flag indicating use of timer routines - meaningless in this implementation

Parameters

i flag

Definition at line 252 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

void itk::fem::LinearSystemWrapperItpack::SetTolerance ( double i )

inline

Set the tolerance level

Parameters

i tolerance

Definition at line 405 of file itkFEMLinearSystemWrapperItpack.h.

References m_RPARM.

virtual void itk::fem::LinearSystemWrapperItpack::SetVectorValue	(	unsigned int	i,
		Float	value,
		unsigned int	vectorIndex
	)

virtual

Virtual function to set a value of a specific element of the B vector.

Parameters

i	row of the element
value	new value of the element
vectorIndex	index of vector to set value in

Implements itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::SetWorkspaceUsed ( int i )

inline

Set size of workspace used by solver

Parameters

i	size of the workspace vector

Note: this value is set by default

Definition at line 200 of file itkFEMLinearSystemWrapperItpack.h.

References m_IPARM.

virtual void itk::fem::LinearSystemWrapperItpack::Solve ( void )

virtual

Solves the linear system and creates the solution vector, which can later be accessed via GetSolutionValue(i,SolutionIndex) member function. Here all the major processing is done with calls to external numeric library.