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

Vmgrid class

Oracle for Cartesian mesh data. More...


Files

file  vmgrid.h
 Multiresolution oracle for Cartesian mesh data.


Data Structures

struct  sVmgrid
 Multiresoltion oracle for Cartesian mesh data. More...


Defines

#define VMGRIDMAX   20

Typedefs

typedef sVmgrid Vmgrid
 Declaration of the Vmgrid class as the Vgmrid structure.


Functions

Vmgrid * Vmgrid_ctor ()
 Construct Vmgrid object.

int Vmgrid_ctor2 (Vmgrid *thee)
 Initialize Vmgrid object.

int Vmgrid_value (Vmgrid *thee, double x[3], double *value)
 Get potential value (from mesh or approximation) at a point.

void Vmgrid_dtor (Vmgrid **thee)
 Object destructor.

void Vmgrid_dtor2 (Vmgrid *thee)
 FORTRAN stub object destructor.

int Vmgrid_addGrid (Vmgrid *thee, Vgrid *grid)
 Add a grid to the hierarchy.

int Vmgrid_curvature (Vmgrid *thee, double pt[3], int cflag, double *curv)
 Get second derivative values at a point.

int Vmgrid_gradient (Vmgrid *thee, double pt[3], double grad[3])
 Get first derivative values at a point.

VgridVmgrid_getGridByNum (Vmgrid *thee, int num)
 Get specific grid in hiearchy.

VgridVmgrid_getGridByPoint (Vmgrid *thee, double pt[3])
 Get grid in hiearchy which contains specified point or VNULL.


Detailed Description

Oracle for Cartesian mesh data.


Define Documentation

#define VMGRIDMAX   20
 

The maximum number of levels in the grid hiearchy


Function Documentation

int Vmgrid_addGrid Vmgrid   thee,
Vgrid   grid
 

Add a grid to the hierarchy.

Author:
Nathan Baker
Parameters:
thee  Pointer to object to be destroyed
grid  Grid to be added. As mentioned above, we would prefer to have the finest grid added first, next-finest second, ..., coarsest last -- this is how the grid will be searched when looking up values for points. However, this is not enforced to provide flexibility for cases where the dataset is decomposed into disjoint partitions, etc.
Returns:
1 if successful, 0 otherwise

Vmgrid* Vmgrid_ctor  
 

Construct Vmgrid object.

Author:
Nathan Baker
Returns:
Newly allocated and initialized Vmgrid object

int Vmgrid_ctor2 Vmgrid   thee
 

Initialize Vmgrid object.

Author:
Nathan Baker
Parameters:
thee  Newly allocated Vmgrid object
Returns:
Newly allocated and initialized Vmgrid object

int Vmgrid_curvature Vmgrid   thee,
double    pt[3],
int    cflag,
double *    curv
 

Get second derivative values at a point.

Author:
Nathan Baker (wrapper for Vgrid routine by Steve Bond)
Parameters:
thee  Pointer to Vmgrid object
pt  Location to evaluate second derivative
cflag 
  • 0: Reduced Maximal Curvature
  • 1: Mean Curvature (Laplace)
  • 2: Gauss Curvature
  • 3: True Maximal Curvature
curv  Specified curvature value
Returns:
1 if successful, 0 if off grid

void Vmgrid_dtor Vmgrid **    thee
 

Object destructor.

Author:
Nathan Baker
Parameters:
thee  Pointer to memory location of object to be destroyed

void Vmgrid_dtor2 Vmgrid   thee
 

FORTRAN stub object destructor.

Author:
Nathan Baker
Parameters:
thee  Pointer to object to be destroyed

Vgrid* Vmgrid_getGridByNum Vmgrid   thee,
int    num
 

Get specific grid in hiearchy.

Author:
Nathan Baker
Parameters:
thee  Pointer to Vmgrid object
num  Number of grid in hiearchy
Returns:
Pointer to specified grid

Vgrid* Vmgrid_getGridByPoint Vmgrid   thee,
double    pt[3]
 

Get grid in hiearchy which contains specified point or VNULL.

Author:
Nathan Baker
Parameters:
thee  Pointer to Vmgrid object
pt  Point to check
Returns:
Pointer to specified grid

int Vmgrid_gradient Vmgrid   thee,
double    pt[3],
double    grad[3]
 

Get first derivative values at a point.

Author:
Nathan Baker and Steve Bond
Parameters:
thee  Pointer to Vmgrid object
pt  Location to evaluate gradient
grad  Gradient
Returns:
1 if successful, 0 if off grid

int Vmgrid_value Vmgrid   thee,
double    x[3],
double *    value
 

Get potential value (from mesh or approximation) at a point.

Author:
Nathan Baker
Parameters:
thee  Vmgrid obejct
x  Point at which to evaluate potential
value  Value of data at point x
Returns:
1 if successful, 0 if off grid


Generated on Tue Feb 17 09:27:30 2004 for APBS by doxygen1.2.18