gridripper::Parameters Class Reference

Set of common parameters for initial conditions and PDEs. More...

#include <Parameters.h>

List of all members.

Public Member Functions
	Parameters ()
	Creates an empty parameter collection.
	Parameters (const GrrProperties &props) throw (IllegalArgumentException&)
	Creates parameter collection from the specified property map.
	Parameters (const Parameters &p)
	Copy constructor.
Parameters &	operator= (const Parameters &p)
	Assignment.
const ParameterPreprocessor *	getPreprocessor () const
	Gets the parameter preprocessor.
void	setPreprocessor (ParameterPreprocessor *p)
	Sets the parameter preprocessor.
bool	isSet (const string &name) const
	Tests whether a parameter is set.
GReal_t	getReal (const string &name) const throw (IllegalArgumentException&)
	Gets a real valued parameter.
void	setReal (const string &name, GReal_t v)
	Sets a real valued parameter.
int	getInt (const string &name) const throw (IllegalArgumentException&)
	Gets an integer valued parameter.
void	setInt (const string &name, int v)
	Sets an integer valued parameter.
tvector< int >	getIntArray (const string &name) const throw (IllegalArgumentException&)
	Gets an integer array valued parameter.
void	setIntArray (const string &name, const tvector< int > &arr)
	Sets an integer array valued parameter.
string	getString (const string &name) const throw (IllegalArgumentException&)
	Gets a string valued parameter.
void	setString (const string &name, const string &v)
	Sets a string valued parameter.
tvector< string >	getParameterNames () const
	Gets the list of parameter names.
const GrrProperties &	getGrrProperties () const
	Gets the property map from which this parameter map is created.
FnCollection *	createFnCollection (const string &xname) const throw (IllegalArgumentException&)
	Creates a collection of constants and dependent variables.

---

Detailed Description

Set of common parameters for initial conditions and PDEs.

Version:

0.5, 12/24/2008

Since:

12/17/2004

Author:

Peter Csizmadia

---

Constructor & Destructor Documentation

gridripper::Parameters::Parameters

(

const GrrProperties &

props

)

throw (IllegalArgumentException&)

Creates parameter collection from the specified property map.

Parameters:

props

the property map

---

Member Function Documentation

const ParameterPreprocessor* gridripper::Parameters::getPreprocessor

(

)

const [inline]

Gets the parameter preprocessor.

Returns:

the parameter preprocessor

void gridripper::Parameters::setPreprocessor

(

ParameterPreprocessor *

p

)

[inline]

Sets the parameter preprocessor.

Parameters:

p

the parameter preprocessor

bool gridripper::Parameters::isSet

(

const string &

name

)

const [inline]

Tests whether a parameter is set.

Parameters:

name

the parameter name

Returns:

true if set, false otherwise

GReal_t gridripper::Parameters::getReal

(

const string &

name

)

const throw (IllegalArgumentException&)

Gets a real valued parameter.

Parameters:

name

the parameter name

Returns:

the value

void gridripper::Parameters::setReal	(	const string &	name,
		GReal_t	v
	)

Sets a real valued parameter.

Parameters:

	name	the parameter name
	v	the value

int gridripper::Parameters::getInt

(

const string &

name

)

const throw (IllegalArgumentException&)

Gets an integer valued parameter.

Parameters:

name

the parameter name

Returns:

the value

void gridripper::Parameters::setInt	(	const string &	name,
		int	v
	)

Sets an integer valued parameter.

Parameters:

	name	the parameter name
	v	the value

tvector<int> gridripper::Parameters::getIntArray

(

const string &

name

)

const throw (IllegalArgumentException&)

Gets an integer array valued parameter.

Parameters:

name

the parameter name

Returns:

the array

void gridripper::Parameters::setIntArray	(	const string &	name,
		const tvector< int > &	arr
	)

Sets an integer array valued parameter.

Parameters:

	name	the parameter name
	arr	the array

string gridripper::Parameters::getString

(

const string &

name

)

const throw (IllegalArgumentException&)

Gets a string valued parameter.

Parameters:

name

the parameter name

Returns:

the string

void gridripper::Parameters::setString	(	const string &	name,
		const string &	v
	)

Sets a string valued parameter.

Parameters:

	name	the parameter name
	v	the string

tvector<string> gridripper::Parameters::getParameterNames

(

)

const

Gets the list of parameter names.

Returns:

the list of parameter names

const GrrProperties& gridripper::Parameters::getGrrProperties

(

)

const [inline]

Gets the property map from which this parameter map is created.

Returns:

the property map

FnCollection* gridripper::Parameters::createFnCollection

(

const string &

xname

)

const throw (IllegalArgumentException&)

Creates a collection of constants and dependent variables.

Parameters:

xname

name of the independent variable

Returns:

collection of constants and dependent variables

---

The documentation for this class was generated from the following file:

• gridripper/Parameters.h