Table of contents

General

• hypre Reference Manual
  • Matrices and Vectors
    • IJParCSR Matrix
    • IJParCSR Vector
  • Matrix and Vector Building Interfaces (Conceptual Interfaces)
    • IJ Matrix Builder
    • IJ Vector Builder
  • Operator Interface
  • ParCSR Solvers Linear solvers for sparse matrix systems
    • ParCSR BoomerAMG Solver
    • ParCSRDiagScale Solver
  • Preconditioned Solvers
    • GMRES Preconditioned Solver
    • PCG Preconditioned Solver
  • PreconditionedSolver Interface
  • Solver Interface
  • Vector Interface

Functions, Macros

• bHYPRE_BoomerAMG__cast Cast method for interface and class type conversions
• bHYPRE_BoomerAMG__cast2 String cast method for interface and class type conversions
• bHYPRE_BoomerAMG__create Constructor function for the class
• bHYPRE_BoomerAMG_Apply Apply the operator to b, returning x
• bHYPRE_BoomerAMG_GetDoubleValue Get the double parameter associated with name
• bHYPRE_BoomerAMG_GetIntValue Set the int parameter associated with name
• bHYPRE_BoomerAMG_GetNumIterations (Optional) Return the number of iterations taken
• bHYPRE_BoomerAMG_GetRelResidualNorm (Optional) Return the norm of the relative residual
• bHYPRE_BoomerAMG_SetCommunicator Set the MPI Communicator
• bHYPRE_BoomerAMG_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_BoomerAMG_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_BoomerAMG_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_BoomerAMG_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_BoomerAMG_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_BoomerAMG_SetIntParameter Set the int parameter associated with name
• bHYPRE_BoomerAMG_SetLogging (Optional) Set the logging level, specifying the degree of additional informational data to be accumulated
• bHYPRE_BoomerAMG_SetMaxIterations (Optional) Set maximum number of iterations
• bHYPRE_BoomerAMG_SetOperator Set the operator for the linear system being solved
• bHYPRE_BoomerAMG_SetPrintLevel (Optional) Set the print level, specifying the degree of informational data to be printed either to the screen or to a file
• bHYPRE_BoomerAMG_SetStringParameter Set the string parameter associated with name
• bHYPRE_BoomerAMG_SetTolerance (Optional) Set the convergence tolerance
• bHYPRE_BoomerAMG_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_GMRES__cast Cast method for interface and class type conversions
• bHYPRE_GMRES__cast2 String cast method for interface and class type conversions
• bHYPRE_GMRES__create Constructor function for the class
• bHYPRE_GMRES_Apply Apply the operator to b, returning x
• bHYPRE_GMRES_GetDoubleValue Get the double parameter associated with name
• bHYPRE_GMRES_GetIntValue Set the int parameter associated with name
• bHYPRE_GMRES_GetNumIterations (Optional) Return the number of iterations taken
• bHYPRE_GMRES_GetRelResidualNorm (Optional) Return the norm of the relative residual
• bHYPRE_GMRES_SetCommunicator Set the MPI Communicator
• bHYPRE_GMRES_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_GMRES_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_GMRES_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_GMRES_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_GMRES_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_GMRES_SetIntParameter Set the int parameter associated with name
• bHYPRE_GMRES_SetLogging (Optional) Set the logging level, specifying the degree of additional informational data to be accumulated
• bHYPRE_GMRES_SetMaxIterations (Optional) Set maximum number of iterations
• bHYPRE_GMRES_SetOperator Set the operator for the linear system being solved
• bHYPRE_GMRES_SetPreconditioner Set the preconditioner
• bHYPRE_GMRES_SetPrintLevel (Optional) Set the print level, specifying the degree of informational data to be printed either to the screen or to a file
• bHYPRE_GMRES_SetStringParameter Set the string parameter associated with name
• bHYPRE_GMRES_SetTolerance (Optional) Set the convergence tolerance
• bHYPRE_GMRES_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_IJBuildMatrix__cast Cast method for interface and class type conversions
• bHYPRE_IJBuildMatrix__cast2 String cast method for interface and class type conversions
• bHYPRE_IJBuildMatrix_AddToValues Adds to values for nrows of the matrix
• bHYPRE_IJBuildMatrix_GetLocalRange Gets range of rows owned by this processor and range of column partitioning for this processor
• bHYPRE_IJBuildMatrix_GetRowCounts Gets number of nonzeros elements for nrows rows specified in rows and returns them in ncols, which needs to be allocated by the user
• bHYPRE_IJBuildMatrix_GetValues Gets values for nrows rows or partial rows of the matrix
• bHYPRE_IJBuildMatrix_Print Print the matrix to file
• bHYPRE_IJBuildMatrix_Read Read the matrix from file
• bHYPRE_IJBuildMatrix_SetLocalRange Set the local range for a matrix object
• bHYPRE_IJBuildMatrix_SetRowSizes (Optional) Set the max number of nonzeros to expect in each row
• bHYPRE_IJBuildMatrix_SetValues Sets values for nrows of the matrix
• bHYPRE_IJBuildVector__cast Cast method for interface and class type conversions
• bHYPRE_IJBuildVector__cast2 String cast method for interface and class type conversions
• bHYPRE_IJBuildVector_AddToValues Adds to values in vector
• bHYPRE_IJBuildVector_GetLocalRange Returns range of the part of the vector owned by this processor
• bHYPRE_IJBuildVector_GetValues Gets values in vector
• bHYPRE_IJBuildVector_Print Print the vector to file
• bHYPRE_IJBuildVector_Read Read the vector from file
• bHYPRE_IJBuildVector_SetLocalRange Set the local range for a vector object
• bHYPRE_IJBuildVector_SetValues Sets values in vector
• bHYPRE_IJParCSRMatrix__cast Cast method for interface and class type conversions
• bHYPRE_IJParCSRMatrix__cast2 String cast method for interface and class type conversions
• bHYPRE_IJParCSRMatrix__create Constructor function for the class
• bHYPRE_IJParCSRMatrix_AddToValues Adds to values for nrows of the matrix
• bHYPRE_IJParCSRMatrix_Apply Apply the operator to b, returning x
• bHYPRE_IJParCSRMatrix_Assemble Finalize the construction of an object before using, either for the first time or on subsequent uses
• bHYPRE_IJParCSRMatrix_GetDoubleValue Get the double parameter associated with name
• bHYPRE_IJParCSRMatrix_GetIntValue Set the int parameter associated with name
• bHYPRE_IJParCSRMatrix_GetLocalRange Gets range of rows owned by this processor and range of column partitioning for this processor
• bHYPRE_IJParCSRMatrix_GetObject The problem definition interface is a builder that creates an object that contains the problem definition information, e
• bHYPRE_IJParCSRMatrix_GetRow The GetRow method will allocate space for its two output arrays on the first call
• bHYPRE_IJParCSRMatrix_GetRowCounts Gets number of nonzeros elements for nrows rows specified in rows and returns them in ncols, which needs to be allocated by the user
• bHYPRE_IJParCSRMatrix_GetValues Gets values for nrows rows or partial rows of the matrix
• bHYPRE_IJParCSRMatrix_Initialize Prepare an object for setting coefficient values, whether for the first time or subsequently
• bHYPRE_IJParCSRMatrix_Print Print the matrix to file
• bHYPRE_IJParCSRMatrix_Read Read the matrix from file
• bHYPRE_IJParCSRMatrix_SetCommunicator Set the MPI Communicator
• bHYPRE_IJParCSRMatrix_SetDiagOffdSizes (Optional) Set the max number of nonzeros to expect in each row of the diagonal and off-diagonal blocks
• bHYPRE_IJParCSRMatrix_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_IJParCSRMatrix_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_IJParCSRMatrix_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_IJParCSRMatrix_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_IJParCSRMatrix_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_IJParCSRMatrix_SetIntParameter Set the int parameter associated with name
• bHYPRE_IJParCSRMatrix_SetLocalRange Set the local range for a matrix object
• bHYPRE_IJParCSRMatrix_SetRowSizes (Optional) Set the max number of nonzeros to expect in each row
• bHYPRE_IJParCSRMatrix_SetStringParameter Set the string parameter associated with name
• bHYPRE_IJParCSRMatrix_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_IJParCSRMatrix_SetValues Sets values for nrows of the matrix
• bHYPRE_IJParCSRVector__cast Cast method for interface and class type conversions
• bHYPRE_IJParCSRVector__cast2 String cast method for interface and class type conversions
• bHYPRE_IJParCSRVector__create Constructor function for the class
• bHYPRE_IJParCSRVector_AddToValues Adds to values in vector
• bHYPRE_IJParCSRVector_Assemble Finalize the construction of an object before using, either for the first time or on subsequent uses
• bHYPRE_IJParCSRVector_Axpy Add a*x to self
• bHYPRE_IJParCSRVector_Clear Set self to 0
• bHYPRE_IJParCSRVector_Clone Create an x compatible with self
• bHYPRE_IJParCSRVector_Copy Copy x into self
• bHYPRE_IJParCSRVector_Dot Compute d, the inner-product of self and x
• bHYPRE_IJParCSRVector_GetLocalRange Returns range of the part of the vector owned by this processor
• bHYPRE_IJParCSRVector_GetObject The problem definition interface is a builder that creates an object that contains the problem definition information, e
• bHYPRE_IJParCSRVector_GetValues Gets values in vector
• bHYPRE_IJParCSRVector_Initialize Prepare an object for setting coefficient values, whether for the first time or subsequently
• bHYPRE_IJParCSRVector_Print Print the vector to file
• bHYPRE_IJParCSRVector_Read Read the vector from file
• bHYPRE_IJParCSRVector_Scale Scale self by a
• bHYPRE_IJParCSRVector_SetCommunicator Set the MPI Communicator
• bHYPRE_IJParCSRVector_SetLocalRange Set the local range for a vector object
• bHYPRE_IJParCSRVector_SetValues Sets values in vector
• bHYPRE_Operator__cast Cast method for interface and class type conversions
• bHYPRE_Operator__cast2 String cast method for interface and class type conversions
• bHYPRE_Operator_Apply Apply the operator to b, returning x
• bHYPRE_Operator_GetDoubleValue Get the double parameter associated with name
• bHYPRE_Operator_GetIntValue Set the int parameter associated with name
• bHYPRE_Operator_SetCommunicator Set the MPI Communicator
• bHYPRE_Operator_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_Operator_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_Operator_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_Operator_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_Operator_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_Operator_SetIntParameter Set the int parameter associated with name
• bHYPRE_Operator_SetStringParameter Set the string parameter associated with name
• bHYPRE_Operator_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_ParCSRDiagScale__cast Cast method for interface and class type conversions
• bHYPRE_ParCSRDiagScale__cast2 String cast method for interface and class type conversions
• bHYPRE_ParCSRDiagScale__create Constructor function for the class
• bHYPRE_ParCSRDiagScale_Apply Apply the operator to b, returning x
• bHYPRE_ParCSRDiagScale_GetDoubleValue Get the double parameter associated with name
• bHYPRE_ParCSRDiagScale_GetIntValue Set the int parameter associated with name
• bHYPRE_ParCSRDiagScale_GetNumIterations (Optional) Return the number of iterations taken
• bHYPRE_ParCSRDiagScale_GetRelResidualNorm (Optional) Return the norm of the relative residual
• bHYPRE_ParCSRDiagScale_SetCommunicator Set the MPI Communicator
• bHYPRE_ParCSRDiagScale_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_ParCSRDiagScale_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_ParCSRDiagScale_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_ParCSRDiagScale_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_ParCSRDiagScale_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_ParCSRDiagScale_SetIntParameter Set the int parameter associated with name
• bHYPRE_ParCSRDiagScale_SetLogging (Optional) Set the logging level, specifying the degree of additional informational data to be accumulated
• bHYPRE_ParCSRDiagScale_SetMaxIterations (Optional) Set maximum number of iterations
• bHYPRE_ParCSRDiagScale_SetOperator Set the operator for the linear system being solved
• bHYPRE_ParCSRDiagScale_SetPrintLevel (Optional) Set the print level, specifying the degree of informational data to be printed either to the screen or to a file
• bHYPRE_ParCSRDiagScale_SetStringParameter Set the string parameter associated with name
• bHYPRE_ParCSRDiagScale_SetTolerance (Optional) Set the convergence tolerance
• bHYPRE_ParCSRDiagScale_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_PCG__cast Cast method for interface and class type conversions
• bHYPRE_PCG__cast2 String cast method for interface and class type conversions
• bHYPRE_PCG__create Constructor function for the class
• bHYPRE_PCG_Apply Apply the operator to b, returning x
• bHYPRE_PCG_GetDoubleValue Get the double parameter associated with name
• bHYPRE_PCG_GetIntValue Set the int parameter associated with name
• bHYPRE_PCG_GetNumIterations (Optional) Return the number of iterations taken
• bHYPRE_PCG_GetRelResidualNorm (Optional) Return the norm of the relative residual
• bHYPRE_PCG_SetCommunicator Set the MPI Communicator
• bHYPRE_PCG_SetDoubleArray1Parameter Set the double 1-D array parameter associated with name
• bHYPRE_PCG_SetDoubleArray2Parameter Set the double 2-D array parameter associated with name
• bHYPRE_PCG_SetDoubleParameter Set the double parameter associated with name
• bHYPRE_PCG_SetIntArray1Parameter Set the int 1-D array parameter associated with name
• bHYPRE_PCG_SetIntArray2Parameter Set the int 2-D array parameter associated with name
• bHYPRE_PCG_SetIntParameter Set the int parameter associated with name
• bHYPRE_PCG_SetLogging (Optional) Set the logging level, specifying the degree of additional informational data to be accumulated
• bHYPRE_PCG_SetMaxIterations (Optional) Set maximum number of iterations
• bHYPRE_PCG_SetOperator Set the operator for the linear system being solved
• bHYPRE_PCG_SetPreconditioner Set the preconditioner
• bHYPRE_PCG_SetPrintLevel (Optional) Set the print level, specifying the degree of informational data to be printed either to the screen or to a file
• bHYPRE_PCG_SetStringParameter Set the string parameter associated with name
• bHYPRE_PCG_SetTolerance (Optional) Set the convergence tolerance
• bHYPRE_PCG_Setup (Optional) Do any preprocessing that may be necessary in order to execute Apply
• bHYPRE_PreconditionedSolver__cast Cast method for interface and class type conversions
• bHYPRE_PreconditionedSolver__cast2 String cast method for interface and class type conversions
• bHYPRE_PreconditionedSolver_SetPreconditioner Set the preconditioner
• bHYPRE_Solver__cast Cast method for interface and class type conversions
• bHYPRE_Solver__cast2 String cast method for interface and class type conversions
• bHYPRE_Solver_GetNumIterations (Optional) Return the number of iterations taken
• bHYPRE_Solver_GetRelResidualNorm (Optional) Return the norm of the relative residual
• bHYPRE_Solver_SetLogging (Optional) Set the logging level, specifying the degree of additional informational data to be accumulated
• bHYPRE_Solver_SetMaxIterations (Optional) Set maximum number of iterations
• bHYPRE_Solver_SetOperator Set the operator for the linear system being solved
• bHYPRE_Solver_SetPrintLevel (Optional) Set the print level, specifying the degree of informational data to be printed either to the screen or to a file
• bHYPRE_Solver_SetTolerance (Optional) Set the convergence tolerance
• bHYPRE_Vector__cast Cast method for interface and class type conversions
• bHYPRE_Vector__cast2 String cast method for interface and class type conversions
• bHYPRE_Vector_Axpy Add a*x to self
• bHYPRE_Vector_Clear Set self to 0
• bHYPRE_Vector_Clone Create an x compatible with self
• bHYPRE_Vector_Copy Copy x into self
• bHYPRE_Vector_Dot Compute d, the inner-product of self and x
• bHYPRE_Vector_Scale Scale self by a

Variables

• bHYPRE_BoomerAMG__object Symbol "bHYPRE
• bHYPRE_GMRES__object Symbol "bHYPRE
• bHYPRE_IJBuildMatrix__object Symbol "bHYPRE
• bHYPRE_IJBuildVector__object Symbol "bHYPRE
• bHYPRE_IJParCSRMatrix__object Symbol "bHYPRE
• bHYPRE_IJParCSRVector__object Symbol "bHYPRE
• bHYPRE_Operator__object Symbol "bHYPRE
• bHYPRE_ParCSRDiagScale__object Symbol "bHYPRE
• bHYPRE_PCG__object Symbol "bHYPRE
• bHYPRE_PreconditionedSolver__object Symbol "bHYPRE
• bHYPRE_Solver__object Symbol "bHYPRE
• bHYPRE_Vector__object Symbol "bHYPRE

generated by doc++