gridripper::Parameters Class Reference

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

Inherits java::io::Serializable.

List of all members.

Public Member Functions
	Parameters ()
	Creates an empty parameter collection.
	Parameters (GrrProperties props, String path) throws IllegalArgumentException
	Creates parameter collection from the specified property map.
ParameterPreprocessor	getPreprocessor ()
	Gets the parameter preprocessor.
boolean	isSet (String name)
	Tests whether a parameter is set.
double	getFloat (String name) throws IllegalArgumentException
	Gets a real valued parameter.
void	setFloat (String s, double v)
	Sets a real valued parameter.
int	getInt (String name) throws IllegalArgumentException
	Gets an integer valued parameter.
void	setInt (String name, int v)
	Sets an integer valued parameter.
int[]	getIntArray (String name)
	Gets an integer array valued parameter.
void	setIntArray (String name, int[] arr)
	Sets an integer array valued parameter.
String	getString (String name) throws IllegalArgumentException
	Gets a string valued parameter.
void	setString (String name, String v)
	Sets a string valued parameter.
String[]	getParameterNames ()
	Gets the list of parameter names.
GrrProperties	getGrrProperties ()
	Gets the property map from which this parameter map is created.
FnCollection	createFnCollection (String xname)
	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	(	GrrProperties	props,
		String	path
	)			throws IllegalArgumentException [inline]

Creates parameter collection from the specified property map.

Parameters:

	props	the property map
	path	the package name(s) under which the ParameterPreprocessor implementations is searched

---

Member Function Documentation

ParameterPreprocessor gridripper::Parameters::getPreprocessor

(

)

[inline]

Gets the parameter preprocessor.

Returns:

the parameter preprocessor

boolean gridripper::Parameters::isSet

(

String

name

)

[inline]

Tests whether a parameter is set.

Parameters:

name

the parameter name

Returns:

true if set, false otherwise

double gridripper::Parameters::getFloat

(

String

name

)

throws IllegalArgumentException [inline]

Gets a real valued parameter.

Parameters:

name

the parameter name

Returns:

the value

void gridripper::Parameters::setFloat	(	String	s,
		double	v
	)			[inline]

Sets a real valued parameter.

Parameters:

	name	the parameter name
	v	the value

int gridripper::Parameters::getInt

(

String

name

)

throws IllegalArgumentException [inline]

Gets an integer valued parameter.

Parameters:

name

the parameter name

Returns:

the value

void gridripper::Parameters::setInt	(	String	name,
		int	v
	)			[inline]

Sets an integer valued parameter.

Parameters:

	name	the parameter name
	v	the value

int [] gridripper::Parameters::getIntArray

(

String

name

)

[inline]

Gets an integer array valued parameter.

Parameters:

name

the parameter name

Returns:

the array

void gridripper::Parameters::setIntArray	(	String	name,
		int[]	arr
	)			[inline]

Sets an integer array valued parameter.

Parameters:

	name	the parameter name
	arr	the array

String gridripper::Parameters::getString

(

String

name

)

throws IllegalArgumentException [inline]

Gets a string valued parameter.

Parameters:

name

the parameter name

Returns:

the string

void gridripper::Parameters::setString	(	String	name,
		String	v
	)			[inline]

Sets a string valued parameter.

Parameters:

	name	the parameter name
	v	the string

String [] gridripper::Parameters::getParameterNames

(

)

[inline]

Gets the list of parameter names.

Returns:

the list of parameter names

GrrProperties gridripper::Parameters::getGrrProperties

(

)

[inline]

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

Returns:

the property map

FnCollection gridripper::Parameters::createFnCollection

(

String

xname

)

[inline]

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.java