/usr/include/HYPRE_struct_mv.h is in libhypre-dev 2.4.0b-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 | /*BHEADER**********************************************************************
* Copyright (c) 2008, Lawrence Livermore National Security, LLC.
* Produced at the Lawrence Livermore National Laboratory.
* This file is part of HYPRE. See file COPYRIGHT for details.
*
* HYPRE is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License (as published by the Free
* Software Foundation) version 2.1 dated February 1999.
*
* $Revision: 2.17 $
***********************************************************************EHEADER*/
#ifndef HYPRE_STRUCT_MV_HEADER
#define HYPRE_STRUCT_MV_HEADER
#include "HYPRE_utilities.h"
#ifdef __cplusplus
extern "C" {
#endif
/* forward declarations */
#ifndef HYPRE_StructVector_defined
#define HYPRE_StructVector_defined
struct hypre_StructVector_struct;
typedef struct hypre_StructVector_struct *HYPRE_StructVector;
#endif
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct System Interface
*
* This interface represents a structured-grid conceptual view of a linear
* system.
*
* @memo A structured-grid conceptual interface
**/
/*@{*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Grids
**/
/*@{*/
struct hypre_StructGrid_struct;
/**
* A grid object is constructed out of several ``boxes'', defined on a global
* abstract index space.
**/
typedef struct hypre_StructGrid_struct *HYPRE_StructGrid;
/**
* Create an {\tt ndim}-dimensional grid object.
**/
int HYPRE_StructGridCreate(MPI_Comm comm,
int ndim,
HYPRE_StructGrid *grid);
/**
* Destroy a grid object. An object should be explicitly destroyed using this
* destructor when the user's code no longer needs direct access to it. Once
* destroyed, the object must not be referenced again. Note that the object may
* not be deallocated at the completion of this call, since there may be
* internal package references to the object. The object will then be destroyed
* when all internal reference counts go to zero.
**/
int HYPRE_StructGridDestroy(HYPRE_StructGrid grid);
/**
* Set the extents for a box on the grid.
**/
int HYPRE_StructGridSetExtents(HYPRE_StructGrid grid,
int *ilower,
int *iupper);
/**
* Finalize the construction of the grid before using.
**/
int HYPRE_StructGridAssemble(HYPRE_StructGrid grid);
/**
* Set the periodicity for the grid.
*
* The argument {\tt periodic} is an {\tt ndim}-dimensional integer array that
* contains the periodicity for each dimension. A zero value for a dimension
* means non-periodic, while a nonzero value means periodic and contains the
* actual period. For example, periodicity in the first and third dimensions
* for a 10x11x12 grid is indicated by the array [10,0,12].
*
* NOTE: Some of the solvers in hypre have power-of-two restrictions on the size
* of the periodic dimensions.
**/
int HYPRE_StructGridSetPeriodic(HYPRE_StructGrid grid,
int *periodic);
/**
* Set the ghost layer in the grid object
**/
int HYPRE_StructGridSetNumGhost(HYPRE_StructGrid grid,
int *num_ghost);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Stencils
**/
/*@{*/
struct hypre_StructStencil_struct;
/**
* The stencil object.
**/
typedef struct hypre_StructStencil_struct *HYPRE_StructStencil;
/**
* Create a stencil object for the specified number of spatial dimensions and
* stencil entries.
**/
int HYPRE_StructStencilCreate(int ndim,
int size,
HYPRE_StructStencil *stencil);
/**
* Destroy a stencil object.
**/
int HYPRE_StructStencilDestroy(HYPRE_StructStencil stencil);
/**
* Set a stencil entry.
*
* NOTE: The name of this routine will eventually be changed to {\tt
* HYPRE\_StructStencilSetEntry}.
**/
int HYPRE_StructStencilSetElement(HYPRE_StructStencil stencil,
int entry,
int *offset);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Matrices
**/
/*@{*/
struct hypre_StructMatrix_struct;
/**
* The matrix object.
**/
typedef struct hypre_StructMatrix_struct *HYPRE_StructMatrix;
/**
* Create a matrix object.
**/
int HYPRE_StructMatrixCreate(MPI_Comm comm,
HYPRE_StructGrid grid,
HYPRE_StructStencil stencil,
HYPRE_StructMatrix *matrix);
/**
* Destroy a matrix object.
**/
int HYPRE_StructMatrixDestroy(HYPRE_StructMatrix matrix);
/**
* Prepare a matrix object for setting coefficient values.
**/
int HYPRE_StructMatrixInitialize(HYPRE_StructMatrix matrix);
/**
* Set matrix coefficients index by index. The {\tt values} array is of length
* {\tt nentries}.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructMatrixSetBoxValues} to set
* coefficients a box at a time.
**/
int HYPRE_StructMatrixSetValues(HYPRE_StructMatrix matrix,
int *index,
int nentries,
int *entries,
double *values);
/**
* Add to matrix coefficients index by index. The {\tt values} array is of
* length {\tt nentries}.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructMatrixAddToBoxValues} to
* set coefficients a box at a time.
**/
int HYPRE_StructMatrixAddToValues(HYPRE_StructMatrix matrix,
int *index,
int nentries,
int *entries,
double *values);
/**
* Set matrix coefficients which are constant over the grid. The {\tt values}
* array is of length {\tt nentries}.
**/
int HYPRE_StructMatrixSetConstantValues(HYPRE_StructMatrix matrix,
int nentries,
int *entries,
double *values);
/**
* Add to matrix coefficients which are constant over the grid. The {\tt
* values} array is of length {\tt nentries}.
**/
int HYPRE_StructMatrixAddToConstantValues(HYPRE_StructMatrix matrix,
int nentries,
int *entries,
double *values);
/**
* Set matrix coefficients a box at a time. The data in {\tt values} is ordered
* as follows:
*
\begin{verbatim}
m = 0;
for (k = ilower[2]; k <= iupper[2]; k++)
for (j = ilower[1]; j <= iupper[1]; j++)
for (i = ilower[0]; i <= iupper[0]; i++)
for (entry = 0; entry < nentries; entry++)
{
values[m] = ...;
m++;
}
\end{verbatim}
**/
int HYPRE_StructMatrixSetBoxValues(HYPRE_StructMatrix matrix,
int *ilower,
int *iupper,
int nentries,
int *entries,
double *values);
/**
* Add to matrix coefficients a box at a time. The data in {\tt values} is
* ordered as in \Ref{HYPRE_StructMatrixSetBoxValues}.
**/
int HYPRE_StructMatrixAddToBoxValues(HYPRE_StructMatrix matrix,
int *ilower,
int *iupper,
int nentries,
int *entries,
double *values);
/**
* Finalize the construction of the matrix before using.
**/
int HYPRE_StructMatrixAssemble(HYPRE_StructMatrix matrix);
/**
* Get matrix coefficients index by index. The {\tt values} array is of length
* {\tt nentries}.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructMatrixGetBoxValues} to get
* coefficients a box at a time.
**/
int HYPRE_StructMatrixGetValues(HYPRE_StructMatrix matrix,
int *index,
int nentries,
int *entries,
double *values);
/**
* Get matrix coefficients a box at a time. The data in {\tt values} is
* ordered as in \Ref{HYPRE_StructMatrixSetBoxValues}.
**/
int HYPRE_StructMatrixGetBoxValues(HYPRE_StructMatrix matrix,
int *ilower,
int *iupper,
int nentries,
int *entries,
double *values);
/**
* Define symmetry properties of the matrix. By default, matrices are assumed
* to be nonsymmetric. Significant storage savings can be made if the matrix is
* symmetric.
**/
int HYPRE_StructMatrixSetSymmetric(HYPRE_StructMatrix matrix,
int symmetric);
/**
* Specify which stencil entries are constant over the grid. Declaring entries
* to be ``constant over the grid'' yields significant memory savings because
* the value for each declared entry will only be stored once. However, not all
* solvers are able to utilize this feature.
*
* Presently supported:
* \begin{itemize}
* \item no entries constant (this function need not be called)
* \item all entries constant
* \item all but the diagonal entry constant
* \end{itemize}
**/
int HYPRE_StructMatrixSetConstantEntries( HYPRE_StructMatrix matrix,
int nentries,
int *entries );
/**
* Set the ghost layer in the matrix
**/
int HYPRE_StructMatrixSetNumGhost(HYPRE_StructMatrix matrix,
int *num_ghost);
/**
* Print the matrix to file. This is mainly for debugging purposes.
**/
int HYPRE_StructMatrixPrint(const char *filename,
HYPRE_StructMatrix matrix,
int all);
/**
* Matvec operator. This operation is $y = \alpha A x + \beta y$ .
* Note that you can do a simple matrix-vector multiply by setting
* $\alpha=1$ and $\beta=0$.
**/
int HYPRE_StructMatrixMatvec ( double alpha,
HYPRE_StructMatrix A,
HYPRE_StructVector x,
double beta,
HYPRE_StructVector y );
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name Struct Vectors
**/
/*@{*/
struct hypre_StructVector_struct;
/**
* The vector object.
**/
#ifndef HYPRE_StructVector_defined
typedef struct hypre_StructVector_struct *HYPRE_StructVector;
#endif
/**
* Create a vector object.
**/
int HYPRE_StructVectorCreate(MPI_Comm comm,
HYPRE_StructGrid grid,
HYPRE_StructVector *vector);
/**
* Destroy a vector object.
**/
int HYPRE_StructVectorDestroy(HYPRE_StructVector vector);
/**
* Prepare a vector object for setting coefficient values.
**/
int HYPRE_StructVectorInitialize(HYPRE_StructVector vector);
/**
* Set vector coefficients index by index.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructVectorSetBoxValues} to set
* coefficients a box at a time.
**/
int HYPRE_StructVectorSetValues(HYPRE_StructVector vector,
int *index,
double value);
/**
* Add to vector coefficients index by index.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructVectorAddToBoxValues} to
* set coefficients a box at a time.
**/
int HYPRE_StructVectorAddToValues(HYPRE_StructVector vector,
int *index,
double value);
/**
* Set vector coefficients a box at a time. The data in {\tt values} is ordered
* as follows:
*
\begin{verbatim}
m = 0;
for (k = ilower[2]; k <= iupper[2]; k++)
for (j = ilower[1]; j <= iupper[1]; j++)
for (i = ilower[0]; i <= iupper[0]; i++)
{
values[m] = ...;
m++;
}
\end{verbatim}
**/
int HYPRE_StructVectorSetBoxValues(HYPRE_StructVector vector,
int *ilower,
int *iupper,
double *values);
/**
* Add to vector coefficients a box at a time. The data in {\tt values} is
* ordered as in \Ref{HYPRE_StructVectorSetBoxValues}.
**/
int HYPRE_StructVectorAddToBoxValues(HYPRE_StructVector vector,
int *ilower,
int *iupper,
double *values);
/**
* Finalize the construction of the vector before using.
**/
int HYPRE_StructVectorAssemble(HYPRE_StructVector vector);
/**
* Get vector coefficients index by index.
*
* NOTE: For better efficiency, use \Ref{HYPRE_StructVectorGetBoxValues} to get
* coefficients a box at a time.
**/
int HYPRE_StructVectorGetValues(HYPRE_StructVector vector,
int *index,
double *value);
/**
* Get vector coefficients a box at a time. The data in {\tt values} is ordered
* as in \Ref{HYPRE_StructVectorSetBoxValues}.
**/
int HYPRE_StructVectorGetBoxValues(HYPRE_StructVector vector,
int *ilower,
int *iupper,
double *values);
/**
* Print the vector to file. This is mainly for debugging purposes.
**/
int HYPRE_StructVectorPrint(const char *filename,
HYPRE_StructVector vector,
int all);
/*@}*/
/*@}*/
/*--------------------------------------------------------------------------
* Miscellaneous: These probably do not belong in the interface.
*--------------------------------------------------------------------------*/
int HYPRE_StructMatrixGetGrid(HYPRE_StructMatrix matrix,
HYPRE_StructGrid *grid);
struct hypre_CommPkg_struct;
typedef struct hypre_CommPkg_struct *HYPRE_CommPkg;
int HYPRE_StructVectorSetNumGhost(HYPRE_StructVector vector,
int *num_ghost);
int HYPRE_StructVectorSetConstantValues(HYPRE_StructVector vector,
double values);
int HYPRE_StructVectorGetMigrateCommPkg(HYPRE_StructVector from_vector,
HYPRE_StructVector to_vector,
HYPRE_CommPkg *comm_pkg);
int HYPRE_StructVectorMigrate(HYPRE_CommPkg comm_pkg,
HYPRE_StructVector from_vector,
HYPRE_StructVector to_vector);
int HYPRE_CommPkgDestroy(HYPRE_CommPkg comm_pkg);
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif
#endif
|