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

#include <itkFEMLinearSystemWrapperVNL.h>

Inheritance diagram for itk::fem::LinearSystemWrapperVNL:

Collaboration diagram for itk::fem::LinearSystemWrapperVNL:

List of all members.

Public Types
typedef std::vector< unsigned int >	ColumnArray
typedef const Self *	ConstPointer
typedef LinearSystemWrapper::Float	Float
typedef std::vector < MatrixRepresentation * >	MatrixHolder
typedef vnl_sparse_matrix< Float >	MatrixRepresentation
typedef Self *	Pointer
typedef LinearSystemWrapper	Self
typedef LinearSystemWrapper	SuperClass
typedef Solution	Superclass

Public Member Functions
	LinearSystemWrapperVNL ()
virtual	~LinearSystemWrapperVNL ()
virtual void	AddMatrixMatrix (unsigned int matrixIndex1, unsigned int matrixIndex2)
virtual void	AddMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex)
virtual void	AddSolutionValue (unsigned int i, Float value, unsigned int solutionIndex)
virtual void	AddVectorValue (unsigned int i, Float value, unsigned int vectorIndex)
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 solutionIndex, unsigned int vectorIndex)
virtual void	CopySolution2Vector (unsigned int solutionIndex, unsigned int vectorIndex)=0
virtual void	CopyVector (unsigned int vectorSource, unsigned int vectorDestination)
virtual void	CopyVector2Solution (unsigned int vectorIndex, unsigned int solutionIndex)
virtual void	DestroyMatrix (unsigned int matrixIndex)
virtual void	DestroySolution (unsigned int solutionIndex)
virtual void	DestroyVector (unsigned int vectorIndex)
virtual void	GetColumnsOfNonZeroMatrixElementsInRow (unsigned int row, ColumnArray &cols, unsigned int matrixIndex=0)
virtual Float	GetMatrixValue (unsigned int i, unsigned int j, unsigned int matrixIndex) const
unsigned int	GetNumberOfMatrices ()
unsigned int	GetNumberOfSolutions ()
unsigned int	GetNumberOfVectors ()
virtual Float	GetSolutionValue (unsigned int i, unsigned int solutionIndex) const
unsigned int	GetSystemOrder () const
virtual Float	GetVectorValue (unsigned int i, unsigned int vectorIndex) const
virtual void	InitializeMatrix (unsigned int matrixIndex)
virtual void	InitializeSolution (unsigned int solutionIndex)
virtual void	InitializeVector (unsigned int vectorIndex)
virtual bool	IsMatrixInitialized (unsigned int matrixIndex)
virtual bool	IsSolutionInitialized (unsigned int solutionIndex)
virtual bool	IsVectorInitialized (unsigned int vectorIndex)
virtual void	MultiplyMatrixMatrix (unsigned int resultMatrixIndex, unsigned int leftMatrixIndex, unsigned int rightMatrixIndex)
virtual void	MultiplyMatrixVector (unsigned int resultVectorIndex, unsigned int matrixIndex, unsigned int vectorIndex)
virtual void	OptimizeMatrixStorage (unsigned int matrixIndex, unsigned int tempMatrixIndex)
virtual void	ReverseCuthillMckeeOrdering (ColumnArray &newNumbering, unsigned int matrixIndex=0)
virtual void	ScaleMatrix (Float scale, unsigned int matrixIndex)
void	ScaleSolution (Float scale, unsigned int solutionIndex=0)
void	ScaleVector (Float scale, unsigned int vectorIndex=0)
virtual void	SetMatrixValue (unsigned int i, unsigned int j, Float value, unsigned int matrixIndex)
virtual void	SetMaximumNonZeroValuesInMatrix (unsigned int, unsigned int)
void	SetNumberOfMatrices (unsigned int nMatrices)
void	SetNumberOfSolutions (unsigned int nSolutions)
void	SetNumberOfVectors (unsigned int nVectors)
virtual void	SetSolutionValue (unsigned int i, Float value, unsigned int solutionIndex)
void	SetSystemOrder (unsigned int N)
virtual void	SetVectorValue (unsigned int i, Float value, unsigned int vectorIndex)
virtual void	Solve (void)
virtual void	SwapMatrices (unsigned int matrixIndex1, unsigned int matrixIndex2)
virtual void	SwapSolutions (unsigned int solutionIndex1, unsigned int solutionIndex2)
virtual void	SwapVectors (unsigned int vectorIndex1, unsigned int vectorIndex2)

Protected Attributes
unsigned int	m_NumberOfMatrices
unsigned int	m_NumberOfSolutions
unsigned int	m_NumberOfVectors
unsigned int	m_Order

Private Attributes
MatrixHolder *	m_Matrices
std::vector< vnl_vector< Float > * > *	m_Solutions
std::vector< vnl_vector< Float > * > *	m_Vectors

Detailed Description

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

See also:: LinearSystemWrapper

Definition at line 38 of file itkFEMLinearSystemWrapperVNL.h.

Member Typedef Documentation

typedef std::vector<unsigned int> itk::fem::LinearSystemWrapper::ColumnArray

inherited

Definition at line 59 of file itkFEMLinearSystemWrapper.h.

typedef const Self* itk::fem::LinearSystemWrapper::ConstPointer

inherited

Const pointer to an object.

Reimplemented from itk::fem::Solution.

Definition at line 57 of file itkFEMLinearSystemWrapper.h.

typedef LinearSystemWrapper::Float itk::fem::LinearSystemWrapperVNL::Float

Floating point storage type used within a class

Reimplemented from itk::fem::Solution.

Definition at line 43 of file itkFEMLinearSystemWrapperVNL.h.

typedef std::vector< MatrixRepresentation* > itk::fem::LinearSystemWrapperVNL::MatrixHolder

Definition at line 52 of file itkFEMLinearSystemWrapperVNL.h.

typedef vnl_sparse_matrix<Float> itk::fem::LinearSystemWrapperVNL::MatrixRepresentation

Definition at line 49 of file itkFEMLinearSystemWrapperVNL.h.

typedef Self* itk::fem::LinearSystemWrapper::Pointer

inherited

Pointer to an object.

Reimplemented from itk::fem::Solution.

Definition at line 56 of file itkFEMLinearSystemWrapper.h.

typedef LinearSystemWrapper itk::fem::LinearSystemWrapper::Self

inherited

Standard "Self" typedef.

Reimplemented from itk::fem::Solution.

Reimplemented in itk::fem::LinearSystemWrapperItpack.

Definition at line 54 of file itkFEMLinearSystemWrapper.h.

typedef LinearSystemWrapper itk::fem::LinearSystemWrapperVNL::SuperClass

Definition at line 46 of file itkFEMLinearSystemWrapperVNL.h.

typedef Solution itk::fem::LinearSystemWrapper::Superclass

inherited

Standard "Superclass" typedef.

Reimplemented from itk::fem::Solution.

Reimplemented in itk::fem::LinearSystemWrapperItpack.

Definition at line 55 of file itkFEMLinearSystemWrapper.h.

Constructor & Destructor Documentation

itk::fem::LinearSystemWrapperVNL::LinearSystemWrapperVNL ( )

inline

Definition at line 55 of file itkFEMLinearSystemWrapperVNL.h.

itk::fem::LinearSystemWrapperVNL::~LinearSystemWrapperVNL ( )

virtual

Definition at line 290 of file itkFEMLinearSystemWrapperVNL.cxx.

References DestroyMatrix(), DestroySolution(), DestroyVector(), m_Matrices, itk::fem::LinearSystemWrapper::m_NumberOfMatrices, itk::fem::LinearSystemWrapper::m_NumberOfSolutions, itk::fem::LinearSystemWrapper::m_NumberOfVectors, m_Solutions, and m_Vectors.

Member Function Documentation

void itk::fem::LinearSystemWrapper::AddMatrixMatrix	(	unsigned int	matrixIndex1,
		unsigned int	matrixIndex2
	)

virtualinherited

Adds two matrices storing the result in the first matrix.

Parameters:

matrixIndex1	index of a matrix to add the other matrix to
matrixIndex2	index of matrix to add

Definition at line 214 of file itkFEMLinearSystemWrapper.cxx.

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

inlinevirtual

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.

Definition at line 74 of file itkFEMLinearSystemWrapperVNL.h.

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

inlinevirtual

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.

Definition at line 80 of file itkFEMLinearSystemWrapperVNL.h.

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

inlinevirtual

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.

Definition at line 77 of file itkFEMLinearSystemWrapperVNL.h.

void itk::fem::LinearSystemWrapper::AddVectorVector	(	unsigned int	vectorIndex1,
		unsigned int	vectorIndex2
	)

virtualinherited

Adds two vectors storing the result in the first vector.

Parameters:

vectorIndex1	index of a vector to add the other vector to
vectorIndex2	index of vector to add

Definition at line 242 of file itkFEMLinearSystemWrapper.cxx.

void itk::fem::LinearSystemWrapper::Clean ( void )

virtualinherited

Clear all the data (matrices) inside the system, so that the system is ready to solve another problem from scratch.

Definition at line 31 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::LinearSystemWrapper::DestroyMatrix(), itk::fem::LinearSystemWrapper::DestroySolution(), itk::fem::LinearSystemWrapper::DestroyVector(), itk::fem::LinearSystemWrapper::m_NumberOfMatrices, itk::fem::LinearSystemWrapper::m_NumberOfSolutions, itk::fem::LinearSystemWrapper::m_NumberOfVectors, and itk::fem::LinearSystemWrapper::SetSystemOrder().

void itk::fem::LinearSystemWrapper::CopyMatrix	(	unsigned int	matrixIndex1,
		unsigned int	matrixIndex2
	)

virtualinherited

Copies the content of source matrix to destination matrix. Any existing data in destination matrix is overwritten.

Parameters:

matrixIndex1	index of a matrix that will be copied
matrixIndex2	index of matrix to copy to

Definition at line 195 of file itkFEMLinearSystemWrapper.cxx.

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

virtual

Definition at line 245 of file itkFEMLinearSystemWrapperVNL.cxx.

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

pure virtualinherited

Copy a solution vector to a vector

Parameters:

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

void itk::fem::LinearSystemWrapper::CopyVector	(	unsigned int	vectorSource,
		unsigned int	vectorDestination
	)

virtualinherited

Copy a vector

Parameters:

vectorSource	index of a vector to copy
vectorDestination	index to copy the vector to

Definition at line 231 of file itkFEMLinearSystemWrapper.cxx.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 252 of file itkFEMLinearSystemWrapperVNL.cxx.

void itk::fem::LinearSystemWrapperVNL::DestroyMatrix ( unsigned int matrixIndex )

virtual

Free the memory from a matrix

Parameters:

matrixIndex index of matrix to destroy

Implements itk::fem::LinearSystemWrapper.

Definition at line 70 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Matrices.

Referenced by ~LinearSystemWrapperVNL().

void itk::fem::LinearSystemWrapperVNL::DestroySolution ( unsigned int solutionIndex )

virtual

Free teh mememory from a solution vector

Parameters:

solutionIndex index of solution vector to destroy

Implements itk::fem::LinearSystemWrapper.

Definition at line 164 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Solutions.

Referenced by ~LinearSystemWrapperVNL().

void itk::fem::LinearSystemWrapperVNL::DestroyVector ( unsigned int vectorIndex )

virtual

Free the memory from a vector

Parameters:

vectorIndex index of vector to destroy

Implements itk::fem::LinearSystemWrapper.

Definition at line 118 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Vectors.

Referenced by ~LinearSystemWrapperVNL().

void itk::fem::LinearSystemWrapper::GetColumnsOfNonZeroMatrixElementsInRow	(	unsigned int	row,
		ColumnArray &	cols,
		unsigned int	matrixIndex = `0`
	)

virtualinherited

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 in itk::fem::LinearSystemWrapperItpack.

Definition at line 155 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::LinearSystemWrapper::m_Order.

Referenced by itk::fem::Solver::ApplyBC(), itk::fem::LinearSystemWrapper::CuthillMckeeOrdering(), itk::fem::LinearSystemWrapper::FollowConnectionsCuthillMckeeOrdering(), and itk::fem::LinearSystemWrapper::OptimizeMatrixStorage().

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

inlinevirtual

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.

Definition at line 72 of file itkFEMLinearSystemWrapperVNL.h.

References m_Matrices.

unsigned int itk::fem::LinearSystemWrapper::GetNumberOfMatrices ( )

inlineinherited

Set the maximum number of entries permitted in a matrix

Parameters:

matrixIndex	index of matrix to set value for
maxNonZeros	maximum number of entries allowed in matrix

Note:: in general this function does nothing, however it may redefined by the derived wrapper if necessary Get Index of matrices used by system

Definition at line 111 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfMatrices.

unsigned int itk::fem::LinearSystemWrapper::GetNumberOfSolutions ( )

inlineinherited

Get Index of solutions used by system

Definition at line 133 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfSolutions.

unsigned int itk::fem::LinearSystemWrapper::GetNumberOfVectors ( )

inlineinherited

Get Index of vectors used by system

Definition at line 122 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfVectors.

LinearSystemWrapperVNL::Float itk::fem::LinearSystemWrapperVNL::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.

Definition at line 173 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Solutions.

unsigned int itk::fem::LinearSystemWrapper::GetSystemOrder ( ) const

inlineinherited

Get the order of the system

Definition at line 91 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_Order.

Referenced by itk::fem::LinearSystemWrapperDenseVNL::InitializeMatrix(), InitializeMatrix(), itk::fem::LinearSystemWrapperDenseVNL::InitializeSolution(), InitializeSolution(), itk::fem::LinearSystemWrapperDenseVNL::InitializeVector(), InitializeVector(), MultiplyMatrixMatrix(), MultiplyMatrixVector(), and Solve().

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

inlinevirtual

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.

Definition at line 75 of file itkFEMLinearSystemWrapperVNL.h.

References m_Vectors.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 30 of file itkFEMLinearSystemWrapperVNL.cxx.

References itk::fem::LinearSystemWrapper::GetSystemOrder(), m_Matrices, itk::fem::LinearSystemWrapper::m_NumberOfMatrices, and NULL.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 127 of file itkFEMLinearSystemWrapperVNL.cxx.

References itk::fem::LinearSystemWrapper::GetSystemOrder(), itk::fem::LinearSystemWrapper::m_NumberOfSolutions, m_Solutions, and NULL.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 79 of file itkFEMLinearSystemWrapperVNL.cxx.

References itk::fem::LinearSystemWrapper::GetSystemOrder(), itk::fem::LinearSystemWrapper::m_NumberOfVectors, m_Vectors, and NULL.

bool itk::fem::LinearSystemWrapperVNL::IsMatrixInitialized ( unsigned int matrixIndex )

virtual

Check to see if matrix is initialized

Parameters:

matrixIndex index of matrix to examine

Implements itk::fem::LinearSystemWrapper.

Definition at line 62 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Matrices.

bool itk::fem::LinearSystemWrapperVNL::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.

Definition at line 155 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Solutions.

bool itk::fem::LinearSystemWrapperVNL::IsVectorInitialized ( unsigned int vectorIndex )

virtual

Check to see if vector is initialized

Parameters:

vectorIndex vector of index to examine

Implements itk::fem::LinearSystemWrapper.

Definition at line 109 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Vectors.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 259 of file itkFEMLinearSystemWrapperVNL.cxx.

References itk::fem::LinearSystemWrapper::GetSystemOrder(), and m_Matrices.

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 270 of file itkFEMLinearSystemWrapperVNL.cxx.

References itk::fem::LinearSystemWrapper::GetSystemOrder(), and m_Vectors.

void itk::fem::LinearSystemWrapper::OptimizeMatrixStorage	(	unsigned int	matrixIndex,
		unsigned int	tempMatrixIndex
	)

virtualinherited

Remove all zeros from a matrix

Parameters:

matrixIndex	index of matrix to remove zeros from
tempMatrixIndex	index of matrix to use for temp storage space

Note:: an extra matrix must be allocated by the solver in order to use this method

Definition at line 166 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::LinearSystemWrapper::DestroyMatrix(), itk::fem::LinearSystemWrapper::GetColumnsOfNonZeroMatrixElementsInRow(), itk::fem::LinearSystemWrapper::GetMatrixValue(), itk::fem::LinearSystemWrapper::InitializeMatrix(), itk::fem::LinearSystemWrapper::m_Order, itk::fem::LinearSystemWrapper::SetMatrixValue(), and itk::fem::LinearSystemWrapper::SwapMatrices().

void itk::fem::LinearSystemWrapper::ReverseCuthillMckeeOrdering	(	ColumnArray &	newNumbering,
		unsigned int	matrixIndex = `0`
	)

virtualinherited

Reorder the Degrees of Freedom in order to reduce bandwidth of matrix

Parameters:

matrixIndex	index of matrix to examine
newNumbering	vector of new degree of freedom ordering

Definition at line 252 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::LinearSystemWrapper::CuthillMckeeOrdering().

void itk::fem::LinearSystemWrapperVNL::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.

Definition at line 280 of file itkFEMLinearSystemWrapperVNL.cxx.

References m_Matrices.

void itk::fem::LinearSystemWrapper::ScaleSolution	(	Float	scale,
		unsigned int	solutionIndex = `0`
	)

inherited

Multiplies all elements of a solution by a scalar

Parameters:

scale	scalar to multiply all solution values by
solutionIndex	index of solution to modify

Reimplemented in itk::fem::LinearSystemWrapperDenseVNL.

Definition at line 98 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::Solution::GetSolutionValue(), itk::fem::LinearSystemWrapper::m_Order, and itk::fem::LinearSystemWrapper::SetSolutionValue().

void itk::fem::LinearSystemWrapper::ScaleVector	(	Float	scale,
		unsigned int	vectorIndex = `0`
	)

inherited

Multiplies all elements of a vector by a scalar

Parameters:

scale	scalar to multiply all vector values by
vectorIndex	index of vector to modify

Reimplemented in itk::fem::LinearSystemWrapperDenseVNL.

Definition at line 79 of file itkFEMLinearSystemWrapper.cxx.

References itk::fem::LinearSystemWrapper::GetVectorValue(), itk::fem::LinearSystemWrapper::m_Order, and itk::fem::LinearSystemWrapper::SetVectorValue().

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

inlinevirtual

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.

Definition at line 73 of file itkFEMLinearSystemWrapperVNL.h.

virtual void itk::fem::LinearSystemWrapperVNL::SetMaximumNonZeroValuesInMatrix	(	unsigned	int,
		unsigned	int
	)

inlinevirtual

Definition at line 68 of file itkFEMLinearSystemWrapperVNL.h.

void itk::fem::LinearSystemWrapper::SetNumberOfMatrices ( unsigned int nMatrices )

inlineinherited

Set Index of matrices used by the system

Parameters:

nMatrices Index of matrices used by system

Definition at line 97 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfMatrices.

Referenced by itk::fem::SolverCrankNicolson::InitializeForSolution(), and itk::fem::Solver::InitializeLinearSystemWrapper().

void itk::fem::LinearSystemWrapper::SetNumberOfSolutions ( unsigned int nSolutions )

inlineinherited

Set Index of solutions used by the system

Parameters:

nSolutions Index of solutions used by system

Definition at line 128 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfSolutions.

Referenced by itk::fem::SolverCrankNicolson::InitializeForSolution(), and itk::fem::Solver::InitializeLinearSystemWrapper().

void itk::fem::LinearSystemWrapper::SetNumberOfVectors ( unsigned int nVectors )

inlineinherited

Set Index of vectors used by the system

Parameters:

nVectors Index of vectors used by system

Definition at line 117 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_NumberOfVectors.

Referenced by itk::fem::SolverCrankNicolson::InitializeForSolution(), and itk::fem::Solver::InitializeLinearSystemWrapper().

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

inlinevirtual

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.

Definition at line 79 of file itkFEMLinearSystemWrapperVNL.h.

void itk::fem::LinearSystemWrapper::SetSystemOrder ( unsigned int N )

inlineinherited

Set the order of the system. All matrices will be of size NxN and all vectors will be of size N

Parameters:

N	order of the linear system

Definition at line 86 of file itkFEMLinearSystemWrapper.h.

References itk::fem::LinearSystemWrapper::m_Order.

Referenced by itk::fem::LinearSystemWrapper::Clean(), itk::fem::SolverCrankNicolson::InitializeForSolution(), and itk::fem::Solver::InitializeMatrixForAssembly().

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

inlinevirtual

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.

Definition at line 76 of file itkFEMLinearSystemWrapperVNL.h.

void itk::fem::LinearSystemWrapperVNL::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.