xref: /petsc/include/petscvec.h (revision bdea15b1a5416787422d126f840e909d779cb021)

/* $Id: petscvec.h,v 1.118 2001/04/18 14:36:07 bsmith Exp bsmith $ */
/*
    Defines the vector component of PETSc. Vectors generally represent
  degrees of freedom for finite element/finite difference functions
  on a grid. They have more mathematical structure then simple arrays.
*/

#ifndef __PETSCVEC_H
#define __PETSCVEC_H
#include "petscis.h"
#include "petscsys.h"

#define VEC_COOKIE         PETSC_COOKIE+3
#define MAP_COOKIE         PETSC_COOKIE+22
#define VEC_SCATTER_COOKIE PETSC_COOKIE+4

/*S
     Map - Abstract PETSc object that defines the layout of vector and
  matrices across processors

   Level: advanced

   Notes:
    Does not play a role in the PETSc design, can be ignored

  Concepts: parallel decomposition

.seealso:  MapCreateMPI()
S*/
typedef struct _p_Map*         Map;

/*S
     Vec - Abstract PETSc vector object

   Level: beginner

  Concepts: field variables, unknowns, arrays

.seealso:  VecCreate(), VecType, VecSetType()
S*/
typedef struct _p_Vec*         Vec;

/*S
     VecScatter - Object used to manage communication of data
       between vectors in parallel. Manages both scatters and gathers

   Level: beginner

  Concepts: scatter

.seealso:  VecScatterCreate(), VecScatterBegin(), VecScatterEnd()
S*/
typedef struct _p_VecScatter*  VecScatter;

/*E
    VecType - String with the name of a PETSc vector or the creation function
       with an optional dynamic library name, for example
       http://www.mcs.anl.gov/petsc/lib.a:myveccreate()

   Level: beginner

.seealso: VecSetType(), Vec
E*/
#define VEC_SEQ    "seq"
#define VEC_MPI    "mpi"
#define VEC_FETI   "feti"
#define VEC_SHARED "shared"
typedef char*                  VecType;

EXTERN int VecCreateSeq(MPI_Comm,int,Vec*);
EXTERN int MapCreateMPI(MPI_Comm,int,int,Map*);
EXTERN int VecCreateMPI(MPI_Comm,int,int,Vec*);
EXTERN int VecCreateSeqWithArray(MPI_Comm,int,const Scalar[],Vec*);
EXTERN int VecCreateMPIWithArray(MPI_Comm,int,int,const Scalar[],Vec*);
EXTERN int VecCreateShared(MPI_Comm,int,int,Vec*);
EXTERN int VecCreate(MPI_Comm,int,int,Vec*);
EXTERN int VecSetType(Vec,VecType);
EXTERN int VecSetFromOptions(Vec);

EXTERN int VecDestroy(Vec);

EXTERN int MapDestroy(Map);
EXTERN int MapGetLocalSize(Map,int *);
EXTERN int MapGetSize(Map,int *);
EXTERN int MapGetLocalRange(Map,int *,int *);
EXTERN int MapGetGlobalRange(Map,int *[]);

EXTERN int VecDot(Vec,Vec,Scalar*);
EXTERN int VecTDot(Vec,Vec,Scalar*);
EXTERN int VecMDot(int,Vec,const Vec[],Scalar*);
EXTERN int VecMTDot(int,Vec,const Vec[],Scalar*);

/*E
    NormType - determines what type of norm to compute

    Level: beginner

.seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
E*/
typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType;
#define NORM_MAX NORM_INFINITY

EXTERN int VecNorm(Vec,NormType,PetscReal *);
EXTERN int VecSum(Vec,Scalar*);
EXTERN int VecMax(Vec,int*,PetscReal *);
EXTERN int VecMin(Vec,int*,PetscReal *);

PETSCPTEMPLATEBEGIN1 int VecScale(const _Scalar1 *a,Vec v) PETSCPTEMPLATEEND;
template <> int VecScale <double> (const double*,Vec);

EXTERN int VecCopy(Vec,Vec);
EXTERN int VecSetRandom(PetscRandom,Vec);
EXTERN int VecSet(const Scalar*,Vec);
EXTERN int VecSwap(Vec,Vec);
EXTERN int VecAXPY(const Scalar*,Vec,Vec);
EXTERN int VecAXPBY(const Scalar*,const Scalar *,Vec,Vec);
EXTERN int VecMAXPY(int,const Scalar*,Vec,Vec*);
EXTERN int VecAYPX(const Scalar*,Vec,Vec);
EXTERN int VecWAXPY(const Scalar*,Vec,Vec,Vec);
EXTERN int VecPointwiseMult(Vec,Vec,Vec);
EXTERN int VecPointwiseDivide(Vec,Vec,Vec);
EXTERN int VecShift(const Scalar*,Vec);
EXTERN int VecReciprocal(Vec);
EXTERN int VecAbs(Vec);
EXTERN int VecDuplicate(Vec,Vec*);
EXTERN int VecDuplicateVecs(Vec,int,Vec*[]);
EXTERN int VecDestroyVecs(const Vec[],int);
EXTERN int VecGetMap(Vec,Map*);

/*E
    InsertMode - Whether entries are inserted or added into vectors or matrices
     to continue to add values to it

    Level: beginner

.seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
          VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
          MatSetValuesBlockedLocal(), MatSetValuesLocal()
E*/
typedef enum {NOT_SET_VALUES,INSERT_VALUES,ADD_VALUES,MAX_VALUES} InsertMode;

EXTERN int VecStrideNorm(Vec,int,NormType,double*);
EXTERN int VecStrideGather(Vec,int,Vec,InsertMode);
EXTERN int VecStrideScatter(Vec,int,Vec,InsertMode);
EXTERN int VecStrideMax(Vec,int,int *,double *);
EXTERN int VecStrideMin(Vec,int,int *,double *);
EXTERN int VecStrideGatherAll(Vec,Vec*,InsertMode);
EXTERN int VecStrideScatterAll(Vec*,Vec,InsertMode);

EXTERN int VecSetValues(Vec,int,const int[],const Scalar[],InsertMode);
EXTERN int VecAssemblyBegin(Vec);
EXTERN int VecAssemblyEnd(Vec);
EXTERN int VecSetStashInitialSize(Vec,int,int);
EXTERN int VecStashView(Vec,PetscViewer);

#define VecSetValue(v,i,va,mode) 0;\
{int _ierr,_row = i; Scalar _va = va; \
  _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \
}
EXTERN int VecSetBlockSize(Vec,int);
EXTERN int VecGetBlockSize(Vec,int*);
EXTERN int VecSetValuesBlocked(Vec,int,const int[],const Scalar[],InsertMode);

extern PetscTruth VecRegisterAllCalled;
EXTERN int        VecRegisterAll(const char []);
EXTERN int        VecRegister(const char[],const char[],const char[],int(*)(Vec));
#if defined(PETSC_USE_DYNAMIC_LIBRARIES)
#define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0)
#else
#define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d)
#endif


/*E
    ScatterMode - Determines the direction of a scatter

   Level: beginner

.seealso: VecScatter, VecScatterBegin(), VecScatterEnd()
E*/
typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2,
              SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode;
EXTERN int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
EXTERN int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter);
EXTERN int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter);
EXTERN int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter);
EXTERN int VecScatterDestroy(VecScatter);
EXTERN int VecScatterCopy(VecScatter,VecScatter *);
EXTERN int VecScatterView(VecScatter,PetscViewer);
EXTERN int VecScatterRemap(VecScatter,int *,int*);

typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection;
typedef enum {PIPELINE_NONE=1,PIPELINE_SEQUENTIAL=2,
	      PIPELINE_REDBLACK=3,PIPELINE_MULTICOLOR=4} PipelineType;

typedef struct _p_VecPipeline*  VecPipeline;

EXTERN int VecPipelineCreate(MPI_Comm,Vec,IS,Vec,IS,VecPipeline *);
EXTERN int VecPipelineSetType(VecPipeline,PipelineType,PetscObject);
EXTERN int VecPipelineSetup(VecPipeline);
EXTERN int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline);
EXTERN int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline);
EXTERN int VecPipelineView(VecPipeline,PetscViewer);
EXTERN int VecPipelineDestroy(VecPipeline);

EXTERN int VecGetArray(Vec,Scalar*[]);
EXTERN int VecRestoreArray(Vec,Scalar*[]);
EXTERN int VecGetArray4d(Vec,int,int,int,int,int,int,int,int,Scalar****[]);
EXTERN int VecRestoreArray4d(Vec,int,int,int,int,int,int,int,int,Scalar****[]);
EXTERN int VecGetArray3d(Vec,int,int,int,int,int,int,Scalar***[]);
EXTERN int VecRestoreArray3d(Vec,int,int,int,int,int,int,Scalar***[]);
EXTERN int VecGetArray2d(Vec,int,int,int,int,Scalar**[]);
EXTERN int VecRestoreArray2d(Vec,int,int,int,int,Scalar**[]);
EXTERN int VecGetArray1d(Vec,int,int,Scalar *[]);
EXTERN int VecRestoreArray1d(Vec,int,int,Scalar *[]);

EXTERN int VecPlaceArray(Vec,const Scalar[]);
EXTERN int VecResetArray(Vec);
EXTERN int VecReplaceArray(Vec,const Scalar[]);
EXTERN int VecGetArrays(const Vec[],int,Scalar**[]);
EXTERN int VecRestoreArrays(const Vec[],int,Scalar**[]);

EXTERN int VecValid(Vec,PetscTruth*);
EXTERN int VecView(Vec,PetscViewer);
EXTERN int VecEqual(Vec,Vec,PetscTruth*);
EXTERN int VecLoad(PetscViewer,Vec*);
EXTERN int VecLoadIntoVector(PetscViewer,Vec);

EXTERN int VecGetSize(Vec,int*);
EXTERN int VecGetType(Vec,VecType*);
EXTERN int VecGetLocalSize(Vec,int*);
EXTERN int VecGetOwnershipRange(Vec,int*,int*);

EXTERN int VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
EXTERN int VecSetValuesLocal(Vec,int,const int[],const Scalar[],InsertMode);
EXTERN int VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping);
EXTERN int VecSetValuesBlockedLocal(Vec,int,const int[],const Scalar[],InsertMode);

EXTERN int VecDotBegin(Vec,Vec,Scalar *);
EXTERN int VecDotEnd(Vec,Vec,Scalar *);
EXTERN int VecTDotBegin(Vec,Vec,Scalar *);
EXTERN int VecTDotEnd(Vec,Vec,Scalar *);
EXTERN int VecNormBegin(Vec,NormType,double *);
EXTERN int VecNormEnd(Vec,NormType,double *);

typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption;
EXTERN int VecSetOption(Vec,VecOption);

EXTERN int VecContourScale(Vec,double,double);

/*
    These numbers need to match the entries in
  the function table in src/vec/vecimpl.h
*/
typedef enum { VECOP_VIEW = 33,
               VECOP_LOADINTOVECTOR = 40
             } VecOperation;
EXTERN int VecSetOperation(Vec,VecOperation,void(*)());

/*
     Routines for dealing with ghosted vectors:
  vectors with ghost elements at the end of the array.
*/
EXTERN int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*);
EXTERN int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const Scalar[],Vec*);
EXTERN int VecCreateGhostBlock(MPI_Comm,int,int,int,int,const int[],Vec*);
EXTERN int VecCreateGhostBlockWithArray(MPI_Comm,int,int,int,int,const int[],const Scalar[],Vec*);
EXTERN int VecGhostGetLocalForm(Vec,Vec*);
EXTERN int VecGhostRestoreLocalForm(Vec,Vec*);
EXTERN int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
EXTERN int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);

EXTERN int VecConjugate(Vec);

#endif