APBS  1.5
sVpmgp Struct Reference

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

#include </builddir/build/BUILD/apbs-pdb2pqr-apbs-1.5/apbs/src/mg/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
 
size_t 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 80 of file vpmgp.h.

Field Documentation

◆ bcfl

Vbcfl bcfl

Boundary condition method [default = BCFL_SDH]

Definition at line 135 of file vpmgp.h.

◆ errtol

double errtol

Desired error tolerance [default = 1e-9]

Definition at line 121 of file vpmgp.h.

◆ hx

double hx

Grid x spacings [no default]

Definition at line 87 of file vpmgp.h.

◆ hy

double hy

Grid y spacings [no default]

Definition at line 88 of file vpmgp.h.

◆ hzed

double hzed

Grid z spacings [no default]

Definition at line 89 of file vpmgp.h.

◆ iinfo

int iinfo

Runtime status messages [default = 1]

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

Definition at line 130 of file vpmgp.h.

◆ ipcon

int ipcon

Preconditioning method [default = 3]

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

Definition at line 183 of file vpmgp.h.

◆ iperf

int iperf

Analysis of the operator [default = 0]

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

Definition at line 139 of file vpmgp.h.

◆ ipkey

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 109 of file vpmgp.h.

◆ irite

int irite

FORTRAN output unit [default = 8]

Definition at line 182 of file vpmgp.h.

◆ istop

int istop

Stopping criterion [default = 1]

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

Definition at line 123 of file vpmgp.h.

◆ itmax

int itmax

Maximum number of iters [default = 100]

Definition at line 122 of file vpmgp.h.

◆ key

int key

Print solution to file [default = 0]

  • 0: no
  • 1: yes

Definition at line 136 of file vpmgp.h.

◆ meth

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 144 of file vpmgp.h.

◆ mgcoar

int mgcoar

Coarsening method [default = 2]

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

Definition at line 170 of file vpmgp.h.

◆ mgdisc

int mgdisc

Discretization method [default = 0]

  • 0: finite volume
  • 1: finite element

Definition at line 177 of file vpmgp.h.

◆ mgkey

int mgkey

Multigrid method [default = 0]

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

Definition at line 155 of file vpmgp.h.

◆ mgprol

int mgprol

Prolongation method [default = 0]

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

Definition at line 166 of file vpmgp.h.

◆ mgsmoo

int mgsmoo

Smoothing method [default = 1]

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

Definition at line 160 of file vpmgp.h.

◆ mgsolv

int mgsolv

Coarse equation solve method [default = 1]

  • 0: cghs
  • 1: banded linpack

Definition at line 174 of file vpmgp.h.

◆ n_ipc

int n_ipc

Integer info work array required storage

Definition at line 104 of file vpmgp.h.

◆ n_iz

int n_iz

Integer storage parameter (index max)

Definition at line 103 of file vpmgp.h.

◆ n_rpc

int n_rpc

Real info work array required storage

Definition at line 102 of file vpmgp.h.

◆ narr

int narr

Array work storage

Definition at line 108 of file vpmgp.h.

◆ narrc

int narrc

Size of vector on coarse level

Definition at line 101 of file vpmgp.h.

◆ nc

int nc

Number of coarse grid unknowns

Definition at line 100 of file vpmgp.h.

◆ nf

int nf

Number of fine grid unknowns

Definition at line 99 of file vpmgp.h.

◆ niwk

int niwk

Integer work storage

Definition at line 107 of file vpmgp.h.

◆ nlev

int nlev

Number of mesh levels [no default]

Definition at line 86 of file vpmgp.h.

◆ nonlin

int nonlin

Problem type [no default]

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

Definition at line 90 of file vpmgp.h.

◆ nrwk

size_t nrwk

Real work storage

Definition at line 106 of file vpmgp.h.

◆ nu1

int nu1

Number of pre-smoothings [default = 2]

Definition at line 158 of file vpmgp.h.

◆ nu2

int nu2

Number of post-smoothings [default = 2]

Definition at line 159 of file vpmgp.h.

◆ nx

int nx

Grid x dimensions [no default]

Definition at line 83 of file vpmgp.h.

◆ nxc

int nxc

Coarse level grid x dimensions

Definition at line 96 of file vpmgp.h.

◆ ny

int ny

Grid y dimensions [no default]

Definition at line 84 of file vpmgp.h.

◆ nyc

int nyc

Coarse level grid y dimensions

Definition at line 97 of file vpmgp.h.

◆ nz

int nz

Grid z dimensions [no default]

Definition at line 85 of file vpmgp.h.

◆ nzc

int nzc

Coarse level grid z dimensions

Definition at line 98 of file vpmgp.h.

◆ omegal

double omegal

Linear relax parameter [default = 8e-1]

Definition at line 180 of file vpmgp.h.

◆ omegan

double omegan

Nonlin relax parameter [default = 9e-1]

Definition at line 181 of file vpmgp.h.

◆ xcent

double xcent

Grid x center [0]

Definition at line 118 of file vpmgp.h.

◆ xlen

double xlen

Domain x length

Definition at line 189 of file vpmgp.h.

◆ xmax

double xmax

Domain upper x corner

Definition at line 195 of file vpmgp.h.

◆ xmin

double xmin

Domain lower x corner

Definition at line 192 of file vpmgp.h.

◆ ycent

double ycent

Grid y center [0]

Definition at line 119 of file vpmgp.h.

◆ ylen

double ylen

Domain y length

Definition at line 190 of file vpmgp.h.

◆ ymax

double ymax

Domain upper y corner

Definition at line 196 of file vpmgp.h.

◆ ymin

double ymin

Domain lower y corner

Definition at line 193 of file vpmgp.h.

◆ zcent

double zcent

Grid z center [0]

Definition at line 120 of file vpmgp.h.

◆ zlen

double zlen

Domain z length

Definition at line 191 of file vpmgp.h.

◆ zmax

double zmax

Domain upper z corner

Definition at line 197 of file vpmgp.h.

◆ zmin

double zmin

Domain lower z corner

Definition at line 194 of file vpmgp.h.


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