Data Fields

sVpmgp Struct Reference
[Vpmgp class]

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

#include <C:/Users/bake113/Desktop/Sync/Software/apbs/trunk/src/mg/apbs/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
Bug:
Value ipcon does not currently allow for preconditioning in PMG

Definition at line 70 of file vpmgp.h.


Field Documentation

Boundary condition method [default = BCFL_SDH]

Definition at line 125 of file vpmgp.h.

double errtol

Desired error tolerance [default = 1e-9]

Definition at line 111 of file vpmgp.h.

double hx

Grid x spacings [no default]

Definition at line 77 of file vpmgp.h.

double hy

Grid y spacings [no default]

Definition at line 78 of file vpmgp.h.

double hzed

Grid z spacings [no default]

Definition at line 79 of file vpmgp.h.

int iinfo

Runtime status messages [default = 1]

  • 0: none
  • 1: some
  • 2: lots
  • 3: more

Definition at line 120 of file vpmgp.h.

int ipcon

Preconditioning method [default = 3]

  • 0: diagonal
  • 1: ICCG
  • 2: ICCGDW
  • 3: MICCGDW
  • 4: none

Definition at line 173 of file vpmgp.h.

int iperf

Analysis of the operator [default = 0]

  • 0: no
  • 1: condition number
  • 2: spectral radius
  • 3: cond. number & spectral radius

Definition at line 129 of file vpmgp.h.

int ipkey

Toggles nonlinearity (set by nonlin)

  • -2: Size-Modified PBE
  • -1: Linearized PBE
  • 0: Nonlinear PBE with capped sinh term [default]
  • >1: Polynomial approximation to sinh, note that ipkey must be odd

Definition at line 99 of file vpmgp.h.

int irite

FORTRAN output unit [default = 8]

Definition at line 172 of file vpmgp.h.

int istop

Stopping criterion [default = 1]

  • 0: residual
  • 1: relative residual
  • 2: diff
  • 3: errc
  • 4: errd
  • 5: aerrd

Definition at line 113 of file vpmgp.h.

int itmax

Maximum number of iters [default = 100]

Definition at line 112 of file vpmgp.h.

int key

Print solution to file [default = 0]

  • 0: no
  • 1: yes

Definition at line 126 of file vpmgp.h.

int 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
  • 8: conjugate gradient multigrid aqua
  • 9: newton aqua

Definition at line 134 of file vpmgp.h.

int mgcoar

Coarsening method [default = 2]

  • 0: standard
  • 1: harmonic
  • 2: galerkin

Definition at line 160 of file vpmgp.h.

int mgdisc

Discretization method [default = 0]

  • 0: finite volume
  • 1: finite element

Definition at line 167 of file vpmgp.h.

int mgkey

Multigrid method [default = 0]

  • 0: variable v-cycle
  • 1: nested iteration

Definition at line 145 of file vpmgp.h.

int mgprol

Prolongation method [default = 0]

  • 0: trilinear
  • 1: operator-based
  • 2: mod. operator-based

Definition at line 156 of file vpmgp.h.

int mgsmoo

Smoothing method [default = 1]

  • 0: weighted jacobi
  • 1: gauss-seidel
  • 2: SOR
  • 3: richardson
  • 4: cghs

Definition at line 150 of file vpmgp.h.

int mgsolv

Coarse equation solve method [default = 1]

  • 0: cghs
  • 1: banded linpack

Definition at line 164 of file vpmgp.h.

int n_ipc

Integer info work array required storage

Definition at line 94 of file vpmgp.h.

int n_iz

Integer storage parameter (index max)

Definition at line 93 of file vpmgp.h.

int n_rpc

Real info work array required storage

Definition at line 92 of file vpmgp.h.

int narr

Array work storage

Definition at line 98 of file vpmgp.h.

int narrc

Size of vector on coarse level

Definition at line 91 of file vpmgp.h.

int nc

Number of coarse grid unknowns

Definition at line 90 of file vpmgp.h.

int nf

Number of fine grid unknowns

Definition at line 89 of file vpmgp.h.

int niwk

Integer work storage

Definition at line 97 of file vpmgp.h.

int nlev

Number of mesh levels [no default]

Definition at line 76 of file vpmgp.h.

int nonlin

Problem type [no default]

  • 0: linear
  • 1: nonlinear
  • 2: linear then nonlinear

Definition at line 80 of file vpmgp.h.

int nrwk

Real work storage

Definition at line 96 of file vpmgp.h.

int nu1

Number of pre-smoothings [default = 2]

Definition at line 148 of file vpmgp.h.

int nu2

Number of post-smoothings [default = 2]

Definition at line 149 of file vpmgp.h.

int nx

Grid x dimensions [no default]

Definition at line 73 of file vpmgp.h.

int nxc

Coarse level grid x dimensions

Definition at line 86 of file vpmgp.h.

int ny

Grid y dimensions [no default]

Definition at line 74 of file vpmgp.h.

int nyc

Coarse level grid y dimensions

Definition at line 87 of file vpmgp.h.

int nz

Grid z dimensions [no default]

Definition at line 75 of file vpmgp.h.

int nzc

Coarse level grid z dimensions

Definition at line 88 of file vpmgp.h.

double omegal

Linear relax parameter [default = 8e-1]

Definition at line 170 of file vpmgp.h.

double omegan

Nonlin relax parameter [default = 9e-1]

Definition at line 171 of file vpmgp.h.

double xcent

Grid x center [0]

Definition at line 108 of file vpmgp.h.

double xlen

Domain x length

Definition at line 179 of file vpmgp.h.

double xmax

Domain upper x corner

Definition at line 185 of file vpmgp.h.

double xmin

Domain lower x corner

Definition at line 182 of file vpmgp.h.

double ycent

Grid y center [0]

Definition at line 109 of file vpmgp.h.

double ylen

Domain y length

Definition at line 180 of file vpmgp.h.

double ymax

Domain upper y corner

Definition at line 186 of file vpmgp.h.

double ymin

Domain lower y corner

Definition at line 183 of file vpmgp.h.

double zcent

Grid z center [0]

Definition at line 110 of file vpmgp.h.

double zlen

Domain z length

Definition at line 181 of file vpmgp.h.

double zmax

Domain upper z corner

Definition at line 187 of file vpmgp.h.

double zmin

Domain lower z corner

Definition at line 184 of file vpmgp.h.


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