itk::fem::LinearSystemWrapperItpack Class Reference

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

#include <itkFEMLinearSystemWrapperItpack.h>

Inheritance diagram for itk::fem::LinearSystemWrapperItpack:

[legend]Collaboration diagram for itk::fem::LinearSystemWrapperItpack:

[legend]List of all members.

Public Types
typedef LinearSystemWrapperItpack	Self
typedef LinearSystemWrapper	Superclass
typedef itpack::integer	integer
typedef itpack::doublereal	doublereal
typedef ItpackSparseMatrix	MatrixRepresentation
typedef std::vector< MatrixRepresentation >	MatrixHolder
typedef doublereal *	VectorRepresentation
typedef std::vector< VectorRepresentation >	VectorHolder
Public Methods
void	SetMaximumNumberIterations (integer i)
integer	GetMaximumNumberIterations ()
integer	GetErrorReportingLevel ()
void	SetCommunicationSwitch (integer i)
integer	GetCommunicationSwitch ()
integer	GetOutputNumber ()
void	SetSymmetricMatrixFlag (integer i)
integer	GetSymmetricMatrixFlag ()
void	SetAdaptiveSwitch (integer i)
integer	GetAdaptiveSwitch ()
void	SetAdaptiveCaseSwitch (integer i)
integer	GetAdaptiveCaseSwitch ()
void	SetWorkspaceUsed (integer i)
integer	GetWorkspaceUsed ()
void	SetRedBlackOrderingSwitch (integer i)
integer	GetRedBlackOrderingSwitch ()
void	SetRemoveSwitch (integer i)
integer	GetRemoveSwitch ()
void	SetTimingSwitch (integer i)
integer	GetTimingSwitch ()
void	SetErrorAnalysisSwitch (integer i)
integer	GetErrorAnalysisSwitch ()
void	SetAccuracy (doublereal i)
doublereal	GetAccuracy ()
void	SetLargestJacobiEigenvalueEstimate (doublereal i)
doublereal	GetLargestJacobiEigenvalueEstimate ()
void	SetSmallestJacobiEigenvalueEstimate (doublereal i)
doublereal	GetSmallestJacobiEigenvalueEstimate ()
void	SetDampingFactor (doublereal i)
doublereal	GetDampingFactor ()
void	SetOverrelaxationParameter (doublereal i)
doublereal	GetOverrelaxationParameter ()
void	SetEstimatedSpectralRadiusSSOR (doublereal i)
doublereal	GetEstimatedSpectralRadiusSSOR ()
void	SetEstimatedSpectralRadiusLU (doublereal i)
doublereal	GetEstimatedSpectralRadiusLU ()
void	SetTolerance (doublereal i)
doublereal	GetTolerance ()
void	SetTimeToConvergence (doublereal i)
doublereal	GetTimeToConvergence ()
void	SetTimeForCall (doublereal i)
doublereal	GetTimeForCall ()
void	SetDigitsInError (doublereal i)
doublereal	GetDigitsInError ()
void	SetDigitsInResidual (doublereal i)
doublereal	GetDigitsInResidual ()
void	JacobianConjugateGradient ()
void	JacobianSemiIterative ()
void	SuccessiveOverrelaxation ()
void	SymmetricSuccessiveOverrelaxationConjugateGradient ()
void	SymmetricSuccessiveOverrelaxationSuccessiveOverrelaxation ()
void	ReducedSystemConjugateGradient ()
void	ReducedSystemSemiIteration ()
virtual void	SetMaximumNonZeroValuesInMatrix (unsigned int maxNonZeroValues)
void	ScaleMatrix (Float scale, unsigned int matrixIndex)
	LinearSystemWrapperItpack ()
	~LinearSystemWrapperItpack ()
virtual void	InitializeMatrix (unsigned int matrixIndex)
virtual bool	IsMatrixInitialized (unsigned int matrixIndex)
virtual void	DestroyMatrix (unsigned int matrixIndex)
virtual void	InitializeVector (unsigned int vectorIndex)
virtual bool	IsVectorInitialized (unsigned int vectorIndex)
virtual void	DestroyVector (unsigned int vectorIndex)
virtual void	InitializeSolution (unsigned int solutionIndex)
virtual bool	IsSolutionInitialized (unsigned int solutionIndex)
virtual void	DestroySolution (unsigned int solutionIndex)
virtual Float	GetMatrixValue (unsigned int i, unsigned int j, unsigned int matrixIndex) const
virtual void	SetMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex)
virtual void	AddMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex)
virtual void	GetColumnsOfNonZeroMatrixElementsInRow (unsigned int row, ColumnArray &cols, unsigned int matrixIndex)
virtual Float	GetVectorValue (unsigned int i, unsigned int vectorIndex) const
virtual void	SetVectorValue (unsigned int i, Float value, unsigned int vectorIndex)
virtual void	AddVectorValue (unsigned int i, Float value, unsigned int vectorIndex)
virtual Float	GetSolutionValue (unsigned int i, unsigned int solutionIndex) const
virtual void	SetSolutionValue (unsigned int i, Float value, unsigned int solutionIndex)
virtual void	AddSolutionValue (unsigned int i, Float value, unsigned int solutionIndex)
virtual void	Solve (void)
virtual void	SwapMatrices (unsigned int matrixIndex1, unsigned int matrixIndex2)
virtual void	SwapVectors (unsigned int vectorIndex1, unsigned int vectorIndex2)
virtual void	SwapSolutions (unsigned int solutionIndex1, unsigned int solutionIndex2)
virtual void	CopySolution2Vector (unsigned solutionIndex, unsigned int vectorIndex)
virtual void	CopyVector2Solution (unsigned int vectorIndex, unsigned int solutionIndex)
virtual void	MultiplyMatrixMatrix (unsigned int resultMatrixIndex, unsigned int leftMatrixIndex, unsigned int rightMatrixIndex)
virtual void	MultiplyMatrixVector (unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int vectorIndex)

---

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 38 of file itkFEMLinearSystemWrapperItpack.h.

---

Member Typedef Documentation

typedef itpack::doublereal itk::fem::LinearSystemWrapperItpack::doublereal

itpack double typedef Definition at line 52 of file itkFEMLinearSystemWrapperItpack.h. Referenced by GetAccuracy(), GetDampingFactor(), GetDigitsInError(), GetDigitsInResidual(), GetEstimatedSpectralRadiusLU(), GetEstimatedSpectralRadiusSSOR(), GetLargestJacobiEigenvalueEstimate(), GetOverrelaxationParameter(), GetSmallestJacobiEigenvalueEstimate(), GetTimeForCall(), GetTimeToConvergence(), GetTolerance(), SetAccuracy(), SetDampingFactor(), SetDigitsInError(), SetDigitsInResidual(), SetEstimatedSpectralRadiusLU(), SetEstimatedSpectralRadiusSSOR(), SetLargestJacobiEigenvalueEstimate(), SetOverrelaxationParameter(), SetSmallestJacobiEigenvalueEstimate(), SetTimeForCall(), SetTimeToConvergence(), and SetTolerance().

typedef itpack::integer itk::fem::LinearSystemWrapperItpack::integer

itpack integer typedef Definition at line 49 of file itkFEMLinearSystemWrapperItpack.h. Referenced by GetAdaptiveCaseSwitch(), GetAdaptiveSwitch(), GetCommunicationSwitch(), GetErrorAnalysisSwitch(), GetErrorReportingLevel(), GetMaximumNumberIterations(), GetOutputNumber(), GetRedBlackOrderingSwitch(), GetRemoveSwitch(), GetSymmetricMatrixFlag(), GetTimingSwitch(), GetWorkspaceUsed(), SetAdaptiveCaseSwitch(), SetAdaptiveSwitch(), SetCommunicationSwitch(), SetErrorAnalysisSwitch(), SetMaximumNumberIterations(), SetRedBlackOrderingSwitch(), SetRemoveSwitch(), SetSymmetricMatrixFlag(), SetTimingSwitch(), and SetWorkspaceUsed().

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

vector of matrices typedef Definition at line 58 of file itkFEMLinearSystemWrapperItpack.h.

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

matrix representatin typedef Definition at line 55 of file itkFEMLinearSystemWrapperItpack.h.

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

Standard "Self" typedef. Reimplemented from itk::fem::LinearSystemWrapper. Definition at line 43 of file itkFEMLinearSystemWrapperItpack.h.

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

Standard "Superclass" typedef. Reimplemented from itk::fem::LinearSystemWrapper. Definition at line 46 of file itkFEMLinearSystemWrapperItpack.h.

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

vector of vector typedef Definition at line 68 of file itkFEMLinearSystemWrapperItpack.h.

typedef doublereal* itk::fem::LinearSystemWrapperItpack::VectorRepresentation

vector representation typedef Definition at line 65 of file itkFEMLinearSystemWrapperItpack.h.

---

Constructor & Destructor Documentation

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

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]

Copy a solution vector to a vector Parameters: solutionIndex  index of solution vector to copy vectorIndex  index of vector to copy solution to Implements itk::fem::LinearSystemWrapper.

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 teh mememory 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.

doublereal itk::fem::LinearSystemWrapperItpack::GetAccuracy (    )  [inline]

Get the level of accuracy Definition at line 218 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

integer itk::fem::LinearSystemWrapperItpack::GetAdaptiveCaseSwitch (    )  [inline]

Get flag indicating ?? Definition at line 150 of file itkFEMLinearSystemWrapperItpack.h. References integer.

integer itk::fem::LinearSystemWrapperItpack::GetAdaptiveSwitch (    )  [inline]

Get flag indicating ?? Definition at line 139 of file itkFEMLinearSystemWrapperItpack.h. References integer.

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 usefull 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.

integer itk::fem::LinearSystemWrapperItpack::GetCommunicationSwitch (    )  [inline]

Get the communication flag - meaningless in this implementation Definition at line 110 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetDampingFactor (    )  [inline]

Get the damping factor used by ?? Definition at line 251 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

doublereal itk::fem::LinearSystemWrapperItpack::GetDigitsInError (    )  [inline]

Get the number of digits in the error Definition at line 328 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

doublereal itk::fem::LinearSystemWrapperItpack::GetDigitsInResidual (    )  [inline]

Get the number of digits in the residual Definition at line 339 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

integer itk::fem::LinearSystemWrapperItpack::GetErrorAnalysisSwitch (    )  [inline]

Get the flag for level of error reporting - meaningless in this implementation Definition at line 207 of file itkFEMLinearSystemWrapperItpack.h. References integer.

integer itk::fem::LinearSystemWrapperItpack::GetErrorReportingLevel (    )  [inline]

Get a flag indicating the type of error reporting Definition at line 99 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetEstimatedSpectralRadiusLU (    )  [inline]

Get the ?? Definition at line 284 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

doublereal itk::fem::LinearSystemWrapperItpack::GetEstimatedSpectralRadiusSSOR (    )  [inline]

Get the ?? Definition at line 273 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

doublereal itk::fem::LinearSystemWrapperItpack::GetLargestJacobiEigenvalueEstimate (    )  [inline]

Get ?? Definition at line 229 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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.

integer itk::fem::LinearSystemWrapperItpack::GetMaximumNumberIterations (    )  [inline]

Get the maximum number iterations that may be performed Definition at line 92 of file itkFEMLinearSystemWrapperItpack.h. References integer.

integer itk::fem::LinearSystemWrapperItpack::GetOutputNumber (    )  [inline]

Get the output number - meaningless in this implementation Definition at line 117 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetOverrelaxationParameter (    )  [inline]

Get the over-relaxation parameter ?? Definition at line 262 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

integer itk::fem::LinearSystemWrapperItpack::GetRedBlackOrderingSwitch (    )  [inline]

Get the flag indicating use of red black ordering Definition at line 174 of file itkFEMLinearSystemWrapperItpack.h. References integer.

integer itk::fem::LinearSystemWrapperItpack::GetRemoveSwitch (    )  [inline]

Get flag indicating ?? Definition at line 185 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetSmallestJacobiEigenvalueEstimate (    )  [inline]

Get ?? Definition at line 240 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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.

integer itk::fem::LinearSystemWrapperItpack::GetSymmetricMatrixFlag (    )  [inline]

Get flag indicating use of symmetric matrix (1=symmetric, 0=non-symmetric) Definition at line 128 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetTimeForCall (    )  [inline]

Get the time for call Definition at line 317 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

doublereal itk::fem::LinearSystemWrapperItpack::GetTimeToConvergence (    )  [inline]

Get the time to convergence Definition at line 306 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

integer itk::fem::LinearSystemWrapperItpack::GetTimingSwitch (    )  [inline]

Get the flag indicating use of the timer routines - meaningless in this implementation Definition at line 196 of file itkFEMLinearSystemWrapperItpack.h. References integer.

doublereal itk::fem::LinearSystemWrapperItpack::GetTolerance (    )  [inline]

Get the tolerance level Definition at line 295 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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.

integer 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 163 of file itkFEMLinearSystemWrapperItpack.h. References integer.

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 344 of file itkFEMLinearSystemWrapperItpack.h.

void itk::fem::LinearSystemWrapperItpack::JacobianSemiIterative (    )  [inline]

Set numerical solving method to jacobian semi iterative Definition at line 349 of file itkFEMLinearSystemWrapperItpack.h.

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::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 371 of file itkFEMLinearSystemWrapperItpack.h.

void itk::fem::LinearSystemWrapperItpack::ReducedSystemSemiIteration (    )  [inline]

Set numerical solving method to reduced system semi-iteration Definition at line 375 of file itkFEMLinearSystemWrapperItpack.h.

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 (  doublereal    i )  [inline]

Set the level of accuracy for an acceptable solution Parameters: i  accuracy desired Definition at line 213 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetAdaptiveCaseSwitch (  integer    i )  [inline]

Set flag for ?? Parameters: i  ?? Definition at line 145 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetAdaptiveSwitch (  integer    i )  [inline]

Set flag for ??? Parameters: i  ?? Definition at line 134 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetCommunicationSwitch (  integer    i )  [inline]

Set the communication switch - meaningless in this implementation Parameters: i  flag value Definition at line 105 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetDampingFactor (  doublereal    i )  [inline]

Set the damping factor used by ?? Parameters: i  damping factor Definition at line 246 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetDigitsInError (  doublereal    i )  [inline]

Set digits in error Parameters: i  number of digits in error Definition at line 323 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetDigitsInResidual (  doublereal    i )  [inline]

Set the number of digits in the residual Parameters: i  number of digits in the residual Definition at line 334 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetErrorAnalysisSwitch (  integer    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 202 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetEstimatedSpectralRadiusLU (  doublereal    i )  [inline]

Set the ?? Parameters: i  ?? Definition at line 279 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetEstimatedSpectralRadiusSSOR (  doublereal    i )  [inline]

Set the ?? Parameters: i  ?? Definition at line 268 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetLargestJacobiEigenvalueEstimate (  doublereal    i )  [inline]

Set ?? Parameters: i  larges jacobian eigenvalue estimate Definition at line 224 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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 )  [inline, virtual]

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 390 of file itkFEMLinearSystemWrapperItpack.h.

void itk::fem::LinearSystemWrapperItpack::SetMaximumNumberIterations (  integer    i )  [inline]

Set the maximum number of iterations Parameters: i  maximum number of iterations that may be performed Definition at line 87 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetOverrelaxationParameter (  doublereal    i )  [inline]

Set the over-relaxation parameter ?? Parameters: i  parameter Definition at line 257 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetRedBlackOrderingSwitch (  integer    i )  [inline]

Set flag indicating use of red black ordering Parameters: i  1=red black ordering used, 0=not Definition at line 169 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetRemoveSwitch (  integer    i )  [inline]

Set flag indicating ?? Parameters: i  ?? Definition at line 180 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetSmallestJacobiEigenvalueEstimate (  doublereal    i )  [inline]

Set ?? Parameters: i  smalles jacobian eigenvalue estimate Definition at line 235 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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 (  integer    i )  [inline]

Set flag indicating symmetric matrix is being used Parameters: i  1=symmetric, 0=non-symmetric Definition at line 123 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetTimeForCall (  doublereal    i )  [inline]

Set the time for call Parameters: i  ?? Definition at line 312 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetTimeToConvergence (  doublereal    i )  [inline]

Set the time to convergence Parameters: i  ?? Definition at line 301 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

void itk::fem::LinearSystemWrapperItpack::SetTimingSwitch (  integer    i )  [inline]

Set the flag indicating use of timer routines - meaningless in this implementation Parameters: i  flag Definition at line 191 of file itkFEMLinearSystemWrapperItpack.h. References integer.

void itk::fem::LinearSystemWrapperItpack::SetTolerance (  doublereal    i )  [inline]

Set the tolerance level Parameters: i  tolerance Definition at line 290 of file itkFEMLinearSystemWrapperItpack.h. References doublereal.

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 (  integer    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 157 of file itkFEMLinearSystemWrapperItpack.h. References integer.

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. Note: This function can only be called after the linear system was properly assembled. Implements itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::SuccessiveOverrelaxation (    )  [inline]

Set numerical solving method to successive over-relaxation Definition at line 354 of file itkFEMLinearSystemWrapperItpack.h.

virtual void itk::fem::LinearSystemWrapperItpack::SwapMatrices (  unsigned int    matrixIndex1, unsigned int    matrixIndex2 )  [virtual]

Swaps access indices of any 2 matrices in the linear system Parameters: matrixIndex1  index of a matrix to swap matrixIndex2  index of matrix to swap with Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::SwapSolutions (  unsigned int    solutionIndex1, unsigned int    solutionIndex2 )  [virtual]

Swaps access indices of any 2 solution vectors in the linear system Parameters: solutionIndex1  index of a solution vector to swap solutionIndex2  index of solution vector to swap with Implements itk::fem::LinearSystemWrapper.

virtual void itk::fem::LinearSystemWrapperItpack::SwapVectors (  unsigned int    vectorIndex1, unsigned int    vectorIndex2 )  [virtual]

Swaps access indices of any 2 vectors in the linear system Parameters: vectorIndex1  index of a vector to swap vectorIndex2  index of vector to swap with Implements itk::fem::LinearSystemWrapper.

void itk::fem::LinearSystemWrapperItpack::SymmetricSuccessiveOverrelaxationConjugateGradient (    )  [inline]

Set numerical solving method to symmetric successive over-relaxation conjugate gradient Definition at line 360 of file itkFEMLinearSystemWrapperItpack.h.

void itk::fem::LinearSystemWrapperItpack::SymmetricSuccessiveOverrelaxationSuccessiveOverrelaxation (    )  [inline]

Set numerical solving method to symmetric successive over-relaxation successive over-relaxation Definition at line 366 of file itkFEMLinearSystemWrapperItpack.h.

---

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

• itkFEMLinearSystemWrapperItpack.h

---