APBS  1.5
BEMparm class

Parameter which holds useful parameters for generic multigrid calculations. More...

Files

file  bemparm.c
 Class BEMparm methods.
 

Data Structures

struct  sBEMparm
 Parameter structure for BEM-specific variables from input files. More...
 

Typedefs

typedef enum eBEMparm_CalcType BEMparm_CalcType
 Declare BEMparm_CalcType type.
 
typedef struct sBEMparm BEMparm
 Parameter structure for BEM-specific variables from input files. More...
 

Enumerations

enum  eBEMparm_CalcType { BCT_MANUAL =0, BCT_NONE =1 }
 Calculation type. More...
 

Functions

VEXTERNC BEMparmBEMparm_ctor (BEMparm_CalcType type)
 Construct BEMparm object. More...
 
VEXTERNC Vrc_Codes BEMparm_ctor2 (BEMparm *thee, BEMparm_CalcType type)
 FORTRAN stub to construct BEMparm object. More...
 
VEXTERNC void BEMparm_dtor (BEMparm **thee)
 Object destructor. More...
 
VEXTERNC void BEMparm_dtor2 (BEMparm *thee)
 FORTRAN stub for object destructor. More...
 
VEXTERNC Vrc_Codes BEMparm_check (BEMparm *thee)
 Consistency check for parameter values stored in object. More...
 
VEXTERNC Vrc_Codes BEMparm_parseToken (BEMparm *thee, char tok[VMAX_BUFSIZE], Vio *sock)
 Parse an MG keyword from an input file. More...
 

Detailed Description

Parameter which holds useful parameters for generic multigrid calculations.

Typedef Documentation

◆ BEMparm

typedef struct sBEMparm BEMparm

Parameter structure for BEM-specific variables from input files.

Author
Nathan Baker and Todd Dolinsky and Weihua Geng
Note
If you add/delete/change something in this class, the member functions – especially BEMparm_copy – must be modified accordingly

Enumeration Type Documentation

◆ eBEMparm_CalcType

Calculation type.

Enumerator
BCT_MANUAL 

bem-manual

BCT_NONE 

not defined

Definition at line 77 of file bemparm.h.

Function Documentation

◆ BEMparm_check()

VEXTERNC Vrc_Codes BEMparm_check ( BEMparm thee)

Consistency check for parameter values stored in object.

Author
Nathan Baker
Parameters
theeBEMparm object
Returns
Success enumeration

Definition at line 124 of file bemparm.c.

◆ BEMparm_ctor()

VEXTERNC BEMparm* BEMparm_ctor ( BEMparm_CalcType  type)

Construct BEMparm object.

Author
Nathan Baker
Parameters
typeType of BEM calculation
Returns
Newly allocated and initialized BEMparm object

Definition at line 66 of file bemparm.c.

◆ BEMparm_ctor2()

VEXTERNC Vrc_Codes BEMparm_ctor2 ( BEMparm thee,
BEMparm_CalcType  type 
)

FORTRAN stub to construct BEMparm object.

Author
Nathan Baker and Todd Dolinsky
Parameters
theeSpace for BEMparm object
typeType of MG calculation
Returns
Success enumeration

Definition at line 77 of file bemparm.c.

◆ BEMparm_dtor()

VEXTERNC void BEMparm_dtor ( BEMparm **  thee)

Object destructor.

Author
Nathan Baker
Parameters
theePointer to memory location of BEMparm object

Definition at line 114 of file bemparm.c.

◆ BEMparm_dtor2()

VEXTERNC void BEMparm_dtor2 ( BEMparm thee)

FORTRAN stub for object destructor.

Author
Nathan Baker
Parameters
theePointer to BEMparm object

Definition at line 122 of file bemparm.c.

◆ BEMparm_parseToken()

VEXTERNC Vrc_Codes BEMparm_parseToken ( BEMparm thee,
char  tok[VMAX_BUFSIZE],
Vio *  sock 
)

Parse an MG keyword from an input file.

Author
Nathan Baker and Todd Dolinsky
Parameters
theeBEMparm object
tokToken to parse
sockStream for more tokens
Returns
Success enumeration (1 if matched and assigned; -1 if matched, but there's some sort of error (i.e., too few args); 0 if not matched)

Definition at line 327 of file bemparm.c.