petsc.h File Reference

#include <petscconf.h>
#include <stdio.h>
#include "mpi.h"
#include "petscmath.h"
#include <src/inline/bitarray.h>
#include "viewer.h"
#include "options.h"
#include "draw.h"
#include "petsopserror.h"
#include "petschead.h"
#include "petsclog.h"
#include <mat.h>

Go to the source code of this file.

Defines

#define __PETSC_PACKAGE
#define PETSC_VERSION_NUMBER   "PETSc Version 2.0.22, Released April 28, 1998."
#define PETSC_VERSION_MAJOR   2
#define PETSC_VERSION_MINOR   0
#define PETSC_VERSION_SUBMINOR   22
#define PETSC_VERSION_DATE   "April 29, 1998"
#define PETSC_AUTHOR_INFO   "The PETSc Team:\ Satish Balay, Bill Gropp, Lois Curfman McInnes, Barry Smith\n\ Bug reports, questions: petsc-maint@mcs.anl.gov\n\ Web page: http://www.mcs.anl.gov/petsc/\n"
#define PetscFortranAddr   long
#define PetscMalloc(a)   (*PetscTrMalloc)(a,__LINE__,__FUNC__,__FILE__,__SDIR__)
#define PetscNew(A)   (A*) PetscMalloc(sizeof(A))
#define PetscFree(a)   (*PetscTrFree)(a,__LINE__,__FUNC__,__FILE__,__SDIR__)
#define PETSC_SCALAR   PETSC_DOUBLE
#define PETSC_NULL   0
#define PETSC_DECIDE   -1
#define PETSC_DETERMINE   PETSC_DECIDE
#define PETSC_DEFAULT   -2
#define PETSC_COOKIE   1211211
#define LARGEST_PETSC_COOKIE_PREDEFINED   PETSC_COOKIE + 30
#define LARGEST_PETSC_COOKIE_ALLOWED   PETSC_COOKIE + 50
#define PetscObjectComposeFunction(a, b, c, d)   PetscObjectComposeFunction_Private(a,b,c,d)
#define DLRegister(a, b, p, c)   DLRegister_Private(a,b,p,(int (*)(void *))c)
#define PetscBarrier(A)
#define restrict

Typedefs

typedef _p_PetscObject * PetscObject
typedef _OList * OList
typedef _DLList * DLList
typedef _DLLibraryList * DLLibraryList
typedef _p_PetscObjectContainer * PetscObjectContainer

Enumerations

enum  PetscDataType {
  PETSC_INT = 0, PETSC_DOUBLE = 1, PETSC_SHORT = 2, PETSC_FLOAT = 3,
  PETSC_COMPLEX = 4, PETSC_CHAR = 5, PETSC_LOGICAL = 6, PETSC_INT = 0,
  PETSC_DOUBLE = 1, PETSC_SHORT = 2, PETSC_FLOAT = 3, PETSC_COMPLEX = 4,
  PETSC_CHAR = 5, PETSC_LOGICAL = 6
}
enum  PetscDataTypeSize {
  PETSC_INT_SIZE = sizeof(int), PETSC_DOUBLE_SIZE = sizeof(double), PETSC_SCALAR_SIZE = sizeof(Scalar), PETSC_COMPLEX_SIZE = sizeof(double),
  PETSC_CHAR_SIZE = sizeof(char), PETSC_LOGICAL_SIZE = 1, PETSC_INT_SIZE = sizeof(int), PETSC_DOUBLE_SIZE = sizeof(double),
  PETSC_SCALAR_SIZE = sizeof(Scalar), PETSC_COMPLEX_SIZE = sizeof(double), PETSC_CHAR_SIZE = sizeof(char), PETSC_LOGICAL_SIZE = 1
}
enum  PetscTruth { PETSC_FALSE, PETSC_TRUE, PETSC_FALSE, PETSC_TRUE }

Functions

int PetscSetCommWorld (MPI_Comm)
int PetscSetMalloc (void *(*)(unsigned int, int, char *, char *, char *), int(*)(void *, int, char *, char *, char *))
int PetscClearMalloc (void)
int PetscTrDump (FILE *)
int PetscTrSpace (PLogDouble *, PLogDouble *, PLogDouble *)
int PetscTrValid (int, char *, char *, char *)
int PetscTrDebugLevel (int)
int PetscTrLog (void)
int PetscTrLogDump (FILE *)
int PetscGetResidentSetSize (PLogDouble *)
int PetscDataTypeToMPIDataType (PetscDataType, MPI_Datatype *)
int PetscDataTypeGetSize (PetscDataType, int *)
int PetscDataTypeGetName (PetscDataType, char **)
int PetscMemcpy (void *, void *, int)
int PetscBitMemcpy (void *, int, void *, int, int, PetscDataType)
int PetscMemmove (void *, void *, int)
int PetscMemzero (void *, int)
int PetscMemcmp (void *, void *, int)
int PetscStrlen (char *)
int PetscStrcmp (char *, char *)
int PetscStrcasecmp (char *, char *)
int PetscStrncmp (char *, char *, int)
int PetscStrcpy (char *, char *)
int PetscStrcat (char *, char *)
int PetscStrncat (char *, char *, int)
int PetscStrncpy (char *, char *, int)
char * PetscStrchr (char *, char)
char * PetscStrrchr (char *, char)
char * PetscStrstr (char *, char *)
char * PetscStrtok (char *, char *)
char * PetscStrrtok (char *, char *)
int PetscGetTime (PLogDouble *)
int PetscGetCPUTime (PLogDouble *)
int PetscSleep (int)
int PetscInitialize (int *, char ***, char *, char *)
int PetscInitializeNoArguments (void)
int PetscFinalize (void)
void PetscInitializeFortran (void)
int PetscObjectDestroy (PetscObject)
int PetscObjectExists (PetscObject, int *)
int PetscObjectGetComm (PetscObject, MPI_Comm *comm)
int PetscObjectGetCookie (PetscObject, int *cookie)
int PetscObjectGetType (PetscObject, int *type)
int PetscObjectSetName (PetscObject, char *)
int PetscObjectGetName (PetscObject, char **)
int PetscObjectReference (PetscObject)
int PetscObjectGetReference (PetscObject, int *)
int PetscObjectDereference (PetscObject)
int PetscObjectGetNewTag (PetscObject, int *)
int PetscObjectRestoreNewTag (PetscObject, int *)
int PetscObjectView (PetscObject, Viewer)
int PetscObjectCompose (PetscObject, char *, PetscObject)
int PetscObjectQuery (PetscObject, char *, PetscObject *)
int PetscObjectComposeFunction_Private (PetscObject, char *, char *, void *)
int PetscObjectQueryFunction (PetscObject, char *, void **)
int OListDestroy (OList *)
int OListFind (OList, char *, PetscObject *)
int OListAdd (OList *, char *, PetscObject)
int OListRemove (OList *, char *)
int OListDuplicate (OList, OList *)
int DLRegister_Private (DLList *, char *, char *, int(*)(void *))
int DLRegisterCreate (DLList *)
int DLRegisterDestroy (DLList)
int DLRegisterFind (MPI_Comm, DLList, char *, int(**)(void *))
int DLRegisterPrintTypes (MPI_Comm, FILE *, char *, char *, DLList)
int DLLibraryOpen (MPI_Comm, char *, void **)
int DLLibrarySym (MPI_Comm, DLLibraryList *, char *, char *, void **)
int DLLibraryAppend (MPI_Comm, DLLibraryList *, char *)
int DLLibraryPrepend (MPI_Comm, DLLibraryList *, char *)
int DLLibraryClose (DLLibraryList)
int PetscSequentialPhaseBegin (MPI_Comm, int)
int PetscSequentialPhaseEnd (MPI_Comm, int)
int PetscMPIDump (FILE *)
int PetscCObjectToFortranObject (void *, PetscFortranAddr *)
int PetscFortranObjectToCObject (PetscFortranAddr, void *)
int MPICCommToFortranComm (MPI_Comm, int *)
int MPIFortranCommToCComm (int, MPI_Comm *)
int PetscFixFilename (char *)
FILEPetscFOpen (MPI_Comm, char *, char *)
int PetscFClose (MPI_Comm, FILE *)
int PetscFPrintf (MPI_Comm, FILE *, char *,...)
int PetscPrintf (MPI_Comm, char *,...)
int PetscSynchronizedPrintf (MPI_Comm, char *,...)
int PetscSynchronizedFPrintf (MPI_Comm, FILE *, char *,...)
int PetscSynchronizedFlush (MPI_Comm)
int PetscObjectContainerGetPointer (PetscObjectContainer, void **)
int PetscObjectContainerSetPointer (PetscObjectContainer, void *)
int PetscObjectContainerDestroy (PetscObjectContainer)
int PetscObjectContainerCreate (MPI_Comm comm, PetscObjectContainer *)
int PetscCompareDouble (double)
int PetscCompareScalar (Scalar)
int PetscCompareInt (int)
int PetscIntView (int, int *, Viewer)
int PetscDoubleView (int, double *, Viewer)

Variables

MPI_Comm PETSC_COMM_WORLD
MPI_Comm PETSC_COMM_SELF
int PetscInitializedCalled
void *(*) PetscTrMalloc (unsigned int, int, char *, char *, char *)
int(*) PetscTrFree (void *, int, char *, char *, char *)
int LARGEST_PETSC_COOKIE
DLLibraryList DLLibrariesLoaded
int(*) PetscErrorPrintf (char *,...)
int(*) PetscHelpPrintf (MPI_Comm, char *,...)
int PetscCompare
int PetscGlobalRank
int PetscGlobalSize


Define Documentation

#define __PETSC_PACKAGE

Definition at line 32 of file petsc.h.

#define DLRegister ( a,
b,
p,
c   )     DLRegister_Private(a,b,p,(int (*)(void *))c)

Definition at line 238 of file petsc.h.

#define LARGEST_PETSC_COOKIE_ALLOWED   PETSC_COOKIE + 50

Definition at line 160 of file petsc.h.

#define LARGEST_PETSC_COOKIE_PREDEFINED   PETSC_COOKIE + 30

Definition at line 159 of file petsc.h.

#define PETSC_AUTHOR_INFO   "The PETSc Team:\ Satish Balay, Bill Gropp, Lois Curfman McInnes, Barry Smith\n\ Bug reports, questions: petsc-maint@mcs.anl.gov\n\ Web page: http://www.mcs.anl.gov/petsc/\n"

Definition at line 43 of file petsc.h.

#define PETSC_COOKIE   1211211

Definition at line 158 of file petsc.h.

#define PETSC_DECIDE   -1

Definition at line 148 of file petsc.h.

#define PETSC_DEFAULT   -2

Definition at line 150 of file petsc.h.

#define PETSC_DETERMINE   PETSC_DECIDE

Definition at line 149 of file petsc.h.

#define PETSC_NULL   0

Definition at line 147 of file petsc.h.

#define PETSC_SCALAR   PETSC_DOUBLE

Definition at line 111 of file petsc.h.

#define PETSC_VERSION_DATE   "April 29, 1998"

Definition at line 42 of file petsc.h.

#define PETSC_VERSION_MAJOR   2

Definition at line 39 of file petsc.h.

#define PETSC_VERSION_MINOR   0

Definition at line 40 of file petsc.h.

#define PETSC_VERSION_NUMBER   "PETSc Version 2.0.22, Released April 28, 1998."

Definition at line 37 of file petsc.h.

#define PETSC_VERSION_SUBMINOR   22

Definition at line 41 of file petsc.h.

#define PetscBarrier (  ) 

Value:

{ \
    PetscValidHeader(A); \
    PLogEventBegin(Petsc_Barrier,A,0,0,0); \
    MPI_Barrier(((PetscObject)A)->comm); \
    PLogEventEnd(Petsc_Barrier,A,0,0,0); \
  }

Definition at line 277 of file petsc.h.

#define PetscFortranAddr   long

Definition at line 76 of file petsc.h.

#define PetscFree (  )     (*PetscTrFree)(a,__LINE__,__FUNC__,__FILE__,__SDIR__)

Definition at line 89 of file petsc.h.

#define PetscMalloc (  )     (*PetscTrMalloc)(a,__LINE__,__FUNC__,__FILE__,__SDIR__)

Definition at line 87 of file petsc.h.

#define PetscNew (  )     (A*) PetscMalloc(sizeof(A))

Definition at line 88 of file petsc.h.

#define PetscObjectComposeFunction ( a,
b,
c,
 )     PetscObjectComposeFunction_Private(a,b,c,d)

Definition at line 203 of file petsc.h.

#define restrict

Definition at line 329 of file petsc.h.


Typedef Documentation

typedef struct _DLLibraryList* DLLibraryList

Definition at line 241 of file petsc.h.

typedef struct _DLList* DLList

Definition at line 229 of file petsc.h.

typedef struct _OList* OList

Definition at line 218 of file petsc.h.

typedef struct _p_PetscObject* PetscObject

Definition at line 183 of file petsc.h.

typedef struct _p_PetscObjectContainer* PetscObjectContainer

Definition at line 313 of file petsc.h.


Enumeration Type Documentation

Enumerator:
PETSC_INT 
PETSC_DOUBLE 
PETSC_SHORT 
PETSC_FLOAT 
PETSC_COMPLEX 
PETSC_CHAR 
PETSC_LOGICAL 
PETSC_INT 
PETSC_DOUBLE 
PETSC_SHORT 
PETSC_FLOAT 
PETSC_COMPLEX 
PETSC_CHAR 
PETSC_LOGICAL 

Definition at line 106 of file petsc.h.

Enumerator:
PETSC_INT_SIZE 
PETSC_DOUBLE_SIZE 
PETSC_SCALAR_SIZE 
PETSC_COMPLEX_SIZE 
PETSC_CHAR_SIZE 
PETSC_LOGICAL_SIZE 
PETSC_INT_SIZE 
PETSC_DOUBLE_SIZE 
PETSC_SCALAR_SIZE 
PETSC_COMPLEX_SIZE 
PETSC_CHAR_SIZE 
PETSC_LOGICAL_SIZE 

Definition at line 114 of file petsc.h.

enum PetscTruth

Enumerator:
PETSC_FALSE 
PETSC_TRUE 
PETSC_FALSE 
PETSC_TRUE 

Definition at line 146 of file petsc.h.


Function Documentation

int DLLibraryAppend ( MPI_Comm  ,
DLLibraryList ,
char *   
)

int DLLibraryClose ( DLLibraryList   ) 

int DLLibraryOpen ( MPI_Comm  ,
char *  ,
void **   
)

int DLLibraryPrepend ( MPI_Comm  ,
DLLibraryList ,
char *   
)

int DLLibrarySym ( MPI_Comm  ,
DLLibraryList ,
char *  ,
char *  ,
void **   
)

int DLRegister_Private ( DLList ,
char *  ,
char *  ,
int(*)(void *)   
)

int DLRegisterCreate ( DLList  ) 

int DLRegisterDestroy ( DLList   ) 

int DLRegisterFind ( MPI_Comm  ,
DLList  ,
char *  ,
int(**)(void *)   
)

int DLRegisterPrintTypes ( MPI_Comm  ,
FILE ,
char *  ,
char *  ,
DLList   
)

int MPICCommToFortranComm ( MPI_Comm  ,
int *   
)

int MPIFortranCommToCComm ( int  ,
MPI_Comm *   
)

int OListAdd ( OList ,
char *  ,
PetscObject   
)

int OListDestroy ( OList  ) 

int OListDuplicate ( OList  ,
OList  
)

int OListFind ( OList  ,
char *  ,
PetscObject  
)

int OListRemove ( OList ,
char *   
)

int PetscBitMemcpy ( void *  ,
int  ,
void *  ,
int  ,
int  ,
PetscDataType   
)

int PetscClearMalloc ( void   ) 

int PetscCObjectToFortranObject ( void *  ,
PetscFortranAddr *   
)

int PetscCompareDouble ( double   ) 

int PetscCompareInt ( int   ) 

int PetscCompareScalar ( Scalar   ) 

int PetscDataTypeGetName ( PetscDataType  ,
char **   
)

int PetscDataTypeGetSize ( PetscDataType  ,
int *   
)

int PetscDataTypeToMPIDataType ( PetscDataType  ,
MPI_Datatype *   
)

int PetscDoubleView ( int  ,
double *  ,
Viewer   
)

int PetscFClose ( MPI_Comm  ,
FILE  
)

int PetscFinalize ( void   ) 

int PetscFixFilename ( char *   ) 

FILE* PetscFOpen ( MPI_Comm  ,
char *  ,
char *   
)

int PetscFortranObjectToCObject ( PetscFortranAddr  ,
void *   
)

int PetscFPrintf ( MPI_Comm  ,
FILE ,
char *  ,
  ... 
)

int PetscGetCPUTime ( PLogDouble *   ) 

int PetscGetResidentSetSize ( PLogDouble *   ) 

int PetscGetTime ( PLogDouble *   ) 

int PetscInitialize ( int *  ,
char ***  ,
char *  ,
char *   
)

void PetscInitializeFortran ( void   ) 

int PetscInitializeNoArguments ( void   ) 

int PetscIntView ( int  ,
int *  ,
Viewer   
)

int PetscMemcmp ( void *  ,
void *  ,
int   
)

int PetscMemcpy ( void *  ,
void *  ,
int   
)

int PetscMemmove ( void *  ,
void *  ,
int   
)

int PetscMemzero ( void *  ,
int   
)

int PetscMPIDump ( FILE  ) 

int PetscObjectCompose ( PetscObject  ,
char *  ,
PetscObject   
)

int PetscObjectComposeFunction_Private ( PetscObject  ,
char *  ,
char *  ,
void *   
)

int PetscObjectContainerCreate ( MPI_Comm  comm,
PetscObjectContainer  
)

int PetscObjectContainerDestroy ( PetscObjectContainer   ) 

int PetscObjectContainerGetPointer ( PetscObjectContainer  ,
void **   
)

int PetscObjectContainerSetPointer ( PetscObjectContainer  ,
void *   
)

int PetscObjectDereference ( PetscObject   ) 

int PetscObjectDestroy ( PetscObject   ) 

int PetscObjectExists ( PetscObject  ,
int *   
)

int PetscObjectGetComm ( PetscObject  ,
MPI_Comm *  comm 
)

int PetscObjectGetCookie ( PetscObject  ,
int *  cookie 
)

int PetscObjectGetName ( PetscObject  ,
char **   
)

int PetscObjectGetNewTag ( PetscObject  ,
int *   
)

int PetscObjectGetReference ( PetscObject  ,
int *   
)

int PetscObjectGetType ( PetscObject  ,
int *  type 
)

int PetscObjectQuery ( PetscObject  ,
char *  ,
PetscObject  
)

int PetscObjectQueryFunction ( PetscObject  ,
char *  ,
void **   
)

int PetscObjectReference ( PetscObject   ) 

int PetscObjectRestoreNewTag ( PetscObject  ,
int *   
)

int PetscObjectSetName ( PetscObject  ,
char *   
)

int PetscObjectView ( PetscObject  ,
Viewer   
)

int PetscPrintf ( MPI_Comm  ,
char *  ,
  ... 
)

int PetscSequentialPhaseBegin ( MPI_Comm  ,
int   
)

int PetscSequentialPhaseEnd ( MPI_Comm  ,
int   
)

int PetscSetCommWorld ( MPI_Comm   ) 

int PetscSetMalloc ( void *  (*)(unsigned int, int, char *, char *, char *),
int(*)(void *, int, char *, char *, char *)   
)

int PetscSleep ( int   ) 

int PetscStrcasecmp ( char *  ,
char *   
)

int PetscStrcat ( char *  ,
char *   
)

char* PetscStrchr ( char *  ,
char   
)

int PetscStrcmp ( char *  ,
char *   
)

int PetscStrcpy ( char *  ,
char *   
)

int PetscStrlen ( char *   ) 

int PetscStrncat ( char *  ,
char *  ,
int   
)

int PetscStrncmp ( char *  ,
char *  ,
int   
)

int PetscStrncpy ( char *  ,
char *  ,
int   
)

char* PetscStrrchr ( char *  ,
char   
)

char* PetscStrrtok ( char *  ,
char *   
)

char* PetscStrstr ( char *  ,
char *   
)

char* PetscStrtok ( char *  ,
char *   
)

int PetscSynchronizedFlush ( MPI_Comm   ) 

int PetscSynchronizedFPrintf ( MPI_Comm  ,
FILE ,
char *  ,
  ... 
)

int PetscSynchronizedPrintf ( MPI_Comm  ,
char *  ,
  ... 
)

int PetscTrDebugLevel ( int   ) 

int PetscTrDump ( FILE  ) 

int PetscTrLog ( void   ) 

int PetscTrLogDump ( FILE  ) 

int PetscTrSpace ( PLogDouble *  ,
PLogDouble *  ,
PLogDouble *   
)

int PetscTrValid ( int  ,
char *  ,
char *  ,
char *   
)


Variable Documentation

MPI_Comm PETSC_COMM_SELF

MPI_Comm PETSC_COMM_WORLD

int(*) PetscErrorPrintf(char *,...)

int(*) PetscHelpPrintf(MPI_Comm, char *,...)

int(*) PetscTrFree(void *, int, char *, char *, char *)

void*(*) PetscTrMalloc(unsigned int, int, char *, char *, char *)

Generated on Mon Oct 23 15:05:36 2006 for OpenSees by doxygen 1.5.0