HMatrixParameters¶
- class HMatrixParameters(*args)¶
Parameters for HMatrix class.
Notes
This class regroups the parameters used by
HMatrix
Methods
Return the admissibility factor used for cluster blocks.
Return the epsilon used for the assembly.
Accessor to the object's name.
Return the clustering algorithm.
Return the compression method.
Return the factorization method.
getName
()Accessor to the object's name.
Return the epsilon used for the recompression.
hasName
()Test if the object is named.
setAdmissibilityFactor
(admissibilityFactor)Set the admissibility factor used for cluster blocks.
setAssemblyEpsilon
(assemblyEpsilon)Set the epsilon used for the assembly.
setClusteringAlgorithm
(clusteringAlgorithm)Set the clustering algorithm.
setCompressionMethod
(compressionMethod)Set the compression method.
setFactorizationMethod
(factorization)Set the factorization method.
setName
(name)Accessor to the object's name.
setRecompressionEpsilon
(recompressionEpsilon)Set the epsilon used for the recompression.
- __init__(*args)¶
- getAdmissibilityFactor()¶
Return the admissibility factor used for cluster blocks.
- Returns:
- epsilonfloat
admissibility factor for HMatrix.
- getAssemblyEpsilon()¶
Return the epsilon used for the assembly.
- Returns:
- epsilonfloat
assembly epsilon for HMatrix.
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getClusteringAlgorithm()¶
Return the clustering algorithm.
- Returns:
- algorithmstr
clustering algorithm (either ‘median’, ‘geometric’ or ‘hybrid’).
- getCompressionMethod()¶
Return the compression method.
- Returns:
- methodstr
compression method (either ‘Svd’, ‘AcaFull’, ‘AcaPartial’, ‘AcaPlus’ or ‘AcaRandom’)
- getFactorizationMethod()¶
Return the factorization method.
- Returns:
- methodstr
Factorization method (either ‘LU’, ‘LDLt’, or ‘LLt’)
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getRecompressionEpsilon()¶
Return the epsilon used for the recompression.
- Returns:
- epsilonfloat
recompression epsilon for HMatrix.
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- setAdmissibilityFactor(admissibilityFactor)¶
Set the admissibility factor used for cluster blocks.
- Parameters:
- epsilonfloat
admissibility factor for HMatrix.
- setAssemblyEpsilon(assemblyEpsilon)¶
Set the epsilon used for the assembly.
- Parameters:
- epsilonfloat
assembly epsilon for HMatrix.
- setClusteringAlgorithm(clusteringAlgorithm)¶
Set the clustering algorithm.
- Parameters:
- algorithmstr
clustering algorithm (either ‘median’, ‘geometric’ or ‘hybrid’).
- setCompressionMethod(compressionMethod)¶
Set the compression method.
- Parameters:
- methodstr
compression method (either ‘Svd’, ‘AcaFull’, ‘AcaPartial’, ‘AcaPlus’ or ‘AcaRandom’)
- setFactorizationMethod(factorization)¶
Set the factorization method.
- Parameters:
- methodstr
Factorization method (either ‘LU’, ‘LDLt’, or ‘LLt’)
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setRecompressionEpsilon(recompressionEpsilon)¶
Set the epsilon used for the recompression.
- Parameters:
- epsilonfloat
recompression epsilon for HMatrix.