---

params class

Class that defines a parameters object, which handles user-input. More...

Files
file	params.h
	Data members and function declarations for class params.
Compounds
struct	params
	Class for input handling. More...
Defines
#define	_PARAMS_H_   1
	Environment variable for 'params.h'.
Functions
params *	params_ctor ()
	Constructor for the params object. More...
void	params_dtor (params *thee)
	Destructor for the params object. More...
void	params_read (params *thee, char *inputpath)
	Reads the input file "INPUT.IN" and assigns values to data members. More...

---

Detailed Description

Class that defines a parameters object, which handles user-input.

For features and limitations of the read routine either read the source code or consult the input file documentation

---

Function Documentation

params* params_ctor (    )

Constructor for the params object. Author: Andreas Vitalis Returns: Params object

void params_dtor (  params *    thee )

Destructor for the params object. Also frees memory allocated in 'params_read' Author: Andreas Vitalis Parameters: thee  Params object

void params_read (  params *    thee, char *    inputpath )

Reads the input file "INPUT.IN" and assigns values to data members. Allocates some more necessary memory Author: Andreas Vitalis Parameters: thee  Params object inputpath  Character string identifying the input file for the current run

---