Table of contents
General
hypre
Reference Manual
IJ System Interface
A linear-algebraic conceptual interface
IJ Matrices
IJ Vectors
ParCSR Solvers
Linear solvers for sparse matrix systems
ParCSR BoomerAMG Solver
ParCSR Euclid Preconditioner
ParCSR GMRES Solver
ParCSR PCG Solver
ParCSR ParaSails Preconditioner
ParCSR Pilut Preconditioner
ParCSR Solvers
SStruct Solvers
Linear solvers for semi-structured grids
SStruct GMRES Solver
SStruct PCG Solver
SStruct Solvers
SStruct SysPFMG Solver
SStruct System Interface
A semi-structured-grid conceptual interface
SStruct Graphs
SStruct Grids
SStruct Matrices
SStruct Stencils
SStruct Vectors
Struct Solvers
Linear solvers for structured grids
Struct GMRES Solver
Struct Jacobi Solver
Struct PCG Solver
Struct PFMG Solver
Struct SMG Solver
Struct Solvers
Struct System Interface
A structured-grid conceptual interface
Struct Grids
Struct Matrices
Struct Stencils
Struct Vectors
Functions, Macros
HYPRE_BoomerAMGCreate
Create a solver object
HYPRE_BoomerAMGDestroy
Destroy a solver object
HYPRE_BoomerAMGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_BoomerAMGGetNumIterations
Return the number of iterations taken
HYPRE_BoomerAMGSetCoarsenType
(Optional)
HYPRE_BoomerAMGSetCycleType
(Optional)
HYPRE_BoomerAMGSetDebugFlag
(Optional)
HYPRE_BoomerAMGSetGridRelaxPoints
(Optional)
HYPRE_BoomerAMGSetGridRelaxType
(Optional)
HYPRE_BoomerAMGSetIOutDat
(Optional)
HYPRE_BoomerAMGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_BoomerAMGSetMaxLevels
(Optional) Set maximum number of multigrid levels
HYPRE_BoomerAMGSetMaxRowSum
(Optional)
HYPRE_BoomerAMGSetMeasureType
(Optional)
HYPRE_BoomerAMGSetNumGridSweeps
(Optional)
HYPRE_BoomerAMGSetRelaxWeight
(Optional)
HYPRE_BoomerAMGSetStrongThreshold
(Optional) Set AMG strength threshold
HYPRE_BoomerAMGSetTol
(Optional) Set the convergence tolerance
HYPRE_BoomerAMGSetup
HYPRE_BoomerAMGSolve
Solve the system
HYPRE_EuclidCreate
Create a Euclid object
HYPRE_EuclidDestroy
Destroy a Euclid object
HYPRE_EuclidSetParam
Insert a single (name, value) pair in Euclid's options database
HYPRE_EuclidSetParams
Insert (name, value) pairs in Euclid's options database by passing Euclid the command line (or an array of strings)
HYPRE_EuclidSetParamsFromFile
Insert (name, value) pairs in Euclid's options database
HYPRE_EuclidSetup
Set up the Euclid preconditioner
HYPRE_EuclidSolve
Apply the Euclid preconditioner
HYPRE_IJMatrixAddToValues
Adds to values for
nrows
of the matrix
HYPRE_IJMatrixAssemble
Finalize the construction of the matrix before using
HYPRE_IJMatrixCreate
Create a matrix object
HYPRE_IJMatrixDestroy
Destroy a matrix object
HYPRE_IJMatrixGetObject
Get a reference to the constructed matrix object
HYPRE_IJMatrixGetObjectType
Get the storage type of the constructed matrix object
HYPRE_IJMatrixGetValues
Gets values for
nrows
of the matrix
HYPRE_IJMatrixInitialize
Prepare a matrix object for setting coefficient values
HYPRE_IJMatrixPrint
Print the matrix to file
HYPRE_IJMatrixRead
Read the matrix from file
HYPRE_IJMatrixSetDiagOffdSizes
(Optional) Set the max number of nonzeros to expect in each row of the diagonal and off-diagonal blocks
HYPRE_IJMatrixSetObjectType
Set the storage type of the matrix object to be constructed
HYPRE_IJMatrixSetRowSizes
(Optional) Set the max number of nonzeros to expect in each row
HYPRE_IJMatrixSetValues
Sets values for
nrows
of the matrix
HYPRE_IJVectorAddToValues
Adds to values in vector
HYPRE_IJVectorAssemble
Finalize the construction of the vector before using
HYPRE_IJVectorCreate
Create a vector object
HYPRE_IJVectorDestroy
Destroy a vector object
HYPRE_IJVectorGetObject
Get a reference to the constructed vector object
HYPRE_IJVectorGetObjectType
Get the storage type of the constructed vector object
HYPRE_IJVectorGetValues
Gets values in vector
HYPRE_IJVectorInitialize
Prepare a vector object for setting coefficient values
HYPRE_IJVectorPrint
Print the vector to file
HYPRE_IJVectorRead
Read the vector from file
HYPRE_IJVectorSetObjectType
Set the storage type of the vector object to be constructed
HYPRE_IJVectorSetValues
Sets values in vector
HYPRE_ParaSailsCreate
Create a ParaSails preconditioner
HYPRE_ParaSailsDestroy
Destroy a ParaSails preconditioner
HYPRE_ParaSailsSetFilter
Set the filter parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetLoadbal
Set the load balance parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetLogging
Set the logging parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetParams
Set the threshold and levels parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetReuse
Set the pattern reuse parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetSym
Set the symmetry parameter for the ParaSails preconditioner
HYPRE_ParaSailsSetup
Set up the ParaSails preconditioner
HYPRE_ParaSailsSolve
Apply the ParaSails preconditioner
HYPRE_ParCSRDiagScale
Solve routine for diagonal preconditioning
HYPRE_ParCSRDiagScaleSetup
Setup routine for diagonal preconditioning
HYPRE_ParCSRGMRESCreate
Create a solver object
HYPRE_ParCSRGMRESDestroy
Destroy a solver object
HYPRE_ParCSRGMRESGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_ParCSRGMRESGetNumIterations
Return the number of iterations taken
HYPRE_ParCSRGMRESGetPrecond
HYPRE_ParCSRGMRESSetKDim
(Optional) Set the maximum size of the Krylov space
HYPRE_ParCSRGMRESSetLogging
(Optional) Set the amount of logging to do
HYPRE_ParCSRGMRESSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_ParCSRGMRESSetPrecond
(Optional) Set the preconditioner to use
HYPRE_ParCSRGMRESSetTol
(Optional) Set the convergence tolerance
HYPRE_ParCSRGMRESSetup
HYPRE_ParCSRGMRESSolve
Solve the system
HYPRE_ParCSRPCGCreate
Create a solver object
HYPRE_ParCSRPCGDestroy
Destroy a solver object
HYPRE_ParCSRPCGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_ParCSRPCGGetNumIterations
Return the number of iterations taken
HYPRE_ParCSRPCGGetPrecond
HYPRE_ParCSRPCGSetLogging
(Optional) Set the amount of logging to do
HYPRE_ParCSRPCGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_ParCSRPCGSetPrecond
(Optional) Set the preconditioner to use
HYPRE_ParCSRPCGSetRelChange
(Optional) Additionally require that the relative difference in successive iterates be small
HYPRE_ParCSRPCGSetTol
(Optional) Set the convergence tolerance
HYPRE_ParCSRPCGSetTwoNorm
(Optional) Use the two-norm in stopping criteria
HYPRE_ParCSRPCGSetup
HYPRE_ParCSRPCGSolve
Solve the system
HYPRE_ParCSRPilutCreate
Create a preconditioner object
HYPRE_ParCSRPilutDestroy
Destroy a preconditioner object
HYPRE_ParCSRPilutSetDropTolerance
(Optional)
HYPRE_ParCSRPilutSetFactorRowSize
(Optional)
HYPRE_ParCSRPilutSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_ParCSRPilutSetup
HYPRE_ParCSRPilutSolve
Precondition the system
HYPRE_SStructGMRESCreate
Create a solver object
HYPRE_SStructGMRESDestroy
Destroy a solver object
HYPRE_SStructGMRESGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_SStructGMRESGetNumIterations
Return the number of iterations taken
HYPRE_SStructGMRESSetKDim
(Optional) Set the maximum size of the Krylov space
HYPRE_SStructGMRESSetLogging
(Optional) Set the amount of logging to do
HYPRE_SStructGMRESSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_SStructGMRESSetPrecond
(Optional) Set the preconditioner to use
HYPRE_SStructGMRESSetTol
(Optional) Set the convergence tolerance
HYPRE_SStructGMRESSetup
HYPRE_SStructGMRESSolve
Solve the system
HYPRE_SStructGraphAddEntries
Add a non-stencil graph entry at a particular index
HYPRE_SStructGraphAssemble
Finalize the construction of the graph before using
HYPRE_SStructGraphCreate
Create a graph object
HYPRE_SStructGraphDestroy
Destroy a graph object
HYPRE_SStructGraphSetStencil
Set the stencil for a variable on a structured part of the grid
HYPRE_SStructGridAddUnstructuredPart
Add an unstructured part to the grid
HYPRE_SStructGridAddVariables
Describe additional variables that live at a particular index
HYPRE_SStructGridAssemble
Finalize the construction of the grid before using
HYPRE_SStructGridCreate
Create an
ndim
-dimensional grid object with
nparts
structured parts
HYPRE_SStructGridDestroy
Destroy a grid object
HYPRE_SStructGridSetExtents
Set the extents for a box on a structured part of the grid
HYPRE_SStructGridSetNeighborBox
Describe how regions just outside of a part relate to other parts
HYPRE_SStructGridSetPeriodic
(Optional) Set periodic for a particular part
HYPRE_SStructGridSetVariables
Describe the variables that live on a structured part of the grid
HYPRE_SStructMatrixAddToBoxValues
Add to matrix coefficients a box at a time
HYPRE_SStructMatrixAddToValues
Add to matrix coefficients index by index
HYPRE_SStructMatrixAssemble
Finalize the construction of the matrix before using
HYPRE_SStructMatrixCreate
Create a matrix object
HYPRE_SStructMatrixDestroy
Destroy a matrix object
HYPRE_SStructMatrixGetObject
Get a reference to the constructed matrix object
HYPRE_SStructMatrixInitialize
Prepare a matrix object for setting coefficient values
HYPRE_SStructMatrixPrint
Print the matrix to file
HYPRE_SStructMatrixSetBoxValues
Set matrix coefficients a box at a time
HYPRE_SStructMatrixSetComplex
Set the matrix to be complex
HYPRE_SStructMatrixSetObjectType
Set the storage type of the matrix object to be constructed
HYPRE_SStructMatrixSetSymmetric
Define symmetry properties of the matrix
HYPRE_SStructMatrixSetValues
Set matrix coefficients index by index
HYPRE_SStructPCGCreate
Create a solver object
HYPRE_SStructPCGDestroy
Destroy a solver object
HYPRE_SStructPCGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_SStructPCGGetNumIterations
Return the number of iterations taken
HYPRE_SStructPCGSetLogging
(Optional) Set the amount of logging to do
HYPRE_SStructPCGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_SStructPCGSetPrecond
(Optional) Set the preconditioner to use
HYPRE_SStructPCGSetRelChange
(Optional) Set to use additional relative-change convergence test
HYPRE_SStructPCGSetTol
(Optional) Set the convergence tolerance
HYPRE_SStructPCGSetTwoNorm
(Optional) Set type of norm to use in stopping criteria
HYPRE_SStructPCGSetup
HYPRE_SStructPCGSolve
Solve the system
HYPRE_SStructStencilCreate
Create a stencil object for the specified number of spatial dimensions and stencil entries
HYPRE_SStructStencilDestroy
Destroy a stencil object
HYPRE_SStructStencilSetEntry
Set a stencil entry
HYPRE_SStructSysPFMGCreate
Create a solver object
HYPRE_SStructSysPFMGDestroy
Destroy a solver object
HYPRE_SStructSysPFMGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_SStructSysPFMGGetNumIterations
Return the number of iterations taken
HYPRE_SStructSysPFMGSetLogging
(Optional) Set the amount of logging to do
HYPRE_SStructSysPFMGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_SStructSysPFMGSetNonZeroGuess
(Optional) Use a nonzero initial guess
HYPRE_SStructSysPFMGSetNumPostRelax
(Optional) Set number of post-relaxation sweeps
HYPRE_SStructSysPFMGSetNumPreRelax
(Optional) Set number of pre-relaxation sweeps
HYPRE_SStructSysPFMGSetRelaxType
(Optional) Set relaxation type
HYPRE_SStructSysPFMGSetRelChange
(Optional) Additionally require that the relative difference in successive iterates be small
HYPRE_SStructSysPFMGSetSkipRelax
(Optional) Skip relaxation on certain grids for isotropic problems
HYPRE_SStructSysPFMGSetTol
(Optional) Set the convergence tolerance
HYPRE_SStructSysPFMGSetup
HYPRE_SStructSysPFMGSetZeroGuess
(Optional) Use a zero initial guess
HYPRE_SStructSysPFMGSolve
Solve the system
HYPRE_SStructVectorAddToBoxValues
Set vector coefficients a box at a time
HYPRE_SStructVectorAddToValues
Set vector coefficients index by index
HYPRE_SStructVectorAssemble
Finalize the construction of the vector before using
HYPRE_SStructVectorCreate
Create a vector object
HYPRE_SStructVectorDestroy
Destroy a vector object
HYPRE_SStructVectorGather
Gather vector data so that efficient
GetValues
can be done
HYPRE_SStructVectorGetBoxValues
Get vector coefficients a box at a time
HYPRE_SStructVectorGetObject
Get a reference to the constructed vector object
HYPRE_SStructVectorGetValues
Get vector coefficients index by index
HYPRE_SStructVectorInitialize
Prepare a vector object for setting coefficient values
HYPRE_SStructVectorPrint
Print the vector to file
HYPRE_SStructVectorSetBoxValues
Set vector coefficients a box at a time
HYPRE_SStructVectorSetComplex
Set the vector to be complex
HYPRE_SStructVectorSetObjectType
Set the storage type of the vector object to be constructed
HYPRE_SStructVectorSetValues
Set vector coefficients index by index
HYPRE_StructDiagScale
Solve routine for diagonal preconditioning
HYPRE_StructDiagScaleSetup
Setup routine for diagonal preconditioning
HYPRE_StructGMRESCreate
Create a solver object
HYPRE_StructGMRESDestroy
Destroy a solver object
HYPRE_StructGMRESGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_StructGMRESGetNumIterations
Return the number of iterations taken
HYPRE_StructGMRESSetLogging
(Optional) Set the amount of logging to do
HYPRE_StructGMRESSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_StructGMRESSetPrecond
(Optional) Set the preconditioner to use
HYPRE_StructGMRESSetTol
(Optional) Set the convergence tolerance
HYPRE_StructGMRESSetup
set up
HYPRE_StructGMRESSolve
Solve the system
HYPRE_StructGridAssemble
Finalize the construction of the grid before using
HYPRE_StructGridCreate
Create an
ndim
-dimensional grid object
HYPRE_StructGridDestroy
Destroy a grid object
HYPRE_StructGridSetExtents
Set the extents for a box on the grid
HYPRE_StructGridSetPeriodic
(Optional) Set periodic
HYPRE_StructJacobiCreate
Create a solver object
HYPRE_StructJacobiDestroy
Destroy a solver object
HYPRE_StructJacobiGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_StructJacobiGetNumIterations
Return the number of iterations taken
HYPRE_StructJacobiSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_StructJacobiSetNonZeroGuess
(Optional) Use a nonzero initial guess
HYPRE_StructJacobiSetTol
(Optional) Set the convergence tolerance
HYPRE_StructJacobiSetup
HYPRE_StructJacobiSetZeroGuess
(Optional) Use a zero initial guess
HYPRE_StructJacobiSolve
Solve the system
HYPRE_StructMatrixAddToBoxValues
Add to matrix coefficients a box at a time
HYPRE_StructMatrixAddToValues
Add to matrix coefficients index by index
HYPRE_StructMatrixAssemble
Finalize the construction of the matrix before using
HYPRE_StructMatrixCreate
Create a matrix object
HYPRE_StructMatrixDestroy
Destroy a matrix object
HYPRE_StructMatrixInitialize
Prepare a matrix object for setting coefficient values
HYPRE_StructMatrixPrint
Print the matrix to file
HYPRE_StructMatrixSetBoxValues
Set matrix coefficients a box at a time
HYPRE_StructMatrixSetSymmetric
(Optional) Define symmetry properties of the matrix
HYPRE_StructMatrixSetValues
Set matrix coefficients index by index
HYPRE_StructPCGCreate
Create a solver object
HYPRE_StructPCGDestroy
Destroy a solver object
HYPRE_StructPCGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_StructPCGGetNumIterations
Return the number of iterations taken
HYPRE_StructPCGSetLogging
(Optional) Set the amount of logging to do
HYPRE_StructPCGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_StructPCGSetPrecond
(Optional) Set the preconditioner to use
HYPRE_StructPCGSetRelChange
(Optional) Additionally require that the relative difference in successive iterates be small
HYPRE_StructPCGSetTol
(Optional) Set the convergence tolerance
HYPRE_StructPCGSetTwoNorm
(Optional) Use the two-norm in stopping criteria
HYPRE_StructPCGSetup
HYPRE_StructPCGSolve
Solve the system
HYPRE_StructPFMGCreate
Create a solver object
HYPRE_StructPFMGDestroy
Destroy a solver object
HYPRE_StructPFMGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_StructPFMGGetNumIterations
Return the number of iterations taken
HYPRE_StructPFMGSetLogging
(Optional) Set the amount of logging to do
HYPRE_StructPFMGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_StructPFMGSetNonZeroGuess
(Optional) Use a nonzero initial guess
HYPRE_StructPFMGSetNumPostRelax
(Optional) Set number of post-relaxation sweeps
HYPRE_StructPFMGSetNumPreRelax
(Optional) Set number of pre-relaxation sweeps
HYPRE_StructPFMGSetRelaxType
(Optional) Set relaxation type
HYPRE_StructPFMGSetRelChange
(Optional) Additionally require that the relative difference in successive iterates be small
HYPRE_StructPFMGSetSkipRelax
(Optional) Skip relaxation on certain grids for isotropic problems
HYPRE_StructPFMGSetTol
(Optional) Set the convergence tolerance
HYPRE_StructPFMGSetup
HYPRE_StructPFMGSetZeroGuess
(Optional) Use a zero initial guess
HYPRE_StructPFMGSolve
Solve the system
HYPRE_StructSMGCreate
Create a solver object
HYPRE_StructSMGDestroy
Destroy a solver object
HYPRE_StructSMGGetFinalRelativeResidualNorm
Return the norm of the final relative residual
HYPRE_StructSMGGetNumIterations
Return the number of iterations taken
HYPRE_StructSMGSetLogging
(Optional) Set the amount of logging to do
HYPRE_StructSMGSetMaxIter
(Optional) Set maximum number of iterations
HYPRE_StructSMGSetNonZeroGuess
(Optional) Use a nonzero initial guess
HYPRE_StructSMGSetNumPostRelax
(Optional) Set number of post-relaxation sweeps
HYPRE_StructSMGSetNumPreRelax
(Optional) Set number of pre-relaxation sweeps
HYPRE_StructSMGSetRelChange
(Optional) Additionally require that the relative difference in successive iterates be small
HYPRE_StructSMGSetTol
(Optional) Set the convergence tolerance
HYPRE_StructSMGSetup
HYPRE_StructSMGSetZeroGuess
(Optional) Use a zero initial guess
HYPRE_StructSMGSolve
Solve the system
HYPRE_StructStencilCreate
Create a stencil object for the specified number of spatial dimensions and stencil entries
HYPRE_StructStencilDestroy
Destroy a stencil object
HYPRE_StructStencilSetElement
Set a stencil entry
HYPRE_StructVectorAddToBoxValues
Set vector coefficients a box at a time
HYPRE_StructVectorAddToValues
Set vector coefficients index by index
HYPRE_StructVectorAssemble
Finalize the construction of the vector before using
HYPRE_StructVectorCreate
Create a vector object
HYPRE_StructVectorDestroy
Destroy a vector object
HYPRE_StructVectorGetBoxValues
Get vector coefficients a box at a time
HYPRE_StructVectorGetValues
Get vector coefficients index by index
HYPRE_StructVectorInitialize
Prepare a vector object for setting coefficient values
HYPRE_StructVectorPrint
Print the vector to file
HYPRE_StructVectorSetBoxValues
Set vector coefficients a box at a time
HYPRE_StructVectorSetValues
Set vector coefficients index by index
Macros
HYPRE_IJMatrix
The matrix object
HYPRE_IJVector
The vector object
HYPRE_SOLVER_STRUCT
The solver object
HYPRE_SStructGraph
The graph object is used to describe the nonzero structure of a matrix
HYPRE_SStructGrid
A grid object is constructed out of several structured ``parts'' and an optional unstructured ``part''
HYPRE_SStructMatrix
The matrix object
HYPRE_SStructSolver
The solver object
HYPRE_SStructStencil
The stencil object
HYPRE_SStructVariable
An enumerated type that supports cell centered, node centered, face centered, and edge centered variables
HYPRE_SStructVector
The vector object
HYPRE_StructGrid
A grid object is constructed out of several ``boxes'', defined on a global abstract index space
HYPRE_StructMatrix
The matrix object
HYPRE_StructSolver
The solver object
HYPRE_StructStencil
The stencil object
HYPRE_StructVector
The vector object
hierarchy of classes