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

femparm.h File Reference

Contains declarations for class APOLparm. More...

#include "maloc/maloc.h"
#include "apbs/vhal.h"
#include "apbs/vstring.h"

Include dependency graph for femparm.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

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.

typedef enum eFEMparm_EstType FEMparm_EstType
 Declare FEMparm_EstType type.

typedef enum eFEMparm_CalcType FEMparm_CalcType
 Declare FEMparm_CalcType type.

typedef 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

FEMparmFEMparm_ctor (FEMparm_CalcType type)
 Construct FEMparm.

int FEMparm_ctor2 (FEMparm *thee, FEMparm_CalcType type)
 FORTRAN stub to construct FEMparm.

void FEMparm_dtor (FEMparm **thee)
 Object destructor.

void FEMparm_dtor2 (FEMparm *thee)
 FORTRAN stub for object destructor.

int FEMparm_check (FEMparm *thee)
 Consistency check for parameter values stored in object.

void FEMparm_copy (FEMparm *thee, FEMparm *source)
 Copy target object into thee.

int FEMparm_parseToken (FEMparm *thee, char tok[VMAX_BUFSIZE], Vio *sock)
 Parse an MG keyword from an input file.


Detailed Description

Contains declarations for class APOLparm.

Version:
Id
femparm.h 907 2006-07-27 20:36:20Z sobolevnrm
Author:
Nathan A. Baker
Attention:
 *
 * APBS -- Adaptive Poisson-Boltzmann Solver
 *
 * Nathan A. Baker (baker@biochem.wustl.edu)
 * Dept. of Biochemistry and Molecular Biophysics
 * Center for Computational Biology
 * Washington University in St. Louis
 *
 * Additional contributing authors listed in the code documentation.
 *
 * Copyright (c) 2002-2007.  Washington University in St. Louis.
 * All Rights Reserved.
 * Portions Copyright (c) 1999-2002.  The Regents of the University of
 * California.  
 * Portions Copyright (c) 1995.  Michael Holst.
 *
 * This file is part of APBS.
 *
 * APBS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * APBS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with APBS; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 * Linking APBS statically or dynamically with other modules is making a
 * combined work based on APBS. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 * 
 * SPECIAL GPL EXCEPTION
 * In addition, as a special exception, the copyright holders of APBS
 * give you permission to combine the APBS program with free software
 * programs and libraries that are released under the GNU LGPL or with
 * code included in releases of ISIM, Ion Simulator Interface, PMV, PyMOL
 * SMOL, VMD, and Vision. Such combined software may be linked with APBS and 
 * redistributed together in original or modified form as mere aggregation
 * without requirement that the entire work be under the scope of the GNU 
 * General Public License. This special exception permission is also extended
 * to any software listed in the SPECIAL GPL EXCEPTION clauses by the PMG,
 * FEtk, MC, or MALOC libraries.
 * 
 * Note that people who make modified versions of APBS are not obligated
 * to grant this special exception for their modified versions; it is
 * their choice whether to do so. The GNU General Public License gives
 * permission to release a modified version without this exception; this
 * exception also makes it possible to release a modified version which
 * carries forward this exception.
 *
 * 

Generated on Thu Jul 12 11:49:50 2007 for APBS by doxygen 1.3.4