petsc/include/petscvec.h

*2eac72dbSBarry Smith/*
*2eac72dbSBarry Smith   This defines the abstract vector component. These are patterned
*2eac72dbSBarry Smith   after the Level-1 Blas, but with some additions that have proved
*2eac72dbSBarry Smith   useful. These include routines to allocate and free vectors.
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith   Note that the routines that are normally thought of as returning a
*2eac72dbSBarry Smith   value (e.g., dot, norm) return their value through an argument.
*2eac72dbSBarry Smith   This allows these routines to be used with other datatype, such
*2eac72dbSBarry Smith   as float and dcomplex.
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith   All vectors should be declared as a Vec. All vector routines begin
*2eac72dbSBarry Smith   with Vec.
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith */
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith#ifndef __VEC_PACKAGE
*2eac72dbSBarry Smith#define __VEC_PACKAGE
*2eac72dbSBarry Smith#include "is.h"
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithtypedef struct _Vec*           Vec;
*2eac72dbSBarry Smithtypedef struct _VecScatterCtx* VecScatterCtx;
*2eac72dbSBarry Smithtypedef double*                VecScalar;
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecCreateSequential          ANSI_ARGS((int,Vec *));
*2eac72dbSBarry Smithextern int VecCreateSequentialBLAS      ANSI_ARGS((int,Vec *));
*2eac72dbSBarry Smithextern int VecCreateComplexSequential   ANSI_ARGS((int,Vec *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecCreateInitialVector   ANSI_ARGS((int,int,char **,Vec *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith#if defined(MPI_PACKAGE)
*2eac72dbSBarry Smithextern int VecCreateMPI            ANSI_ARGS((void *,int,int,Vec *));
*2eac72dbSBarry Smithextern int VecCreateMPIBLAS        ANSI_ARGS((void *,int,int,Vec *));
*2eac72dbSBarry Smithextern int VecCreateComplexMPI     ANSI_ARGS((void *,int,int,Vec *));
*2eac72dbSBarry Smith#endif
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecDot           ANSI_ARGS((Vec, Vec, VecScalar));
*2eac72dbSBarry Smithextern int VecTDot          ANSI_ARGS((Vec, Vec, VecScalar));
*2eac72dbSBarry Smithextern int VecMDot          ANSI_ARGS((int,      Vec ,Vec*,VecScalar));
*2eac72dbSBarry Smithextern int VecMTDot         ANSI_ARGS((int,      Vec ,Vec*,VecScalar));
*2eac72dbSBarry Smithextern int VecNorm          ANSI_ARGS((Vec, VecScalar));
*2eac72dbSBarry Smithextern int VecASum          ANSI_ARGS((Vec, VecScalar));
*2eac72dbSBarry Smithextern int VecMax           ANSI_ARGS((Vec, int *,    VecScalar));
*2eac72dbSBarry Smithextern int VecScale         ANSI_ARGS((VecScalar, Vec));
*2eac72dbSBarry Smithextern int VecCopy          ANSI_ARGS((Vec, Vec));
*2eac72dbSBarry Smithextern int VecSet           ANSI_ARGS((VecScalar, Vec));
*2eac72dbSBarry Smithextern int VecSwap          ANSI_ARGS((Vec, Vec));
*2eac72dbSBarry Smithextern int VecAXPY          ANSI_ARGS((VecScalar, Vec, Vec));
*2eac72dbSBarry Smithextern int VecMAXPY         ANSI_ARGS((int,      VecScalar, Vec ,Vec*));
*2eac72dbSBarry Smithextern int VecAYPX          ANSI_ARGS((VecScalar, Vec, Vec));
*2eac72dbSBarry Smithextern int VecWAXPY         ANSI_ARGS((VecScalar, Vec, Vec, Vec));
*2eac72dbSBarry Smithextern int VecPMult         ANSI_ARGS((Vec, Vec, Vec));
*2eac72dbSBarry Smithextern int VecPDiv          ANSI_ARGS((Vec, Vec, Vec));
*2eac72dbSBarry Smithextern int VecCreate        ANSI_ARGS((Vec,Vec *));
*2eac72dbSBarry Smithextern int VecDestroy       ANSI_ARGS((Vec));
*2eac72dbSBarry Smithextern int VecGetVecs       ANSI_ARGS((Vec, int,Vec **));
*2eac72dbSBarry Smithextern int VecFreeVecs      ANSI_ARGS((Vec*,int));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecAddValues     ANSI_ARGS((Vec, int, int *,VecScalar));
*2eac72dbSBarry Smithextern int VecInsertValues  ANSI_ARGS((Vec, int, int *,VecScalar));
*2eac72dbSBarry Smithextern int VecBeginAssembly ANSI_ARGS((Vec));
*2eac72dbSBarry Smithextern int VecEndAssembly   ANSI_ARGS((Vec));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecScatterBegin  ANSI_ARGS((Vec,IS,Vec,IS,VecScatterCtx *));
*2eac72dbSBarry Smithextern int VecScatterEnd    ANSI_ARGS((Vec,IS,Vec,IS,VecScatterCtx *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecScatterAddBegin ANSI_ARGS((Vec,IS,Vec,IS,VecScatterCtx *));
*2eac72dbSBarry Smithextern int VecScatterAddEnd   ANSI_ARGS((Vec,IS,Vec,IS,VecScatterCtx *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecGetArray      ANSI_ARGS((Vec,VecScalar **));
*2eac72dbSBarry Smithextern int VecValidVector   ANSI_ARGS((Vec));
*2eac72dbSBarry Smithextern int VecView          ANSI_ARGS((Vec,void *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smithextern int VecGetSize       ANSI_ARGS((Vec,int *));
*2eac72dbSBarry Smithextern int VecGetLocalSize  ANSI_ARGS((Vec,int *));
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith#endif
*2eac72dbSBarry Smith
*2eac72dbSBarry Smith