APBS  1.4.1
femparm.h File Reference

Contains declarations for class APOLparm. More...

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

Go to the source code of this file.

Data Structures

struct  sFEMparm
 Parameter structure for FEM-specific variables from input files. More...
 

Typedefs

typedef enum eFEMparm_EtolType FEMparm_EtolType
 Declare FEparm_EtolType type. More...
 
typedef enum eFEMparm_EstType FEMparm_EstType
 Declare FEMparm_EstType type.
 
typedef enum eFEMparm_CalcType FEMparm_CalcType
 Declare FEMparm_CalcType type.
 
typedef struct sFEMparm FEMparm
 Declaration of the FEMparm class as the FEMparm structure.
 

Enumerations

enum  eFEMparm_EtolType { FET_SIMP =0, FET_GLOB =1, FET_FRAC =2 }
 Adaptive refinment error estimate tolerance key. More...
 
enum  eFEMparm_EstType {
  FRT_UNIF =0, FRT_GEOM =1, FRT_RESI =2, FRT_DUAL =3,
  FRT_LOCA =4
}
 Adaptive refinment error estimator method. More...
 
enum  eFEMparm_CalcType { FCT_MANUAL, FCT_NONE }
 Calculation type. More...
 

Functions

VEXTERNC FEMparmFEMparm_ctor (FEMparm_CalcType type)
 Construct FEMparm. More...
 
VEXTERNC int FEMparm_ctor2 (FEMparm *thee, FEMparm_CalcType type)
 FORTRAN stub to construct FEMparm. More...
 
VEXTERNC void FEMparm_dtor (FEMparm **thee)
 Object destructor. More...
 
VEXTERNC void FEMparm_dtor2 (FEMparm *thee)
 FORTRAN stub for object destructor. More...
 
VEXTERNC int FEMparm_check (FEMparm *thee)
 Consistency check for parameter values stored in object. More...
 
VEXTERNC void FEMparm_copy (FEMparm *thee, FEMparm *source)
 Copy target object into thee. More...
 
VEXTERNC Vrc_Codes FEMparm_parseToken (FEMparm *thee, char tok[VMAX_BUFSIZE], Vio *sock)
 Parse an MG keyword from an input file. More...
 

Detailed Description

Contains declarations for class APOLparm.

Contains declarations for class FEMparm.

Version
$Id$
Author
Nathan A. Baker
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-2012 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 femparm.h.