Data Structures | Files | Typedefs | Functions

Vpmgp class

Parameter structure for Mike Holst's PMGP code. More...

Data Structures

struct  sVpmgp
 Contains public data members for Vpmgp class/module. More...

Files

file  vpmgp.h
 

Contains declarations for class Vpmgp.


file  vpmgp.c
 

Class Vpmgp methods.


Typedefs

typedef struct sVpmgp Vpmgp
 Declaration of the Vpmgp class as the sVpmgp structure.

Functions

VEXTERNC VpmgpVpmgp_ctor (MGparm *mgparm)
 Construct PMG parameter object and initialize to default values.
VEXTERNC int Vpmgp_ctor2 (Vpmgp *thee, MGparm *mgparm)
 FORTRAN stub to construct PMG parameter object and initialize to default values.
VEXTERNC void Vpmgp_dtor (Vpmgp **thee)
 Object destructor.
VEXTERNC void Vpmgp_dtor2 (Vpmgp *thee)
 FORTRAN stub for object destructor.
VEXTERNC void Vpmgp_size (Vpmgp *thee)
 Determine array sizes and parameters for multigrid solver.
VEXTERNC void Vpmgp_makeCoarse (int numLevel, int nxOld, int nyOld, int nzOld, int *nxNew, int *nyNew, int *nzNew)
 Coarsen the grid by the desired number of levels and determine the resulting numbers of grid points.

Detailed Description

Parameter structure for Mike Holst's PMGP code.

Note:
Variables and many default values taken directly from PMG

Function Documentation

VEXTERNC Vpmgp* Vpmgp_ctor ( MGparm mgparm )

Construct PMG parameter object and initialize to default values.

Author:
Nathan Baker
Parameters:
mgparmMGParm object containing parameters to be used in setup
Returns:
Newly allocated and initialized Vpmgp object

Definition at line 70 of file vpmgp.c.

VEXTERNC int Vpmgp_ctor2 ( Vpmgp thee,
MGparm mgparm 
)

FORTRAN stub to construct PMG parameter object and initialize to default values.

Author:
Nathan Baker
Parameters:
theeNewly allocated PMG object
mgparmMGParm object containing parameters to be used in setup
Returns:
1 if successful, 0 otherwise

Definition at line 87 of file vpmgp.c.

VEXTERNC void Vpmgp_dtor ( Vpmgp **  thee )

Object destructor.

Author:
Nathan Baker
Parameters:
theePointer to memory location for Vpmgp object

Definition at line 172 of file vpmgp.c.

VEXTERNC void Vpmgp_dtor2 ( Vpmgp thee )

FORTRAN stub for object destructor.

Author:
Nathan Baker
Parameters:
theePointer to Vpmgp object

Definition at line 187 of file vpmgp.c.

VEXTERNC void Vpmgp_makeCoarse ( int  numLevel,
int  nxOld,
int  nyOld,
int  nzOld,
int *  nxNew,
int *  nyNew,
int *  nzNew 
)

Coarsen the grid by the desired number of levels and determine the resulting numbers of grid points.

Author:
Mike Holst and Nathan Baker
Parameters:
numLevelNumber of levels to coarsen
nxOldNumber of old grid points in this direction
nyOldNumber of old grid points in this direction
nzOldNumber of old grid points in this direction
nxNewNumber of new grid points in this direction
nyNewNumber of new grid points in this direction
nzNewNumber of new grid points in this direction

Definition at line 306 of file vpmgp.c.

VEXTERNC void Vpmgp_size ( Vpmgp thee )

Determine array sizes and parameters for multigrid solver.

Author:
Mike Holst and Nathan Baker
Parameters:
theeObject to be sized

Definition at line 190 of file vpmgp.c.

Here is the caller graph for this function: