Table of contents

General

• hypre Reference Manual
  • Finite Element Interface A finite element-based conceptual interface
    • FEI Functions
    • FEI Solver Parameters
      • BoomerAMG Parameter options for the algebraic multigrid preconditioner BoomerAMG
      • Diagnostics Parameters control diagnostic information, memory use, etc
      • MLI Parameter options for the smoothed aggregation preconditioner MLI
      • Reduction Parameters which define different reduction modes
      • Solvers Here the various options for solvers and preconditioners are defined
      • Various Parameter options for ILUT, ParaSails and polynomial preconditioners are defined
  • IJ System Interface A linear-algebraic conceptual interface
    • IJ Matrices
    • IJ Vectors
  • Krylov Solvers A basic interface for Krylov solvers
    • BiCGSTAB Solver
    • CGNR Solver
    • FlexGMRES Solver
    • GMRES Solver
    • Krylov Solvers
    • LGMRES Solver
    • PCG Solver
  • ParCSR Solvers Linear solvers for sparse matrix systems
    • ParCSR AMS Solver and Preconditioner
    • ParCSR BiCGSTAB Solver
    • ParCSR BoomerAMG Solver and Preconditioner
    • ParCSR Euclid Preconditioner
    • ParCSR FlexGMRES Solver
    • ParCSR GMRES Solver
    • ParCSR Hybrid Solver
    • ParCSR LGMRES Solver
    • ParCSR PCG Solver
    • ParCSR ParaSails Preconditioner
    • ParCSR Pilut Preconditioner
    • ParCSR Solvers
  • SStruct Solvers Linear solvers for semi-structured grids
    • SStruct BiCGSTAB Solver
    • SStruct FAC Solver
    • SStruct FlexGMRES Solver
    • SStruct GMRES Solver
    • SStruct LGMRES Solver
    • SStruct Maxwell Solver
    • SStruct PCG Solver
    • SStruct Solvers
    • SStruct Split Solver
    • 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 BiCGSTAB Solver
    • Struct FlexGMRES Solver
    • Struct GMRES Solver
    • Struct Hybrid Solver
    • Struct Jacobi Solver
    • Struct LGMRES 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

• getBlockNodeIDList This function returns the node identifiers given the element block
• getBlockNodeSolution This function returns the nodal solutions given the element block number
• getNumBlockActEqns This function returns the number of unknowns given the element block
• getNumBlockActNodes This function returns the number of nodes given the element block
• HYPRE_AMSConstructDiscreteGradient Construct and return the discrete gradient matrix G using some edge and vertex information
• HYPRE_AMSCreate Create an AMS solver object
• HYPRE_AMSDestroy Destroy an AMS solver object
• HYPRE_AMSGetFinalRelativeResidualNorm Returns the norm of the final relative residual
• HYPRE_AMSGetNumIterations Returns the number of iterations taken
• HYPRE_AMSSetAlphaAMGOptions (Optional) Sets AMG parameters for
• HYPRE_AMSSetAlphaPoissonMatrix (Optional) Sets the matrix corresponding to the Poisson problem with coefficient (the curl-curl term coefficient in the Maxwell problem)
• HYPRE_AMSSetBetaAMGOptions (Optional) Sets AMG parameters for
• HYPRE_AMSSetBetaPoissonMatrix (Optional) Sets the matrix corresponding to the Poisson problem with coefficient (the mass term coefficient in the Maxwell problem)
• HYPRE_AMSSetCoordinateVectors Sets the , and coordinates of the vertices in the mesh
• HYPRE_AMSSetCycleType (Optional) Choose which three-level solver to use
• HYPRE_AMSSetDimension (Optional) Sets the problem dimension (2 or 3)
• HYPRE_AMSSetDiscreteGradient Sets the discrete gradient matrix
• HYPRE_AMSSetEdgeConstantVectors Sets the vectors , and which give the representations of the constant vector fields , and in the edge element basis
• HYPRE_AMSSetMaxIter (Optional) Sets maximum number of iterations, if AMS is used as a solver
• HYPRE_AMSSetPrintLevel (Optional) Control how much information is printed during the solution iterations
• HYPRE_AMSSetSmoothingOptions (Optional) Sets relaxation parameters for
• HYPRE_AMSSetTol (Optional) Set the convergence tolerance, if AMS is used as a solver
• HYPRE_AMSSetup Set up the AMS solver or preconditioner
• HYPRE_AMSSolve Solve the system or apply AMS as a preconditioner
• HYPRE_BiCGSTABGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_BiCGSTABGetNumIterations Return the number of iterations taken
• HYPRE_BiCGSTABGetPrecond
• HYPRE_BiCGSTABGetResidual Return the residual
• HYPRE_BiCGSTABSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_BiCGSTABSetLogging (Optional) Set the amount of logging to do
• HYPRE_BiCGSTABSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_BiCGSTABSetPrecond (Optional) Set the preconditioner to use
• HYPRE_BiCGSTABSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_BiCGSTABSetTol (Optional) Set the convergence tolerance
• HYPRE_BiCGSTABSetup Prepare to solve the system
• HYPRE_BiCGSTABSolve Solve the system
• HYPRE_BoomerAMGCreate Create a solver object
• HYPRE_BoomerAMGDestroy Destroy a solver object
• HYPRE_BoomerAMGGetFinalRelativeResidualNorm Returns the norm of the final relative residual
• HYPRE_BoomerAMGGetNumIterations Returns the number of iterations taken
• HYPRE_BoomerAMGGetResidual Returns the residual
• HYPRE_BoomerAMGInitGridRelaxation (Optional) This routine will be eliminated in the future
• HYPRE_BoomerAMGSetAggNumLevels (Optional) Defines the number of levels of aggressive coarsening
• HYPRE_BoomerAMGSetCGCIts (optional) Defines the number of pathes for CGC-coarsening
• HYPRE_BoomerAMGSetCoarsenType (Optional) Defines which parallel coarsening algorithm is used
• HYPRE_BoomerAMGSetCycleNumSweeps (Optional) Sets the number of sweeps at a specified cycle
• HYPRE_BoomerAMGSetCycleRelaxType (Optional) Defines the smoother at a given cycle
• HYPRE_BoomerAMGSetCycleType (Optional) Defines the type of cycle
• HYPRE_BoomerAMGSetDebugFlag (Optional)
• HYPRE_BoomerAMGSetDofFunc (Optional) Sets the mapping that assigns the function to each variable, if using the systems version
• HYPRE_BoomerAMGSetDomainType (Optional) Defines the type of domain used for the Schwarz method
• HYPRE_BoomerAMGSetDropTol (Optional) Defines drop tolerance for PILUT
• HYPRE_BoomerAMGSetEuBJ (Optional) Defines use of block jacobi ILUT for Euclid
• HYPRE_BoomerAMGSetEuclidFile (Optional) Defines name of an input file for Euclid parameters
• HYPRE_BoomerAMGSetEuLevel (Optional) Defines number of levels for ILU(k) in Euclid
• HYPRE_BoomerAMGSetEuSparseA (Optional) Defines filter for ILU(k) for Euclid
• HYPRE_BoomerAMGSetFilter (Optional) Defines filter for ParaSAILS
• HYPRE_BoomerAMGSetGridRelaxPoints (Optional) Defines in which order the points are relaxed
• HYPRE_BoomerAMGSetGridRelaxType (Optional) Defines which smoother is used on the fine and coarse grid, the up and down cycle
• HYPRE_BoomerAMGSetGSMG (Optional) Specifies the use of GSMG - geometrically smooth coarsening and interpolation
• HYPRE_BoomerAMGSetInterpType (Optional) Defines which parallel interpolation operator is used
• HYPRE_BoomerAMGSetLevel (Optional) Defines number of levels for ParaSAILS
• HYPRE_BoomerAMGSetLevelOuterWt (Optional) Defines the outer relaxation weight for hybrid SOR or SSOR on the user defined level
• HYPRE_BoomerAMGSetLevelRelaxWt (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR on the user defined level
• HYPRE_BoomerAMGSetLogging (Optional) Requests additional computations for diagnostic and similar data to be logged by the user
• HYPRE_BoomerAMGSetMaxIter (Optional) Sets maximum number of iterations, if BoomerAMG is used as a solver
• HYPRE_BoomerAMGSetMaxLevels (Optional) Sets maximum number of multigrid levels
• HYPRE_BoomerAMGSetMaxNzPerRow (Optional) Defines maximal number of nonzeros for PILUT
• HYPRE_BoomerAMGSetMaxRowSum (Optional) Sets a parameter to modify the definition of strength for diagonal dominant portions of the matrix
• HYPRE_BoomerAMGSetMeasureType (Optional) Defines whether local or global measures are used
• HYPRE_BoomerAMGSetMinIter (Optional)
• HYPRE_BoomerAMGSetNodal (Optional) Sets whether to use the nodal systems version
• HYPRE_BoomerAMGSetNodalDiag (Optional) Sets whether to give spoecial treatment to diagonal elements in the nodal systems version
• HYPRE_BoomerAMGSetNumFunctions (Optional) Sets the size of the system of PDEs, if using the systems version
• HYPRE_BoomerAMGSetNumGridSweeps (Optional) Defines the number of sweeps for the fine and coarse grid, the up and down cycle
• HYPRE_BoomerAMGSetNumPaths (Optional) Defines the degree of aggressive coarsening
• HYPRE_BoomerAMGSetNumSamples (Optional) Defines the number of sample vectors used in GSMG or LS interpolation
• HYPRE_BoomerAMGSetNumSweeps (Optional) Sets the number of sweeps
• HYPRE_BoomerAMGSetOmega (Optional) Defines the outer relaxation weight for hybrid SOR
• HYPRE_BoomerAMGSetOuterWt (Optional) Defines the outer relaxation weight for hybrid SOR and SSOR on all levels
• HYPRE_BoomerAMGSetOverlap (Optional) Defines the overlap for the Schwarz method
• HYPRE_BoomerAMGSetPMaxElmts (Optional) Defines the maximal number of elements per row for the interpolation
• HYPRE_BoomerAMGSetPrintLevel (Optional) Requests automatic printing of setup and solve information
• HYPRE_BoomerAMGSetRelaxOrder (Optional) Defines in which order the points are relaxed
• HYPRE_BoomerAMGSetRelaxType (Optional) Defines the smoother to be used
• HYPRE_BoomerAMGSetRelaxWeight (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR
• HYPRE_BoomerAMGSetRelaxWt (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR on all levels
• HYPRE_BoomerAMGSetSchwarzRlxWeight (Optional) Defines a smoothing parameter for the additive Schwarz method
• HYPRE_BoomerAMGSetSchwarzUseNonSymm (Optional) Indicates that the aggregates may not be SPD for the Schwarz method
• HYPRE_BoomerAMGSetSCommPkgSwitch (Optional) Defines the largest strength threshold for which the strength matrix S uses the communication package of the operator A
• HYPRE_BoomerAMGSetSmoothNumLevels (Optional) Sets the number of levels for more complex smoothers
• HYPRE_BoomerAMGSetSmoothNumSweeps (Optional) Sets the number of sweeps for more complex smoothers
• HYPRE_BoomerAMGSetSmoothType (Optional) Enables the use of more complex smoothers
• HYPRE_BoomerAMGSetStrongThreshold (Optional) Sets AMG strength threshold
• HYPRE_BoomerAMGSetSym (Optional) Defines symmetry for ParaSAILS
• HYPRE_BoomerAMGSetThreshold (Optional) Defines threshold for ParaSAILS
• HYPRE_BoomerAMGSetTol (Optional) Set the convergence tolerance, if BoomerAMG is used as a solver
• HYPRE_BoomerAMGSetTruncFactor (Optional) Defines a truncation factor for the interpolation
• HYPRE_BoomerAMGSetup Set up the BoomerAMG solver or preconditioner
• HYPRE_BoomerAMGSetVariant (Optional) Defines which variant of the Schwarz method is used
• HYPRE_BoomerAMGSolve Solve the system or apply AMG as a preconditioner
• HYPRE_BoomerAMGSolveT Solve the transpose system or apply AMG as a preconditioner to the transpose system
• HYPRE_CGNRGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_CGNRGetNumIterations Return the number of iterations taken
• HYPRE_CGNRGetPrecond
• HYPRE_CGNRSetLogging (Optional) Set the amount of logging to do
• HYPRE_CGNRSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_CGNRSetPrecond (Optional) Set the preconditioner to use
• HYPRE_CGNRSetTol (Optional) Set the convergence tolerance
• HYPRE_CGNRSetup Prepare to solve the system
• HYPRE_CGNRSolve Solve the system
• HYPRE_EuclidCreate Create a Euclid object
• HYPRE_EuclidDestroy Destroy a Euclid object
• HYPRE_EuclidSetBJ Use block Jacobi ILU preconditioning instead of PILU
• HYPRE_EuclidSetILUT uses ILUT and defines a drop tolerance relative to the largest absolute value of any entry in the row being factored
• HYPRE_EuclidSetLevel Set level k for ILU(k) factorization, default: 1
• HYPRE_EuclidSetMem If eu_mem not equal 0, a summary of Euclid's memory usage is printed to stdout
• 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_EuclidSetRowScale If row_scale not equal 0, values are scaled prior to factorization so that largest value in any row is +1 or -1
• HYPRE_EuclidSetSparseA Defines a drop tolerance for ILU(k)
• HYPRE_EuclidSetStats If eu_stats not equal 0, a summary of runtime settings and timing information is printed to stdout
• HYPRE_EuclidSetup Set up the Euclid preconditioner
• HYPRE_EuclidSolve Apply the Euclid preconditioner
• HYPRE_FlexGMRESGetConverged
• HYPRE_FlexGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_FlexGMRESGetKDim
• HYPRE_FlexGMRESGetLogging
• HYPRE_FlexGMRESGetMaxIter
• HYPRE_FlexGMRESGetNumIterations Return the number of iterations taken
• HYPRE_FlexGMRESGetPrecond
• HYPRE_FlexGMRESGetPrintLevel
• HYPRE_FlexGMRESGetResidual Return the residual
• HYPRE_FlexGMRESGetTol
• HYPRE_FlexGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_FlexGMRESSetKDim (Optional) Set the maximum size of the Krylov space
• HYPRE_FlexGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_FlexGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_FlexGMRESSetModifyPC (Optional) Set a user-defined function to modify solve-time preconditioner attributes
• HYPRE_FlexGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_FlexGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_FlexGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_FlexGMRESSetup Prepare to solve the system
• HYPRE_FlexGMRESSolve Solve the system
• HYPRE_GMRESGetAbsoluteTol
• HYPRE_GMRESGetConverged
• HYPRE_GMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_GMRESGetKDim
• HYPRE_GMRESGetLogging
• HYPRE_GMRESGetMaxIter
• HYPRE_GMRESGetNumIterations Return the number of iterations taken
• HYPRE_GMRESGetPrecond
• HYPRE_GMRESGetPrintLevel
• HYPRE_GMRESGetRelChange
• HYPRE_GMRESGetResidual Return the residual
• HYPRE_GMRESGetTol
• HYPRE_GMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_GMRESSetKDim (Optional) Set the maximum size of the Krylov space
• HYPRE_GMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_GMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_GMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_GMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_GMRESSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_GMRESSetTol (Optional) Set the relative convergence tolerance
• HYPRE_GMRESSetup Prepare to solve the system
• HYPRE_GMRESSolve Solve the system
• HYPRE_IJMatrixAddToValues Adds to values for nrows rows or partial rows 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_IJMatrixGetLocalRange Gets range of rows owned by this processor and range of column partitioning for this processor
• HYPRE_IJMatrixGetObject Get a reference to the constructed matrix object
• HYPRE_IJMatrixGetObjectType Get the storage type of the constructed matrix object
• HYPRE_IJMatrixGetRowCounts Gets number of nonzeros elements for nrows rows specified in rows and returns them in ncols, which needs to be allocated by the user
• HYPRE_IJMatrixGetValues Gets values for nrows rows or partial rows 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_IJMatrixSetMaxOffProcElmts (Optional) Sets the maximum number of elements that are expected to be set (or added) on other processors from this processor This routine can significantly improve the efficiency of matrix construction, and should always be utilized if possible
• 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 rows or partial rows 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_IJVectorGetLocalRange Returns range of the part of the vector owned by this processor
• 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_IJVectorSetMaxOffProcElmts (Optional) Sets the maximum number of elements that are expected to be set (or added) on other processors from this processor This routine can significantly improve the efficiency of matrix construction, and should always be utilized if possible
• HYPRE_IJVectorSetObjectType Set the storage type of the vector object to be constructed
• HYPRE_IJVectorSetValues Sets values in vector
• HYPRE_LGMRESGetAugDim
• HYPRE_LGMRESGetConverged
• HYPRE_LGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_LGMRESGetKDim
• HYPRE_LGMRESGetLogging
• HYPRE_LGMRESGetMaxIter
• HYPRE_LGMRESGetNumIterations Return the number of iterations taken
• HYPRE_LGMRESGetPrecond
• HYPRE_LGMRESGetPrintLevel
• HYPRE_LGMRESGetResidual Return the residual
• HYPRE_LGMRESGetTol
• HYPRE_LGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_LGMRESSetAugDim (Optional) Set the number of augmentation vectors (default: 2)
• HYPRE_LGMRESSetKDim (Optional) Set the maximum size of the approximation space (includes the augmentation vectors)
• HYPRE_LGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_LGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_LGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_LGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_LGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_LGMRESSetup Prepare to solve the system
• HYPRE_LGMRESSolve Solve the system
• HYPRE_ParaSailsBuildIJMatrix Build IJ Matrix of the sparse approximate inverse (factor)
• 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_ParCSRBiCGSTABCreate Create a solver object
• HYPRE_ParCSRBiCGSTABDestroy Destroy a solver object
• HYPRE_ParCSRBiCGSTABGetFinalRelativeResidualNorm Retrieve the final relative residual norm
• HYPRE_ParCSRBiCGSTABGetNumIterations Retrieve the number of iterations taken
• HYPRE_ParCSRBiCGSTABGetPrecond Get the preconditioner object
• HYPRE_ParCSRBiCGSTABSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_ParCSRBiCGSTABSetLogging (Optional) Set the amount of logging to be done
• HYPRE_ParCSRBiCGSTABSetMaxIter (Optional) Set the maximal number of iterations allowed (default: 1000)
• HYPRE_ParCSRBiCGSTABSetMinIter (Optional) Set the minimal number of iterations (default: 0)
• HYPRE_ParCSRBiCGSTABSetPrecond (Optional) Set the preconditioner
• HYPRE_ParCSRBiCGSTABSetPrintLevel (Optional) Set the desired print level
• HYPRE_ParCSRBiCGSTABSetStopCrit (Optional) If stopcrit = 1, the absolute residual norm is used for the stopping criterion
• HYPRE_ParCSRBiCGSTABSetTol (Optional) Set the convergence tolerance (default is 1
• HYPRE_ParCSRBiCGSTABSetup Set up BiCGSTAB solver
• HYPRE_ParCSRBiCGSTABSolve Solve the linear system
• HYPRE_ParCSRDiagScale Solve routine for diagonal preconditioning
• HYPRE_ParCSRDiagScaleSetup Setup routine for diagonal preconditioning
• HYPRE_ParCSRFlexGMRESCreate Create a solver object
• HYPRE_ParCSRFlexGMRESDestroy Destroy a solver object
• HYPRE_ParCSRFlexGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_ParCSRFlexGMRESGetNumIterations Return the number of iterations taken
• HYPRE_ParCSRFlexGMRESGetPrecond
• HYPRE_ParCSRFlexGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_ParCSRFlexGMRESSetKDim (Optional) Set the maximum size of the Krylov space
• HYPRE_ParCSRFlexGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_ParCSRFlexGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_ParCSRFlexGMRESSetModifyPC Set a user-defined function to modify solve-time preconditioner attributes
• HYPRE_ParCSRFlexGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_ParCSRFlexGMRESSetPrintLevel (Optional) Set print level
• HYPRE_ParCSRFlexGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_ParCSRFlexGMRESSetup
• HYPRE_ParCSRFlexGMRESSolve Solve the system
• 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_ParCSRGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• 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_ParCSRGMRESSetPrintLevel (Optional) Set print level
• HYPRE_ParCSRGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_ParCSRGMRESSetup
• HYPRE_ParCSRGMRESSolve Solve the system
• HYPRE_ParCSRHybridCreate Create solver object
• HYPRE_ParCSRHybridDestroy Destroy solver object
• HYPRE_ParCSRHybridGetDSCGNumIterations Retrieves the number of iterations used by the diagonally scaled solver
• HYPRE_ParCSRHybridGetFinalRelativeResidualNorm Retrieves the final relative residual norm
• HYPRE_ParCSRHybridGetNumIterations Retrieves the total number of iterations
• HYPRE_ParCSRHybridGetPCGNumIterations Retrieves the number of iterations used by the AMG preconditioned solver
• HYPRE_ParCSRHybridSetAbsoluteTol Set the absolute convergence tolerance for the Krylov solver
• HYPRE_ParCSRHybridSetAggNumLevels (Optional) Defines the number of levels of aggressive coarsening, starting with the finest level
• HYPRE_ParCSRHybridSetCoarsenType (Optional) Defines which parallel coarsening algorithm is used
• HYPRE_ParCSRHybridSetConvergenceTol Set the desired convergence factor
• HYPRE_ParCSRHybridSetCycleNumSweeps (Optional) Sets the number of sweeps at a specified cycle
• HYPRE_ParCSRHybridSetCycleRelaxType (Optional) Defines the smoother at a given cycle
• HYPRE_ParCSRHybridSetCycleType (Optional) Defines the type of cycle
• HYPRE_ParCSRHybridSetDofFunc (Optional) Sets the mapping that assigns the function to each variable, if using the systems version
• HYPRE_ParCSRHybridSetDSCGMaxIter Set the maximal number of iterations for the diagonally preconditioned solver
• HYPRE_ParCSRHybridSetKDim Set the Krylov dimension for restarted GMRES
• HYPRE_ParCSRHybridSetLevelOuterWt (Optional) Defines the outer relaxation weight for hybrid SOR or SSOR on the user defined level
• HYPRE_ParCSRHybridSetLevelRelaxWt (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR on the user defined level
• HYPRE_ParCSRHybridSetLogging Set logging parameter (default: 0, no logging)
• HYPRE_ParCSRHybridSetMaxLevels (Optional) Defines the maximal number of levels used for AMG
• HYPRE_ParCSRHybridSetMaxRowSum (Optional) Sets a parameter to modify the definition of strength for diagonal dominant portions of the matrix
• HYPRE_ParCSRHybridSetMeasureType (Optional) Defines whether local or global measures are used
• HYPRE_ParCSRHybridSetNodal (Optional) Sets whether to use the nodal systems version
• HYPRE_ParCSRHybridSetNumFunctions (Optional) Sets the size of the system of PDEs, if using the systems version
• HYPRE_ParCSRHybridSetNumPaths (Optional) Defines the degree of aggressive coarsening
• HYPRE_ParCSRHybridSetNumSweeps (Optional) Sets the number of sweeps
• HYPRE_ParCSRHybridSetOuterWt (Optional) Defines the outer relaxation weight for hybrid SOR and SSOR on all levels
• HYPRE_ParCSRHybridSetPCGMaxIter Set the maximal number of iterations for the AMG preconditioned solver
• HYPRE_ParCSRHybridSetPMaxElmts (Optional) Defines the maximal number of elements per row for the interpolation
• HYPRE_ParCSRHybridSetPrecond Set preconditioner if wanting to use one that is not set up by the hybrid solver
• HYPRE_ParCSRHybridSetPrintLevel Set print level (default: 0, no printing)
• HYPRE_ParCSRHybridSetRelaxOrder (Optional) Defines in which order the points are relaxed
• HYPRE_ParCSRHybridSetRelaxType (Optional) Defines the smoother to be used
• HYPRE_ParCSRHybridSetRelaxWt (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR on all levels
• HYPRE_ParCSRHybridSetSolverType Set the desired solver type
• HYPRE_ParCSRHybridSetStrongThreshold (Optional) Sets AMG strength threshold
• HYPRE_ParCSRHybridSetTol Set the convergence tolerance for the Krylov solver
• HYPRE_ParCSRHybridSetTruncFactor (Optional) Defines a truncation factor for the interpolation
• HYPRE_ParCSRHybridSetTwoNorm Set the type of norm for PCG
• HYPRE_ParCSRHybridSetup Setup the hybrid solver
• HYPRE_ParCSRHybridSolve Solve linear system
• HYPRE_ParCSRLGMRESCreate Create a solver object
• HYPRE_ParCSRLGMRESDestroy Destroy a solver object
• HYPRE_ParCSRLGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_ParCSRLGMRESGetNumIterations Return the number of iterations taken
• HYPRE_ParCSRLGMRESGetPrecond
• HYPRE_ParCSRLGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_ParCSRLGMRESSetAugDim (Optional) Set the maximum number of augmentation vectors (default: 2)
• HYPRE_ParCSRLGMRESSetKDim (Optional) Set the maximum size of the approximation space
• HYPRE_ParCSRLGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_ParCSRLGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_ParCSRLGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_ParCSRLGMRESSetPrintLevel (Optional) Set print level
• HYPRE_ParCSRLGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_ParCSRLGMRESSetup
• HYPRE_ParCSRLGMRESSolve 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_ParCSRPCGSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• 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_ParCSRPCGSetPrintLevel (Optional) Set the print level
• HYPRE_ParCSRPCGSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_ParCSRPCGSetTol (Optional) Set the relative 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_PCGGetConverged
• HYPRE_PCGGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_PCGGetLogging
• HYPRE_PCGGetMaxIter
• HYPRE_PCGGetNumIterations Return the number of iterations taken
• HYPRE_PCGGetPrecond
• HYPRE_PCGGetPrintLevel
• HYPRE_PCGGetRelChange
• HYPRE_PCGGetResidual Return the residual
• HYPRE_PCGGetTol
• HYPRE_PCGGetTwoNorm
• HYPRE_PCGSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_PCGSetLogging (Optional) Set the amount of logging to do
• HYPRE_PCGSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_PCGSetPrecond (Optional) Set the preconditioner to use
• HYPRE_PCGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_PCGSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_PCGSetTol (Optional) Set the relative convergence tolerance
• HYPRE_PCGSetTwoNorm (Optional) Use the two-norm in stopping criteria
• HYPRE_PCGSetup Prepare to solve the system
• HYPRE_PCGSolve Solve the system
• HYPRE_SStructBiCGSTABCreate Create a solver object
• HYPRE_SStructBiCGSTABDestroy Destroy a solver object
• HYPRE_SStructBiCGSTABGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructBiCGSTABGetNumIterations Return the number of iterations taken
• HYPRE_SStructBiCGSTABGetResidual Return the residual
• HYPRE_SStructBiCGSTABSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_SStructBiCGSTABSetLogging (Optional) Set the amount of logging to do
• HYPRE_SStructBiCGSTABSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructBiCGSTABSetPrecond (Optional) Set the preconditioner to use
• HYPRE_SStructBiCGSTABSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_SStructBiCGSTABSetTol (Optional) Set the convergence tolerance
• HYPRE_SStructBiCGSTABSetup Prepare to solve the system
• HYPRE_SStructBiCGSTABSolve Solve the system
• HYPRE_SStructDiagScale Solve routine for diagonal preconditioning
• HYPRE_SStructDiagScaleSetup Setup routine for diagonal preconditioning
• HYPRE_SStructFACAMR_RAP Re-distribute the composite matrix so that the amr hierachy is approximately nested
• HYPRE_SStructFACCreate Create a solver object
• HYPRE_SStructFACDestroy2 Destroy a solver object
• HYPRE_SStructFACGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructFACGetNumIterations Return the number of iterations taken
• HYPRE_SStructFACSetCoarseSolverType (Optional) Set coarsest solver type
• HYPRE_SStructFACSetJacobiWeight (Optional) Set Jacobi weight if weighted Jacobi is used
• HYPRE_SStructFACSetLogging (Optional) Set the amount of logging to do
• HYPRE_SStructFACSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructFACSetMaxLevels (Optional) Set maximum number of FAC levels
• HYPRE_SStructFACSetNonZeroGuess (Optional) Use a nonzero initial guess
• HYPRE_SStructFACSetNumPostRelax (Optional) Set number of relaxation sweeps after coarse-grid correction
• HYPRE_SStructFACSetNumPreRelax (Optional) Set number of relaxation sweeps before coarse-grid correction
• HYPRE_SStructFACSetPLevels Set up amr structure
• HYPRE_SStructFACSetPRefinements Set up amr refinement factors
• HYPRE_SStructFACSetRelaxType (Optional) Set relaxation type
• HYPRE_SStructFACSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_SStructFACSetTol (Optional) Set the convergence tolerance
• HYPRE_SStructFACSetup2 Set up the FAC solver structure
• HYPRE_SStructFACSetZeroGuess (Optional) Use a zero initial guess
• HYPRE_SStructFACSolve3 Solve the system
• HYPRE_SStructFACZeroAMRMatrixData (Optional, but user must make sure that they do this function otherwise
• HYPRE_SStructFACZeroAMRVectorData (Optional, but user must make sure that they do this function otherwise
• HYPRE_SStructFACZeroCFSten (Optional, but user must make sure that they do this function otherwise
• HYPRE_SStructFACZeroFCSten (Optional, but user must make sure that they do this function otherwise
• HYPRE_SStructFlexGMRESCreate Create a solver object
• HYPRE_SStructFlexGMRESDestroy Destroy a solver object
• HYPRE_SStructFlexGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructFlexGMRESGetNumIterations Return the number of iterations taken
• HYPRE_SStructFlexGMRESGetResidual Return the residual
• HYPRE_SStructFlexGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_SStructFlexGMRESSetKDim (Optional) Set the maximum size of the Krylov space
• HYPRE_SStructFlexGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_SStructFlexGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructFlexGMRESSetModifyPC Set a user-defined function to modify solve-time preconditioner attributes
• HYPRE_SStructFlexGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_SStructFlexGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_SStructFlexGMRESSetTol (Optional) Set the relative convergence tolerance
• HYPRE_SStructFlexGMRESSetup Prepare to solve the system
• HYPRE_SStructFlexGMRESSolve Solve 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_SStructGMRESGetResidual Return the residual
• HYPRE_SStructGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• 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_SStructGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_SStructGMRESSetTol (Optional) Set the relative convergence tolerance
• HYPRE_SStructGMRESSetup Prepare to solve the system
• 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_SStructGraphSetObjectType Set the storage type of the associated matrix 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 (DEFUNCT) Describe how regions just outside of a part relate to other parts
• HYPRE_SStructGridSetNeighborPart Describe how regions just outside of a part relate to other parts
• HYPRE_SStructGridSetNumGhost Setting ghost in the sgrids
• HYPRE_SStructGridSetPeriodic Set the periodicity a particular part
• HYPRE_SStructGridSetVariables Describe the variables that live on a structured part of the grid
• HYPRE_SStructLGMRESCreate Create a solver object
• HYPRE_SStructLGMRESDestroy Destroy a solver object
• HYPRE_SStructLGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructLGMRESGetNumIterations Return the number of iterations taken
• HYPRE_SStructLGMRESGetResidual Return the residual
• HYPRE_SStructLGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_SStructLGMRESSetAugDim (Optional) Set the number of augmentation vectors(default: 2)
• HYPRE_SStructLGMRESSetKDim (Optional) Set the maximum size of the approximation space
• HYPRE_SStructLGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_SStructLGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructLGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_SStructLGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_SStructLGMRESSetTol (Optional) Set the relative convergence tolerance
• HYPRE_SStructLGMRESSetup Prepare to solve the system
• HYPRE_SStructLGMRESSolve Solve the system
• 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_SStructMatrixGetBoxValues Get matrix coefficients a box at a time
• HYPRE_SStructMatrixGetObject Get a reference to the constructed matrix object
• HYPRE_SStructMatrixGetValues Get matrix coefficients index by index
• 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_SStructMatrixSetNSSymmetric Define symmetry properties for all non-stencil matrix entries
• HYPRE_SStructMatrixSetObjectType Set the storage type of the matrix object to be constructed
• HYPRE_SStructMatrixSetSymmetric Define symmetry properties for the stencil entries in the matrix
• HYPRE_SStructMatrixSetValues Set matrix coefficients index by index
• HYPRE_SStructMaxwellCreate Create a solver object
• HYPRE_SStructMaxwellDestroy Destroy a solver object
• HYPRE_SStructMaxwellEliminateRowsCols Eliminates the rows and cols corresponding to the physical boundary in a parcsr matrix
• HYPRE_SStructMaxwellGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructMaxwellGetNumIterations Return the number of iterations taken
• HYPRE_SStructMaxwellGrad (Optional) Creates a gradient matrix from the grid
• HYPRE_SStructMaxwellPhysBdy Finds the physical boundary row ranks on all levels
• HYPRE_SStructMaxwellSetGrad Sets the gradient operator in the Maxwell solver
• HYPRE_SStructMaxwellSetLogging (Optional) Set the amount of logging to do
• HYPRE_SStructMaxwellSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructMaxwellSetNumPostRelax (Optional) Set number of relaxation sweeps after coarse-grid correction
• HYPRE_SStructMaxwellSetNumPreRelax (Optional) Set number of relaxation sweeps before coarse-grid correction
• HYPRE_SStructMaxwellSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_SStructMaxwellSetRfactors Sets the coarsening factor
• HYPRE_SStructMaxwellSetSetConstantCoef (Optional) Set the constant coefficient flag- Nedelec interpolation used
• HYPRE_SStructMaxwellSetTol (Optional) Set the convergence tolerance
• HYPRE_SStructMaxwellSetup Prepare to solve the system
• HYPRE_SStructMaxwellSolve Solve the system
• HYPRE_SStructMaxwellSolve2 Solve the system
• HYPRE_SStructMaxwellZeroVector Zeros the rows corresponding to the physical boundary in a par vector
• 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_SStructPCGGetResidual Return the residual
• HYPRE_SStructPCGSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• 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_SStructPCGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_SStructPCGSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_SStructPCGSetTol (Optional) Set the convergence tolerance
• HYPRE_SStructPCGSetTwoNorm (Optional) Use the two-norm in stopping criteria
• HYPRE_SStructPCGSetup Prepare to solve the system
• HYPRE_SStructPCGSolve Solve the system
• HYPRE_SStructSplitCreate Create a solver object
• HYPRE_SStructSplitDestroy Destroy a solver object
• HYPRE_SStructSplitGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_SStructSplitGetNumIterations Return the number of iterations taken
• HYPRE_SStructSplitSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_SStructSplitSetNonZeroGuess (Optional) Use a nonzero initial guess
• HYPRE_SStructSplitSetStructSolver (Optional) Set up the type of diagonal struct solver
• HYPRE_SStructSplitSetTol (Optional) Set the convergence tolerance
• HYPRE_SStructSplitSetup Prepare to solve the system
• HYPRE_SStructSplitSetZeroGuess (Optional) Use a zero initial guess
• HYPRE_SStructSplitSolve 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_SStructSysPFMGSetJacobiWeight (Optional) Set Jacobi Weight
• 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 relaxation sweeps after coarse-grid correction
• HYPRE_SStructSysPFMGSetNumPreRelax (Optional) Set number of relaxation sweeps before coarse-grid correction
• HYPRE_SStructSysPFMGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• 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 Prepare to solve the system
• HYPRE_SStructSysPFMGSetZeroGuess (Optional) Use a zero initial guess
• HYPRE_SStructSysPFMGSolve Solve the system
• HYPRE_SStructVectorAddToBoxValues Add to vector coefficients a box at a time
• HYPRE_SStructVectorAddToValues Add to 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_StructBiCGSTABCreate Create a solver object
• HYPRE_StructBiCGSTABDestroy Destroy a solver object
• HYPRE_StructBiCGSTABGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_StructBiCGSTABGetNumIterations Return the number of iterations taken
• HYPRE_StructBiCGSTABGetResidual Return the residual
• HYPRE_StructBiCGSTABSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• HYPRE_StructBiCGSTABSetLogging (Optional) Set the amount of logging to do
• HYPRE_StructBiCGSTABSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_StructBiCGSTABSetPrecond (Optional) Set the preconditioner to use
• HYPRE_StructBiCGSTABSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructBiCGSTABSetTol (Optional) Set the convergence tolerance
• HYPRE_StructBiCGSTABSetup Prepare to solve the system
• HYPRE_StructBiCGSTABSolve Solve the system
• HYPRE_StructDiagScale Solve routine for diagonal preconditioning
• HYPRE_StructDiagScaleSetup Setup routine for diagonal preconditioning
• HYPRE_StructFlexGMRESCreate Create a solver object
• HYPRE_StructFlexGMRESDestroy Destroy a solver object
• HYPRE_StructFlexGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_StructFlexGMRESGetNumIterations Return the number of iterations taken
• HYPRE_StructFlexGMRESGetResidual Return the residual
• HYPRE_StructFlexGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_StructFlexGMRESSetKDim (Optional) Set the dimension of the Krylov subspace
• HYPRE_StructFlexGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_StructFlexGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_StructFlexGMRESSetModifyPC Set a user-defined function to modify solve-time preconditioner attributes
• HYPRE_StructFlexGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_StructFlexGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructFlexGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_StructFlexGMRESSetup Prepare to solve the system
• HYPRE_StructFlexGMRESSolve Solve the system
• 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_StructGMRESGetResidual Return the residual
• HYPRE_StructGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_StructGMRESSetKDim (Optional) Set the dimension of the Krylov subspace
• 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_StructGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructGMRESSetTol (Optional) Set the relative convergence tolerance
• HYPRE_StructGMRESSetup Prepare to solve the system
• 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_StructGridSetNumGhost Set the ghost layer in the grid object
• HYPRE_StructGridSetPeriodic Set the periodicity for the grid
• HYPRE_StructHybridCreate Create a solver object
• HYPRE_StructHybridDestroy Destroy a solver object
• HYPRE_StructHybridGetDSCGNumIterations Return the number of diagonal scaling iterations taken
• HYPRE_StructHybridGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_StructHybridGetNumIterations Return the number of iterations taken
• HYPRE_StructHybridGetPCGNumIterations Return the number of general preconditioning iterations taken
• HYPRE_StructHybridSetConvergenceTol (Optional) Set an accepted convergence tolerance for diagonal scaling (DS)
• HYPRE_StructHybridSetDSCGMaxIter (Optional) Set maximum number of iterations for diagonal scaling (DS)
• HYPRE_StructHybridSetKDim (Optional) Set the maximum size of the Krylov space when using GMRES
• HYPRE_StructHybridSetLogging (Optional) Set the amount of logging to do
• HYPRE_StructHybridSetPCGMaxIter (Optional) Set maximum number of iterations for general preconditioner (PRE)
• HYPRE_StructHybridSetPrecond (Optional) Set the preconditioner to use
• HYPRE_StructHybridSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructHybridSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_StructHybridSetSolverType (Optional) Set the type of Krylov solver to use
• HYPRE_StructHybridSetTol (Optional) Set the convergence tolerance
• HYPRE_StructHybridSetTwoNorm (Optional) Use the two-norm in stopping criteria
• HYPRE_StructHybridSetup Prepare to solve the system
• HYPRE_StructHybridSolve Solve the system
• 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 Prepare to solve the system
• HYPRE_StructJacobiSetZeroGuess (Optional) Use a zero initial guess
• HYPRE_StructJacobiSolve Solve the system
• HYPRE_StructLGMRESCreate Create a solver object
• HYPRE_StructLGMRESDestroy Destroy a solver object
• HYPRE_StructLGMRESGetFinalRelativeResidualNorm Return the norm of the final relative residual
• HYPRE_StructLGMRESGetNumIterations Return the number of iterations taken
• HYPRE_StructLGMRESGetResidual Return the residual
• HYPRE_StructLGMRESSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default: 0)
• HYPRE_StructLGMRESSetAugDim (Optional) Set the number of augmentation vectors (default: 2)
• HYPRE_StructLGMRESSetKDim (Optional) Set the dimension of the approximation subspace
• HYPRE_StructLGMRESSetLogging (Optional) Set the amount of logging to do
• HYPRE_StructLGMRESSetMaxIter (Optional) Set maximum number of iterations
• HYPRE_StructLGMRESSetPrecond (Optional) Set the preconditioner to use
• HYPRE_StructLGMRESSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructLGMRESSetTol (Optional) Set the convergence tolerance
• HYPRE_StructLGMRESSetup Prepare to solve the system
• HYPRE_StructLGMRESSolve Solve the system
• HYPRE_StructMatrixAddToBoxValues Add to matrix coefficients a box at a time
• HYPRE_StructMatrixAddToConstantValues Add to matrix coefficients which are constant over the grid
• 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_StructMatrixGetBoxValues Get matrix coefficients a box at a time
• HYPRE_StructMatrixGetValues Get matrix coefficients index by index
• HYPRE_StructMatrixInitialize Prepare a matrix object for setting coefficient values
• HYPRE_StructMatrixMatvec Matvec operator
• HYPRE_StructMatrixPrint Print the matrix to file
• HYPRE_StructMatrixSetBoxValues Set matrix coefficients a box at a time
• HYPRE_StructMatrixSetConstantEntries Specify which stencil entries are constant over the grid
• HYPRE_StructMatrixSetConstantValues Set matrix coefficients which are constant over the grid
• HYPRE_StructMatrixSetNumGhost Set the ghost layer in the matrix
• HYPRE_StructMatrixSetSymmetric 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_StructPCGGetResidual Return the residual
• HYPRE_StructPCGSetAbsoluteTol (Optional) Set the absolute convergence tolerance (default is 0)
• 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_StructPCGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• 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 Prepare to solve the system
• 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_StructPFMGSetMaxLevels (Optional) Set maximum number of multigrid grid levels
• HYPRE_StructPFMGSetNonZeroGuess (Optional) Use a nonzero initial guess
• HYPRE_StructPFMGSetNumPostRelax (Optional) Set number of relaxation sweeps after coarse-grid correction
• HYPRE_StructPFMGSetNumPreRelax (Optional) Set number of relaxation sweeps before coarse-grid correction
• HYPRE_StructPFMGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructPFMGSetRAPType (Optional) Set type of coarse-grid operator to use
• 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 Prepare to solve the system
• 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 relaxation sweeps after coarse-grid correction
• HYPRE_StructSMGSetNumPreRelax (Optional) Set number of relaxation sweeps before coarse-grid correction
• HYPRE_StructSMGSetPrintLevel (Optional) Set the amount of printing to do to the screen
• HYPRE_StructSMGSetRelChange (Optional) Additionally require that the relative difference in successive iterates be small
• HYPRE_StructSMGSetTol (Optional) Set the convergence tolerance
• HYPRE_StructSMGSetup Prepare to solve the system
• 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 Add to vector coefficients a box at a time
• HYPRE_StructVectorAddToValues Add to 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
• initComplete This function signals to the FEI that the initialization step has been completed
• initCRMult This function initializes the Lagrange multiplier constraints
• initElem This function initializes element connectivity (that is, the node identifiers associated with the current element) given an element block identifier and the element identifier with the element block
• initElemBlock The whole finite element mesh can be broken down into a number of element blocks
• initFields Each node or element variable has one or more fields
• initSharedNodes This function initializes the nodes that are shared between the current processor and its neighbors
• LLNL_FEI_Impl Finite element interface constructor: this function creates an instantiation of the HYPRE fei class
• loadComplete This function signals to the FEI that the loading phase has been completed
• loadCRMult This function loads the Lagrange multiplier constraints
• loadNodeBCs This function loads the nodal boundary conditions
• parameters The parameter function is the single most important function to pass solver information (which solver, which preconditioner, tolerance, other solver parameters) to HYPRE
• resetInitialGuess This function resets the solution vector to s
• resetMatrix This function resets the global matrix to be of the same sparsity pattern as before but with every entry set to s
• resetRHSVector This function resets the right hand side vector to s
• resetSystem This function resets the global matrix to be of the same sparsity pattern as before but with every entry set to s
• sumInElem This function adds the element contribution to the global stiffness matrix and also the element load to the right hand side vector
• sumInElemMatrix This function differs from the sumInElem function in that the right hand load vector is not passed
• sumInElemRHS This function adds the element load to the right hand side vector
• ~LLNL_FEI_Impl Finite element interface destructor: this function destroys the object as well as its internal memory allocations

Variables

• Miscellaneous Parameters that are helpful for finite element information

Macros

• HYPRE_IJMatrix The matrix object
• HYPRE_IJVector The vector object
• HYPRE_Matrix The matrix object
• HYPRE_Solver The solver 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
• HYPRE_Vector The vector object

generated by doc++