updated reference manual

added support file
This commit is contained in:
Ulrike Yang 2020-05-22 06:05:51 -07:00
parent 2e9e8747f2
commit b84f132be0
3 changed files with 26 additions and 8 deletions

View File

@ -19,7 +19,7 @@ To install HYPRE, please see either the documentation or the file [INSTALL.md](.
An overview of the HYPRE release history can be found in the file [CHANGELOG](./CHANGELOG).
We appreciate feedback from users. Please submit comments, suggestions, and
issue reports to hypre-support@llnl.gov.
issue reports to hypre-support@llnl.gov. See also [SUPPORT.md](./SUPPORT.md).
License

View File

@ -90,6 +90,12 @@ HYPRE_Int HYPRE_IJMatrixDestroy(HYPRE_IJMatrix matrix);
**/
HYPRE_Int HYPRE_IJMatrixInitialize(HYPRE_IJMatrix matrix);
/**
* Prepare a matrix object for setting coefficient values. This
* routine will also re-initialize an already assembled matrix,
* allowing users to modify coefficient values. This routine
* also specifies the memory location, i.e. host or device.
**/
HYPRE_Int HYPRE_IJMatrixInitialize_v2(HYPRE_IJMatrix matrix, HYPRE_MemoryLocation memory_location);
/**
@ -382,6 +388,12 @@ HYPRE_Int HYPRE_IJVectorDestroy(HYPRE_IJVector vector);
**/
HYPRE_Int HYPRE_IJVectorInitialize(HYPRE_IJVector vector);
/**
* Prepare a vector object for setting coefficient values. This
* routine will also re-initialize an already assembled vector,
* allowing users to modify coefficient values. This routine
* also specifies the memory location, i.e. host or device.
**/
HYPRE_Int HYPRE_IJVectorInitialize_v2( HYPRE_IJVector vector, HYPRE_MemoryLocation memory_location );
/**

View File

@ -415,14 +415,14 @@ HYPRE_Int HYPRE_BoomerAMGSetNodalDiag(HYPRE_Solver solver,
* (Optional) Defines which parallel interpolation operator is used.
* There are the following options for \e interp_type:
*
* - 0 : classical modified interpolation
* - 1 : LS interpolation (for use with GSMG)
* - 0 : classical modified interpolation
* - 1 : LS interpolation (for use with GSMG)
* - 2 : classical modified interpolation for hyperbolic PDEs
* - 3 : direct interpolation (with separation of weights)
* - 3 : direct interpolation (with separation of weights) (also for GPU use)
* - 4 : multipass interpolation
* - 5 : multipass interpolation (with separation of weights)
* - 6 : extended+i interpolation
* - 7 : extended+i (if no common C neighbor) interpolation
* - 6 : extended+i interpolation (also for GPU use)
* - 7 : extended+i (if no common C neighbor) interpolation
* - 8 : standard interpolation
* - 9 : standard interpolation (with separation of weights)
* - 10 : classical block interpolation (for use with nodal systems version only)
@ -430,7 +430,10 @@ HYPRE_Int HYPRE_BoomerAMGSetNodalDiag(HYPRE_Solver solver,
* with diagonalized diagonal blocks
* - 12 : FF interpolation
* - 13 : FF1 interpolation
* - 14 : extended interpolation
* - 14 : extended interpolation (also for GPU use)
* - 15 : interpolation with adaptive weights (GPU use only)
* - 16 : extended interpolation in matrix-matrix form
* - 17 : extended+i interpolation in matrix-matrix form
*
* The default is ext+i interpolation (interp_type 6) trunctated to at most 4
* elements per row. (see HYPRE_BoomerAMGSetPMaxElmts).
@ -1138,7 +1141,8 @@ HYPRE_Int HYPRE_BoomerAMGInitGridRelaxation(HYPRE_Int **num_grid_sweeps_ptr,
/**
* (Optional) If rap2 not equal 0, the triple matrix product RAP is
* replaced by two matrix products.
* replaced by two matrix products.
* (Required for triple matrix product generation on GPUs)
**/
HYPRE_Int HYPRE_BoomerAMGSetRAP2(HYPRE_Solver solver,
HYPRE_Int rap2);
@ -1146,6 +1150,7 @@ HYPRE_Int HYPRE_BoomerAMGSetRAP2(HYPRE_Solver solver,
/**
* (Optional) If mod_rap2 not equal 0, the triple matrix product RAP is
* replaced by two matrix products with modularized kernels
* (Required for triple matrix product generation on GPUs)
**/
HYPRE_Int HYPRE_BoomerAMGSetModuleRAP2(HYPRE_Solver solver,
HYPRE_Int mod_rap2);
@ -1153,6 +1158,7 @@ HYPRE_Int HYPRE_BoomerAMGSetModuleRAP2(HYPRE_Solver solver,
/**
* (Optional) If set to 1, the local interpolation transposes will
* be saved to use more efficient matvecs instead of matvecTs
* (Recommended for efficient use on GPUs)
**/
HYPRE_Int HYPRE_BoomerAMGSetKeepTranspose(HYPRE_Solver solver,
HYPRE_Int keepTranspose);