APBS 3.0.0
Loading...
Searching...
No Matches
GEOFLOWparm class

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

Files

file  geoflowparm.c
 Class GEOFLOWparm methods.
 
file  geoflowparm.h
 Contains declarations for class GEOFLOWparm.
 

Data Structures

struct  sGEOFLOWparm
 Parameter structure for GEOFLOW-specific variables from input files. More...
 

Typedefs

typedef enum eGEOFLOWparm_CalcType GEOFLOWparm_CalcType
 Declare GEOFLOWparm_CalcType type.
 
typedef struct sGEOFLOWparm GEOFLOWparm
 Parameter structure for GEOFLOW-specific variables from input files.
 

Enumerations

enum  eGEOFLOWparm_CalcType { GFCT_AUTO =1 }
 Calculation type. More...
 

Functions

VEXTERNC GEOFLOWparmGEOFLOWparm_ctor (GEOFLOWparm_CalcType type)
 Construct GEOFLOWparm object.
 
VEXTERNC Vrc_Codes GEOFLOWparm_ctor2 (GEOFLOWparm *thee, GEOFLOWparm_CalcType type)
 FORTRAN stub to construct GEOFLOWparm object ?????????!!!!!!!
 
VEXTERNC void GEOFLOWparm_dtor (GEOFLOWparm **thee)
 Object destructor.
 
VEXTERNC void GEOFLOWparm_dtor2 (GEOFLOWparm *thee)
 FORTRAN stub for object destructor ?????????!!!!!!!!!!!!
 
VEXTERNC Vrc_Codes GEOFLOWparm_check (GEOFLOWparm *thee)
 Consistency check for parameter values stored in object.
 
VEXTERNC Vrc_Codes GEOFLOWparm_parseToken (GEOFLOWparm *thee, char tok[VMAX_BUFSIZE], Vio *sock)
 Parse an MG keyword from an input file.
 
VEXTERNC void GEOFLOWparm_copy (GEOFLOWparm *thee, GEOFLOWparm *parm)
 copy GEOFLOWparm object int thee.
 

Detailed Description

Parameter which holds useful parameters for GEOFLOWeric multigrid calculations.

Typedef Documentation

◆ GEOFLOWparm

typedef struct sGEOFLOWparm GEOFLOWparm

Parameter structure for GEOFLOW-specific variables from input files.

Author
Andrew Stevens, Kyle Monson
Note
If you add/delete/change something in this class, the member functions – especially GEOFLOWparm_copy – must be modified accordingly

◆ GEOFLOWparm_CalcType

Declare GEOFLOWparm_CalcType type.

Definition at line 88 of file geoflowparm.h.

Enumeration Type Documentation

◆ eGEOFLOWparm_CalcType

Calculation type.

Enumerator
GFCT_AUTO 

GEOFLOW-auto

Definition at line 77 of file geoflowparm.h.

Function Documentation

◆ GEOFLOWparm_check()

VEXTERNC Vrc_Codes GEOFLOWparm_check ( GEOFLOWparm * thee)

Consistency check for parameter values stored in object.

Author
Andrew Stevens, Kyle Monson
Parameters
theeGEOFLOWparm object
Returns
Success enumeration

Definition at line 101 of file geoflowparm.c.

◆ GEOFLOWparm_copy()

VEXTERNC void GEOFLOWparm_copy ( GEOFLOWparm * thee,
GEOFLOWparm * parm )

copy GEOFLOWparm object int thee.

Author
Parameters
theeGEOFLOWparm object to be copied into
parmGEOFLOWparm object.

Definition at line 127 of file geoflowparm.c.

◆ GEOFLOWparm_ctor()

VEXTERNC GEOFLOWparm * GEOFLOWparm_ctor ( GEOFLOWparm_CalcType type)

Construct GEOFLOWparm object.

Author
Andrew Stevens, Kyle Monson
Parameters
typeType of GEOFLOW calculation
Returns
Newly allocated and initialized GEOFLOWparm object

Definition at line 66 of file geoflowparm.c.

◆ GEOFLOWparm_ctor2()

VEXTERNC Vrc_Codes GEOFLOWparm_ctor2 ( GEOFLOWparm * thee,
GEOFLOWparm_CalcType type )

FORTRAN stub to construct GEOFLOWparm object ?????????!!!!!!!

Author
Andrew Stevens, Kyle Monson
Parameters
theeSpace for GEOFLOWparm object
typeType of MG calculation
Returns
Success enumeration

Definition at line 77 of file geoflowparm.c.

◆ GEOFLOWparm_dtor()

VEXTERNC void GEOFLOWparm_dtor ( GEOFLOWparm ** thee)

Object destructor.

Author
Andrew Stevens, Kyle Monson
Parameters
theePointer to memory location of GEOFLOWparm object

Definition at line 91 of file geoflowparm.c.

◆ GEOFLOWparm_dtor2()

VEXTERNC void GEOFLOWparm_dtor2 ( GEOFLOWparm * thee)

FORTRAN stub for object destructor ?????????!!!!!!!!!!!!

Author
Andrew Stevens, Kyle Monson
Parameters
theePointer to GEOFLOWparm object

Definition at line 99 of file geoflowparm.c.

◆ GEOFLOWparm_parseToken()

VEXTERNC Vrc_Codes GEOFLOWparm_parseToken ( GEOFLOWparm * thee,
char tok[VMAX_BUFSIZE],
Vio * sock )

Parse an MG keyword from an input file.

Author
Andrew Stevens, Kyle Monson
Parameters
theeGEOFLOWparm 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 212 of file geoflowparm.c.