Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

Vpmgp class

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


Files

file  vpmgp.h
 Contains declarations for class Vpmgp.


Data Structures

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


Typedefs

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


Functions

Vpmgp * Vpmgp_ctor (int nx, int ny, int nz, int nlev, double hx, double hy, double hzed, int nonlin)
 Construct PMG parameter object and initialize to default values.

int Vpmgp_ctor2 (Vpmgp *thee, int nx, int ny, int nz, int nlev, double hx, double hy, double hzed, int nonlin)
 FORTRAN stub to construct PMG parameter object and initialize to default values.

void Vpmgp_dtor (Vpmgp **thee)
 Object destructor.

void Vpmgp_dtor2 (Vpmgp *thee)
 FORTRAN stub for object destructor.


Detailed Description

Parameter structure for Mike Holst's PMGP code.

Note:
Variables and many default values taken directly from PMG

Typedef Documentation

typedef struct sVpmgp Vpmgp
 

Declaration of the Vpmgp class as the sVpmgp structure.


Function Documentation

Vpmgp* Vpmgp_ctor int    nx,
int    ny,
int    nz,
int    nlev,
double    hx,
double    hy,
double    hzed,
int    nonlin
 

Construct PMG parameter object and initialize to default values.

Author:
Nathan Baker
Parameters:
nx Number of x grid points
ny Number of y grid points
nz Number of z grid points
nlev Number of levels in multigrid hierarchy
hx Grid spacing in x direction
hy Grid spacing in y direction
hzed Grid spacing in z direction
nonlin Nonlinearity flag
  • 0: Linearized PBE
  • 1: Nonlinear PBE
Returns:
Newly allocated and initialized Vpmgp object

int Vpmgp_ctor2 Vpmgp   thee,
int    nx,
int    ny,
int    nz,
int    nlev,
double    hx,
double    hy,
double    hzed,
int    nonlin
 

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

Author:
Nathan Baker
Parameters:
thee Newly allocated PMG object
nx Number of x grid points
ny Number of y grid points
nz Number of z grid points
nlev Number of levels in multigrid hierarchy
hx Grid spacing in x direction
hy Grid spacing in y direction
hzed Grid spacing in z direction
nonlin Nonlinearity flag
  • 0: Linearized PBE
  • 1: Nonlinear PBE
Returns:
1 if successful, 0 otherwise

void Vpmgp_dtor Vpmgp **    thee
 

Object destructor.

Author:
Nathan Baker
Parameters:
thee Pointer to memory location for Vpmgp object

void Vpmgp_dtor2 Vpmgp   thee
 

FORTRAN stub for object destructor.

Author:
Nathan Baker
Parameters:
thee Pointer to Vpmgp object


Generated on Fri Feb 20 15:41:37 2004 for APBS by doxygen1.3-rc3