APBS 3.0.0
vmgrid.h File Reference

Multiresolution oracle for Cartesian mesh data. More...

#include "apbscfg.h"
#include "maloc/maloc.h"
#include "generic/vhal.h"
#include "mg/vgrid.h"
Include dependency graph for vmgrid.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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

Macros

#define VMGRIDMAX   20
 The maximum number of levels in the grid hiearchy. More...
 

Typedefs

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

Functions

VEXTERNC VmgridVmgrid_ctor ()
 Construct Vmgrid object. More...
 
VEXTERNC int Vmgrid_ctor2 (Vmgrid *thee)
 Initialize Vmgrid object. More...
 
VEXTERNC int Vmgrid_value (Vmgrid *thee, double x[3], double *value)
 Get potential value (from mesh or approximation) at a point. More...
 
VEXTERNC void Vmgrid_dtor (Vmgrid **thee)
 Object destructor. More...
 
VEXTERNC void Vmgrid_dtor2 (Vmgrid *thee)
 FORTRAN stub object destructor. More...
 
VEXTERNC int Vmgrid_addGrid (Vmgrid *thee, Vgrid *grid)
 Add a grid to the hierarchy. More...
 
VEXTERNC int Vmgrid_curvature (Vmgrid *thee, double pt[3], int cflag, double *curv)
 Get second derivative values at a point. More...
 
VEXTERNC int Vmgrid_gradient (Vmgrid *thee, double pt[3], double grad[3])
 Get first derivative values at a point. More...
 
VEXTERNC VgridVmgrid_getGridByNum (Vmgrid *thee, int num)
 Get specific grid in hiearchy. More...
 
VEXTERNC VgridVmgrid_getGridByPoint (Vmgrid *thee, double pt[3])
 Get grid in hiearchy which contains specified point or VNULL. More...
 

Detailed Description

Multiresolution oracle for Cartesian mesh data.

Author
Nathan Baker
Version
$Id$
Attention
*
* APBS -- Adaptive Poisson-Boltzmann Solver
*
*  Nathan A. Baker (nathan.baker@pnnl.gov)
*  Pacific Northwest National Laboratory
*
*  Additional contributing authors listed in the code documentation.
*
* Copyright (c) 2010-2020 Battelle Memorial Institute. Developed at the
* Pacific Northwest National Laboratory, operated by Battelle Memorial
* Institute, Pacific Northwest Division for the U.S. Department of Energy.
*
* Portions Copyright (c) 2002-2010, Washington University in St. Louis.
* Portions Copyright (c) 2002-2010, Nathan A. Baker.
* Portions Copyright (c) 1999-2002, The Regents of the University of
* California.
* Portions Copyright (c) 1995, Michael Holst.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the developer nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*
* 

Definition in file vmgrid.h.