gridripper::odesolver::relax::ODERelax Class Reference

Solution of ODEs with relaxation method. More...

List of all members.

Public Member Functions
	ODERelax (Properties props) throws RelaxationException
	Constructs the ODE solver.
	ODERelax (Properties props, int maxi) throws RelaxationException
	Constructs the ODE solver.
	ODERelax (ODE ode, double[] data, int order) throws RelaxationException
	Constructs the ODE solver.
ODE	getODE ()
	Gets the ODE.
int	getMaxI ()
	Gets the grid size.
String	getDataFormat ()
	Gets the output data format.
double	getRelativeError ()
	Gets the relative error of the solution after the final iteration.
int	getNumIterations ()
	Gets the number of iterations.
void	setNumIterations (int n)
	Sets the number of iterations.
double[]	solve () throws RelaxationException
	Solves the system of equation.
double	nextIteration () throws RelaxationException
	Performs the next iteration.
double[]	getFieldValues ()
	Gets the current vector of field values.
Classes
class	Method
	Abstract class of relaxation method matrix initializers.
class	RelaxationException
	Relaxation error.

---

Detailed Description

Solution of ODEs with relaxation method.

Version:

0.5, 06/22/2008

Since:

GridRipper 0.4, 09/17/2006

Author:

Peter Csizmadia

---

Constructor & Destructor Documentation

gridripper::odesolver::relax::ODERelax::ODERelax

(

Properties

props

)

throws RelaxationException [inline]

Constructs the ODE solver.

Parameters:

props

properties

gridripper::odesolver::relax::ODERelax::ODERelax	(	Properties	props,
		int	maxi
	)			throws RelaxationException [inline]

Constructs the ODE solver.

Parameters:

props

properties

gridripper::odesolver::relax::ODERelax::ODERelax	(	ODE	ode,
		double[]	data,
		int	order
	)			throws RelaxationException [inline]

Constructs the ODE solver.

Parameters:

	ode	the ODE
	data	the field values
	order	discretization order (2 or 4)

---

Member Function Documentation

ODE gridripper::odesolver::relax::ODERelax::getODE

(

)

[inline]

Gets the ODE.

Returns:

the ODE

int gridripper::odesolver::relax::ODERelax::getMaxI

(

)

[inline]

Gets the grid size.

Returns:

the number of points minus 1.

String gridripper::odesolver::relax::ODERelax::getDataFormat

(

)

[inline]

Gets the output data format.

Returns:

the format string

double gridripper::odesolver::relax::ODERelax::getRelativeError

(

)

[inline]

Gets the relative error of the solution after the final iteration.

Returns:

the relative error

int gridripper::odesolver::relax::ODERelax::getNumIterations

(

)

[inline]

Gets the number of iterations.

Returns:

the number of iterations

void gridripper::odesolver::relax::ODERelax::setNumIterations

(

int

n

)

[inline]

Sets the number of iterations.

Parameters:

n

number of iterations or -1 to stop only when the relative error cannot be decreased further

double [] gridripper::odesolver::relax::ODERelax::solve

(

)

throws RelaxationException [inline]

Solves the system of equation.

Returns:

the solution vector

double gridripper::odesolver::relax::ODERelax::nextIteration

(

)

throws RelaxationException [inline]

Performs the next iteration.

Called by solve.

Returns:

the relative error

double [] gridripper::odesolver::relax::ODERelax::getFieldValues

(

)

[inline]

Gets the current vector of field values.

Returns:

the vector of field values

---

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

• gridripper/odesolver/relax/ODERelax.java