gridripper::amr1d::InitCond Class Reference

Initial condition for a PDE. More...

Inheritance diagram for gridripper::amr1d::InitCond:

List of all members.

Public Member Functions
abstract int	init (Grid[][] grids, PDE pde, double dt, int r, int maxlevel, int bufzone, AMError amerr, double maxerr) throws InitCond.Exception
	Creates and initializes base grid and initial subgrids.
abstract double	getTime ()
	Gets the time parameter at the initialization.
boolean	isOnInitialHypersurface ()
	Is the the initial condition applied on the initial hypersurface?
boolean	isAppended (File f)
	Should the output be appended to an existing data file?
String	getMessage ()
	Gets information about initial condition generation.
Static Public Member Functions
static InitCond	create (String str, Parameters parameters, PDE pde) throws InitCond.Exception
	Creates an initial condition.
Classes
class	Exception
	Exception thrown by init.
interface	LightRays

---

Detailed Description

Initial condition for a PDE.

Version:

0.5, 05/08/2009

Author:

Peter Csizmadia

---

Member Function Documentation

abstract int gridripper::amr1d::InitCond::init	(	Grid	grids[][],
		PDE	pde,
		double	dt,
		int	r,
		int	maxlevel,
		int	bufzone,
		AMError	amerr,
		double	maxerr
	)			throws InitCond.Exception [pure virtual]

Creates and initializes base grid and initial subgrids.

Parameters:

	grids	array of all grids
	pde	the PDE
	dt	the time step
	r	refinement ratio
	maxlevel	maximum refinement level
	bufzone	buffer zone size
	amerr	error function
	maxerr	error tolerance

Returns:

the finest refinement level

Implemented in gridripper::amr1d::FuncInitCond, and gridripper::amr1d::initcond::BData.

abstract double gridripper::amr1d::InitCond::getTime

(

)

[pure virtual]

Gets the time parameter at the initialization.

Returns:

the time

Implemented in gridripper::amr1d::FuncInitCond, gridripper::amr1d::initcond::BData, and gridripper::amr1d::initcond::UserDef.

boolean gridripper::amr1d::InitCond::isOnInitialHypersurface

(

)

[inline]

Is the the initial condition applied on the initial hypersurface?

Returns:

true if it is applied on the initial hypersurface, false otherwise

Reimplemented in gridripper::amr1d::initcond::BData.

boolean gridripper::amr1d::InitCond::isAppended

(

File

f

)

[inline]

Should the output be appended to an existing data file?

Returns:

true if output should be appended, false if an existing data file can be overwritten

Reimplemented in gridripper::amr1d::initcond::BData.

String gridripper::amr1d::InitCond::getMessage

(

)

[inline]

Gets information about initial condition generation.

Returns:

information message

Reimplemented in gridripper::amr1d::initcond::ODERelaxInit, and gridripper::amr1d::initcond::ODEShootInit.

static InitCond gridripper::amr1d::InitCond::create	(	String	str,
		Parameters	parameters,
		PDE	pde
	)			throws InitCond.Exception [inline, static]

Creates an initial condition.

Parameters:

	str	the name and arguments
	parameters	the parameters
	pde	the PDE

Returns:

the initial condition

---

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

• gridripper/amr1d/InitCond.java