com.interpss.core.sparse.impl

Class AbstractSparseEqnComplexMatrix3x3Impl<T extends ISparseEqnSolver>

java.lang.Object

com.interpss.core.sparse.impl.AbstractSparseEquation<T>

com.interpss.core.sparse.impl.AbstractSparseEqnComplexMatrix3x3Impl<T>

All Implemented Interfaces:

ISparseEqnObject<Complex3x3,Complex3x1>, ISparseEquation, ISparseEqnComplexMatrix3x3

Direct Known Subclasses:

CSJSparseEqnComplexMatrix3x3Impl

public abstract class AbstractSparseEqnComplexMatrix3x3Impl<T extends ISparseEqnSolver>
extends AbstractSparseEquation<T>
implements ISparseEqnComplexMatrix3x3

Abstract Sparse Equation of data type complex3x3 for solving the [A]X=B problem. To outside, the index number is from 0 to n-1

Nested Class Summary

Nested classes/interfaces inherited from interface org.interpss.numeric.sparse.base.ISparseEquation

ISparseEquation.IndexType

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractSparseEqnComplexImpl<T>	cplxMatrix

Fields inherited from class com.interpss.core.sparse.impl.AbstractSparseEquation

colCnt, factored, rowCnt, solver, squareMatrix, zeroAii_row

Constructor Summary

Constructors

Constructor and Description
AbstractSparseEqnComplexMatrix3x3Impl(int n)
AbstractSparseEqnComplexMatrix3x3Impl(int rows, int cols)

Method Summary

Modifier and Type	Method and Description
void	addToA(Complex3x3 x, int i, int j) Add the aij object to the matrix.
void	addToB(Complex3x1 bi, int i) add to bi element.
boolean	factorization() Factorization, for example LU decomposition, of the matrix.
boolean	factorization(double tolerance) Factorization, for example LU decomposition, of the matrix.
Complex3x3	getA(int i, int j) Get the aij object.
ComplexSEqnRow	getElem(int i)
ISparseEqnComplex	getSparseEqnComplex()
int	getTotalElements() Get the total elements in the matrix
Complex3x1	getX(int i) Get the x[i] object, after the eqn is solved.
int	getZeroA_row() Get zero aii row number, in case the matrix is singular
int	getZeroAii_row() During the LU process, aii might be zero.
void	increaseDimension() Increase matrix dimension by 1.
void	reset() Reset the matrix to zero - set all aii and bi to 0.0 and clear the sparse structure, and release memory if necessary
void	setA(Complex3x3 x, int i, int j) Set the aij object.
void	setB2Unity(int i) Set all b elements to 0.0 and bi = 1.0, a unity vector.
void	setB2Zero() Set all b elements to 0.0
void	setBi(Complex3x1 bi, int i) Set b[i] object, before solving the eqn.
void	setBVector(Complex3x1[] bAry) Set b vector, before solving the eqn.
void	setElem(int i, ComplexSEqnRow aii)
void	setToZero() Reset all matrix element to zero, preserve the matrix sparse structure.
void	solveEqn() Solve the [A]X = B problem
boolean	solveEqn(double tolerance) LU decomposition of the matrix and the solve the [A]X = B problem.
java.lang.String	toString()

Methods inherited from class com.interpss.core.sparse.impl.AbstractSparseEquation

getBusId, getDimension, getDimension, isFactorized, isSquareMatrix, setBusId, setFactorized, setZeroAii_row

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.interpss.numeric.sparse.base.ISparseEquation

getBusId, getDimension, getDimension, isFactorized, isSquareMatrix, setBusId, setFactorized

Field Detail

cplxMatrix

protected AbstractSparseEqnComplexImpl<T extends ISparseEqnSolver> cplxMatrix

Constructor Detail

AbstractSparseEqnComplexMatrix3x3Impl

public AbstractSparseEqnComplexMatrix3x3Impl(int n)

AbstractSparseEqnComplexMatrix3x3Impl

public AbstractSparseEqnComplexMatrix3x3Impl(int rows,
                                             int cols)

Method Detail

getElem

public ComplexSEqnRow getElem(int i)

setElem

public void setElem(int i,
                    ComplexSEqnRow aii)

addToA

public void addToA(Complex3x3 x,
                   int i,
                   int j)

Description copied from interface: ISparseEqnObject

Add the aij object to the matrix. If aij exists, aij += x.

Specified by:

addToA in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

x - the aij element

i - the element row number

j - the element column number

getX

public Complex3x1 getX(int i)

Description copied from interface: ISparseEqnObject

Get the x[i] object, after the eqn is solved.

Specified by:

getX in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

i - the element row number

Returns:

the x[i] element

setA

public void setA(Complex3x3 x,
                 int i,
                 int j)

Description copied from interface: ISparseEqnObject

Set the aij object.

Specified by:

setA in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

x - the aij object

i - the element row number

j - the element column number

getA

public Complex3x3 getA(int i,
                       int j)

Description copied from interface: ISparseEqnObject

Get the aij object.

Specified by:

getA in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

i - the element row number

j - the element column number

Returns:

aij

setBi

public void setBi(Complex3x1 bi,
                  int i)

Description copied from interface: ISparseEqnObject

Set b[i] object, before solving the eqn.

Specified by:

setBi in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

bi - the bi element

i - row number

setBVector

public void setBVector(Complex3x1[] bAry)

Description copied from interface: ISparseEqnObject

Set b vector, before solving the eqn.

Specified by:

setBVector in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

bAry - the b vector elements

addToB

public void addToB(Complex3x1 bi,
                   int i)

Description copied from interface: ISparseEqnObject

add to bi element.

Specified by:

addToB in interface ISparseEqnObject<Complex3x3,Complex3x1>

Parameters:

bi - the bi element

i - row number

getZeroA_row

public int getZeroA_row()

Description copied from interface: ISparseEqnObject

Get zero aii row number, in case the matrix is singular

Specified by:

getZeroA_row in interface ISparseEqnObject<Complex3x3,Complex3x1>

Returns:

increaseDimension

public void increaseDimension()

Description copied from interface: ISparseEquation

Increase matrix dimension by 1. B[n] = 0.0, aii(n)=1.0, aij(n)=0.0

Specified by:

increaseDimension in interface ISparseEquation

getTotalElements

public int getTotalElements()

Description copied from interface: ISparseEquation

Get the total elements in the matrix

Specified by:

getTotalElements in interface ISparseEquation

Returns:

the total elements

factorization

public boolean factorization(double tolerance)
                      throws IpssNumericException

Description copied from interface: ISparseEquation

Factorization, for example LU decomposition, of the matrix.

Specified by:

factorization in interface ISparseEquation

Overrides:

factorization in class AbstractSparseEquation<T extends ISparseEqnSolver>

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

factorization

public boolean factorization()
                      throws IpssNumericException

Description copied from interface: ISparseEquation

Factorization, for example LU decomposition, of the matrix.

Specified by:

factorization in interface ISparseEquation

Overrides:

factorization in class AbstractSparseEquation<T extends ISparseEqnSolver>

Returns:

if succeed return true.

Throws:

IpssNumericException

solveEqn

public boolean solveEqn(double tolerance)
                 throws IpssNumericException

Description copied from class: AbstractSparseEquation

LU decomposition of the matrix and the solve the [A]X = B problem.

Specified by:

solveEqn in interface ISparseEquation

Overrides:

solveEqn in class AbstractSparseEquation<T extends ISparseEqnSolver>

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

solveEqn

public void solveEqn()
              throws IpssNumericException

Description copied from interface: ISparseEquation

Solve the [A]X = B problem

Specified by:

solveEqn in interface ISparseEquation

Throws:

IpssNumericException

setB2Unity

public void setB2Unity(int i)

Description copied from interface: ISparseEquation

Set all b elements to 0.0 and bi = 1.0, a unity vector.

Specified by:

setB2Unity in interface ISparseEquation

Parameters:

i - the element row number

setB2Zero

public void setB2Zero()

Description copied from interface: ISparseEquation

Set all b elements to 0.0

Specified by:

setB2Zero in interface ISparseEquation

Overrides:

setB2Zero in class AbstractSparseEquation<T extends ISparseEqnSolver>

reset

public void reset()

Description copied from interface: ISparseEquation

Reset the matrix to zero - set all aii and bi to 0.0 and clear the sparse structure, and release memory if necessary

Specified by:

reset in interface ISparseEquation

setToZero

public void setToZero()

Description copied from interface: ISparseEquation

Reset all matrix element to zero, preserve the matrix sparse structure.

Specified by:

setToZero in interface ISparseEquation

getZeroAii_row

public int getZeroAii_row()

Description copied from interface: ISparseEquation

During the LU process, aii might be zero. An exception will be thrown. This function is for getting zero aii row number for error reporting

Specified by:

getZeroAii_row in interface ISparseEquation

Overrides:

getZeroAii_row in class AbstractSparseEquation<T extends ISparseEqnSolver>

Returns:

the row number

getSparseEqnComplex

public ISparseEqnComplex getSparseEqnComplex()

Specified by:

getSparseEqnComplex in interface ISparseEqnComplexMatrix3x3

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object