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

FEMparm class

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


Files

file  femparm.h
 Contains declarations for class FEMparm.


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_MAN = 0 }
 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.


Detailed Description

Parameter structure for FEM-specific variables from input files.


Typedef Documentation

typedef enum eFEMparm_EtolType FEMparm_EtolType
 

Declare FEparm_EtolType type.

Author:
Nathan Baker


Enumeration Type Documentation

enum eFEMparm_CalcType
 

Calculation type.

Enumeration values:
FCT_MAN  fe-manual

enum eFEMparm_EstType
 

Adaptive refinment error estimator method.

Note:
Do not change these values; they correspond to settings in FEtk
Author:
Nathan Baker
Enumeration values:
FRT_UNIF  Uniform refinement
FRT_GEOM  Geometry-based (i.e. surfaces and charges) refinement
FRT_RESI  Nonlinear residual estimate-based refinement
FRT_DUAL  Dual-solution weight nonlinear residual estimate-based refinement
FRT_LOCA  Local problem error estimate-based refinement

enum eFEMparm_EtolType
 

Adaptive refinment error estimate tolerance key.

Author:
Nathan Baker
Enumeration values:
FET_SIMP  per-simplex error tolerance
FET_GLOB  global error tolerance
FET_FRAC  fraction of simplices we want to have refined


Function Documentation

int FEMparm_check FEMparm thee  ) 
 

Consistency check for parameter values stored in object.

Author:
Nathan Baker
Parameters:
thee FEMparm object
Returns:
1 if OK, 0 otherwise

FEMparm* FEMparm_ctor FEMparm_CalcType  type  ) 
 

Construct FEMparm.

Author:
Nathan Baker
Parameters:
type FEM calculation type
Returns:
Newly allocated and initialized Vpmgp object

int FEMparm_ctor2 FEMparm thee,
FEMparm_CalcType  type
 

FORTRAN stub to construct FEMparm.

Author:
Nathan Baker
Parameters:
thee Pointer to allocated FEMparm object
type FEM calculation type
Returns:
1 if successful, 0 otherwise

void FEMparm_dtor FEMparm **  thee  ) 
 

Object destructor.

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

void FEMparm_dtor2 FEMparm thee  ) 
 

FORTRAN stub for object destructor.

Author:
Nathan Baker
Parameters:
thee Pointer to FEMparm object


Generated on Tue Dec 6 10:05:59 2005 for APBS by doxygen 1.3.5