sVpmgp Struct Reference
[Vpmgp class]

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

#include <vpmgp.h>

Data Fields
int	nx
int	ny
int	nz
int	nlev
double	hx
double	hy
double	hzed
int	nonlin
int	nxc
int	nyc
int	nzc
int	nf
int	nc
int	narrc
int	n_rpc
int	n_iz
int	n_ipc
int	nrwk
int	niwk
int	narr
int	ipkey
double	xcent
double	ycent
double	zcent
double	errtol
int	itmax
int	istop
int	iinfo
Vbcfl	bcfl
int	key
int	iperf
int	meth
int	mgkey
int	nu1
int	nu2
int	mgsmoo
int	mgprol
int	mgcoar
int	mgsolv
int	mgdisc
double	omegal
double	omegan
int	irite
int	ipcon
double	xlen
double	ylen
double	zlen
double	xmin
double	ymin
double	zmin
double	xmax
double	ymax
double	zmax

---

Detailed Description

Contains public data members for Vpmgp class/module.

Author:

Nathan Baker

---

Field Documentation

Vbcfl sVpmgp::bcfl

Boundary condition method [default = BCFL_SDH]

double sVpmgp::errtol

Desired error tolerance [default = 1e-9]

double sVpmgp::hx

Grid x spacings [no default]

double sVpmgp::hy

Grid y spacings [no default]

double sVpmgp::hzed

Grid z spacings [no default]

int sVpmgp::iinfo

Runtime status messages [default = 1] 0: none 1: some 2: lots 3: more

int sVpmgp::ipcon

Preconditioning method [default = 3] 0: diagonal 1: ICCG 2: ICCGDW 3: MICCGDW 4: none

int sVpmgp::iperf

Analysis of the operator [default = 0] 0: no 1: condition number 2: spectral radius 3: cond. number & spectral radius

int sVpmgp::ipkey

Toggles nonlinearity (set by nonlin) -1: Linearized PBE 0: Nonlinear PBE with capped sinh term [default] >1: Polynomial approximation to sinh, note that ipkey must be odd

int sVpmgp::irite

FORTRAN output unit [default = 8]

int sVpmgp::istop

Stopping criterion [default = 1] 0: residual 1: relative residual 2: diff 3: errc 4: errd 5: aerrd

int sVpmgp::itmax

Maximum number of iters [default = 100]

int sVpmgp::key

Print solution to file [default = 0] 0: no 1: yes

int sVpmgp::meth

Solution method [default = 2] 0: conjugate gradient multigrid 1: newton 2: multigrid 3: conjugate gradient 4: sucessive overrelaxation 5: red-black gauss-seidel 6: weighted jacobi 7: richardson

int sVpmgp::mgcoar

Coarsening method [default = 2] 0: standard 1: harmonic 2: galerkin

int sVpmgp::mgdisc

Discretization method [default = 0] 0: finite volume 1: finite element

int sVpmgp::mgkey

Multigrid method [default = 0] 0: variable v-cycle 1: nested iteration

int sVpmgp::mgprol

Prolongation method [default = 0] 0: trilinear 1: operator-based 2: mod. operator-based

int sVpmgp::mgsmoo

Smoothing method [default = 1] 0: weighted jacobi 1: gauss-seidel 2: SOR 3: richardson 4: cghs

int sVpmgp::mgsolv

Coarse equation solve method [default = 1] 0: cghs 1: banded linpack

int sVpmgp::n_ipc

Integer info work array required storage

int sVpmgp::n_iz

Integer storage parameter (index max)

int sVpmgp::n_rpc

Real info work array required storage

int sVpmgp::narr

Array work storage

int sVpmgp::narrc

Size of vector on coarse level

int sVpmgp::nc

Number of coarse grid unknowns

int sVpmgp::nf

Number of fine grid unknowns

int sVpmgp::niwk

Integer work storage

int sVpmgp::nlev

Number of mesh levels [no default]

int sVpmgp::nonlin

Problem type [no default] 0: linear 1: nonlinear 2: linear then nonlinear

int sVpmgp::nrwk

Real work storage

int sVpmgp::nu1

Number of pre-smoothings [default = 2]

int sVpmgp::nu2

Number of post-smoothings [default = 2]

int sVpmgp::nx

Grid x dimensions [no default]

int sVpmgp::nxc

Coarse level grid x dimensions

int sVpmgp::ny

Grid y dimensions [no default]

int sVpmgp::nyc

Coarse level grid y dimensions

int sVpmgp::nz

Grid z dimensions [no default]

int sVpmgp::nzc

Coarse level grid z dimensions

double sVpmgp::omegal

Linear relax parameter [default = 8e-1]

double sVpmgp::omegan

Nonlin relax parameter [default = 9e-1]

double sVpmgp::xcent

Grid x center [0]

double sVpmgp::xlen

Domain x length

double sVpmgp::xmax

Domain upper x corner

double sVpmgp::xmin

Domain lower x corner

double sVpmgp::ycent

Grid y center [0]

double sVpmgp::ylen

Domain y length

double sVpmgp::ymax

Domain upper y corner

double sVpmgp::ymin

Domain lower y corner

double sVpmgp::zcent

Grid z center [0]

double sVpmgp::zlen

Domain z length

double sVpmgp::zmax

Domain upper z corner

double sVpmgp::zmin

Domain lower z corner

---

The documentation for this struct was generated from the following file:

• vpmgp.h

---