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.

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

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

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

BEMparm_CalcType

typedef enum eBEMparm_CalcType BEMparm_CalcType

Declare BEMparm_CalcType type.

Definition at line 86 of file bemparm.h.

Enumeration Type Documentation

eBEMparm_CalcType

enum 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

thee	BEMparm 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

type	Type 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

thee	Space for BEMparm object
type	Type 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

thee	Pointer 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

thee	Pointer 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

thee	BEMparm object
tok	Token to parse
sock	Stream 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 332 of file bemparm.c.