hypre/src/krylov/lobpcg.h
Rob Falgout 4542bf0941 Fixed header usage problems and added regression test
- Fixed improper inclusion of _hypre_utilities.h in user header files
- Added a 'check-headers.sh' regression test that compiles the examples with
  options that output header usage, then checks for internal header files
- Moved HYPRE_Init() to 'HYPRE_utilities.h'
2020-06-02 10:05:01 -07:00

89 lines
3.2 KiB
C

/******************************************************************************
* Copyright 1998-2019 Lawrence Livermore National Security, LLC and other
* HYPRE Project Developers. See the top-level COPYRIGHT file for details.
*
* SPDX-License-Identifier: (Apache-2.0 OR MIT)
******************************************************************************/
#include "multivector.h"
#include "_hypre_utilities.h"
#ifndef LOCALLY_OPTIMAL_BLOCK_PRECONDITIONED_CONJUGATE_GRADIENTS
#define LOCALLY_OPTIMAL_BLOCK_PRECONDITIONED_CONJUGATE_GRADIENTS
#ifdef __cplusplus
extern "C" {
#endif
#define PROBLEM_SIZE_TOO_SMALL 1
#define WRONG_BLOCK_SIZE 2
#define WRONG_CONSTRAINTS 3
#define REQUESTED_ACCURACY_NOT_ACHIEVED -1
typedef struct {
HYPRE_Real absolute;
HYPRE_Real relative;
} lobpcg_Tolerance;
typedef struct {
/* these pointers should point to 2 functions providing standard lapack functionality */
HYPRE_Int (*dpotrf) (const char *uplo, HYPRE_Int *n, HYPRE_Real *a, HYPRE_Int *
lda, HYPRE_Int *info);
HYPRE_Int (*dsygv) (HYPRE_Int *itype, char *jobz, char *uplo, HYPRE_Int *
n, HYPRE_Real *a, HYPRE_Int *lda, HYPRE_Real *b, HYPRE_Int *ldb,
HYPRE_Real *w, HYPRE_Real *work, HYPRE_Int *lwork, HYPRE_Int *info);
} lobpcg_BLASLAPACKFunctions;
HYPRE_Int
lobpcg_solve( mv_MultiVectorPtr blockVectorX,
void* operatorAData,
void (*operatorA)( void*, void*, void* ),
void* operatorBData,
void (*operatorB)( void*, void*, void* ),
void* operatorTData,
void (*operatorT)( void*, void*, void* ),
mv_MultiVectorPtr blockVectorY,
lobpcg_BLASLAPACKFunctions blap_fn,
lobpcg_Tolerance tolerance,
HYPRE_Int maxIterations,
HYPRE_Int verbosityLevel,
HYPRE_Int* iterationNumber,
/* eigenvalues; "lambda_values" should point to array containing <blocksize> doubles where <blocksi
ze> is the width of multivector "blockVectorX" */
HYPRE_Real * lambda_values,
/* eigenvalues history; a pointer to the entries of the <blocksize>-by-(<maxIterations>+1) matrix s
tored
in fortran-style. (i.e. column-wise) The matrix may be a submatrix of a larger matrix, see next
argument; If you don't need eigenvalues history, provide NULL in this entry */
HYPRE_Real * lambdaHistory_values,
/* global height of the matrix (stored in fotran-style) specified by previous argument */
HYPRE_Int lambdaHistory_gh,
/* residual norms; argument should point to array of <blocksize> doubles */
HYPRE_Real * residualNorms_values,
/* residual norms history; a pointer to the entries of the <blocksize>-by-(<maxIterations>+1) matri
x
stored in fortran-style. (i.e. column-wise) The matrix may be a submatrix of a larger matrix, see
next
argument If you don't need residual norms history, provide NULL in this entry */
HYPRE_Real * residualNormsHistory_values ,
/* global height of the matrix (stored in fotran-style) specified by previous argument */
HYPRE_Int residualNormsHistory_gh
);
#ifdef __cplusplus
}
#endif
#endif /* LOCALLY_OPTIMAL_BLOCK_PRECONDITIONED_CONJUGATE_GRADIENTS */