APBS  1.5
FEMparm class

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

Files

file  femparm.c
 Class FEMparm methods.
 
file  femparm.h
 Contains declarations for class APOLparm.
 

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...
 

Detailed Description

Parameter structure for FEM-specific variables from input files.

Typedef Documentation

◆ FEMparm_EtolType

Declare FEparm_EtolType type.

Author
Nathan Baker

Definition at line 90 of file femparm.h.

Enumeration Type Documentation

◆ eFEMparm_CalcType

Calculation type.

Enumerator
FCT_MANUAL 

fe-manual

FCT_NONE 

unspecified

Definition at line 117 of file femparm.h.

◆ eFEMparm_EstType

Adaptive refinment error estimator method.

Note
Do not change these values; they correspond to settings in FEtk
Author
Nathan Baker
Enumerator
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

Definition at line 98 of file femparm.h.

◆ eFEMparm_EtolType

Adaptive refinment error estimate tolerance key.

Author
Nathan Baker
Enumerator
FET_SIMP 

per-simplex error tolerance

FET_GLOB 

global error tolerance

FET_FRAC 

fraction of simplices we want to have refined

Definition at line 79 of file femparm.h.

Function Documentation

◆ FEMparm_check()

VEXTERNC int FEMparm_check ( FEMparm thee)

Consistency check for parameter values stored in object.

Author
Nathan Baker
Parameters
theeFEMparm object
Returns
1 if OK, 0 otherwise

Definition at line 143 of file femparm.c.

◆ FEMparm_copy()

VEXTERNC void FEMparm_copy ( FEMparm thee,
FEMparm source 
)

Copy target object into thee.

Author
Nathan Baker
Parameters
theeDestination object
sourceSource object

Definition at line 100 of file femparm.c.

◆ FEMparm_ctor()

VEXTERNC FEMparm* FEMparm_ctor ( FEMparm_CalcType  type)

Construct FEMparm.

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

Definition at line 65 of file femparm.c.

◆ FEMparm_ctor2()

VEXTERNC int FEMparm_ctor2 ( FEMparm thee,
FEMparm_CalcType  type 
)

FORTRAN stub to construct FEMparm.

Author
Nathan Baker
Parameters
theePointer to allocated FEMparm object
typeFEM calculation type
Returns
1 if successful, 0 otherwise

Definition at line 76 of file femparm.c.

◆ FEMparm_dtor()

VEXTERNC void FEMparm_dtor ( FEMparm **  thee)

Object destructor.

Author
Nathan Baker
Parameters
theePointer to memory location of FEMparm object

Definition at line 133 of file femparm.c.

◆ FEMparm_dtor2()

VEXTERNC void FEMparm_dtor2 ( FEMparm thee)

FORTRAN stub for object destructor.

Author
Nathan Baker
Parameters
theePointer to FEMparm object

Definition at line 141 of file femparm.c.