Vpmgp class

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

Files
file	vpmgp.c
	Class Vpmgp methods.
file	vpmgp.h
	Contains declarations for class Vpmgp.

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

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

Functions
VEXTERNC Vpmgp *	Vpmgp_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

Typedef Documentation

Vpmgp

typedef struct sVpmgp Vpmgp

Declaration of the Vpmgp class as the sVpmgp structure.

Definition at line 204 of file vpmgp.h.

Function Documentation

Vpmgp_ctor()

VEXTERNC Vpmgp * Vpmgp_ctor

(

MGparm *

mgparm

)

Construct PMG parameter object and initialize to default values.

Author

Nathan Baker

Parameters

mgparm

MGParm object containing parameters to be used in setup

Returns

Newly allocated and initialized Vpmgp object

Definition at line 76 of file vpmgp.c.

Vpmgp_ctor2()

VEXTERNC int Vpmgp_ctor2	(	Vpmgp *	thee,
		MGparm *	mgparm )

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

Author

Nathan Baker

Parameters

thee	Newly allocated PMG object
mgparm	MGParm object containing parameters to be used in setup

Returns

1 if successful, 0 otherwise

Definition at line 93 of file vpmgp.c.

Vpmgp_dtor()

VEXTERNC void Vpmgp_dtor

(

Vpmgp **

thee

)

Object destructor.

Author

Nathan Baker

Parameters

thee	Pointer to memory location for Vpmgp object

Definition at line 178 of file vpmgp.c.

Vpmgp_dtor2()

VEXTERNC void Vpmgp_dtor2

(

Vpmgp *

thee

)

FORTRAN stub for object destructor.

Author

Nathan Baker

Parameters

thee	Pointer to Vpmgp object

Definition at line 193 of file vpmgp.c.

Vpmgp_makeCoarse()

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

numLevel	Number of levels to coarsen
nxOld	Number of old grid points in this direction
nyOld	Number of old grid points in this direction
nzOld	Number of old grid points in this direction
nxNew	Number of new grid points in this direction
nyNew	Number of new grid points in this direction
nzNew	Number of new grid points in this direction

Definition at line 312 of file vpmgp.c.

Vpmgp_size()

VEXTERNC void Vpmgp_size

(

Vpmgp *

thee

)

Determine array sizes and parameters for multigrid solver.

Author

Mike Holst and Nathan Baker

Parameters

thee	Object to be sized

Definition at line 196 of file vpmgp.c.