gridripper::amr1d::AutoAMRCore Class Reference

Automatic AMR integrator. More...

Inheritance diagram for gridripper::amr1d::AutoAMRCore:

List of all members.

Public Member Functions
	AutoAMRCore (PDE pde, InitCond ini, boolean constrforced, Integrator gi, Regridder regridder, String dtdx, int maxi, int npabovemax, int maxl, int r, AMError amerr, double maxerr, int errchkf, int regridf, int bufzoner, int fms, PlayTimer tmr, File f, int blines, String dtwrite, boolean endless, double tmax, String datafmt, String energyfmt, boolean enable) throws InitCond.Exception, IllegalArgumentException, OutFileExistsException
	Creates an integrator.
AMRCore	cloneAMRCore ()
	Clones this object.
final void	setInParallelMode (boolean v)
	In parallel mode, the integrator notifies the visualization thread and waits for it during calculation.
final boolean	areSubstepsMonitorable ()
final long	getCalcTime ()
final long	getWaitTime ()
final PrecalculatedSolution	getExactSolution ()
final void	setExactSolution (PrecalculatedSolution xsol)
boolean	isOutputAppended ()
boolean	isTimeSliceSaved (int tsc)
final void	monitor (int level, int sublevel, String msg)
	Wakes up another thread, suspends the integrator thread temporarily.
Protected Member Functions
void	coarseStepped (double t)
	This method is called immediately after each coarse time step on the base grid (before refined grid updates).
final boolean	isStepMonitored (int level, int sublevel)
	Checks if a step should be monitored or not.
boolean	isLastTime (Grid g)
	Tests whether the last time step is reached.
Classes
class	OutFileExistsException
	Thrown if the output file already exists. More...

---

Detailed Description

Automatic AMR integrator.

Version:

0.5, 02/27/2009

Author:

Peter Csizmadia

---

Constructor & Destructor Documentation

gridripper::amr1d::AutoAMRCore::AutoAMRCore	(	PDE	pde,
		InitCond	ini,
		boolean	constrforced,
		Integrator	gi,
		Regridder	regridder,
		String	dtdx,
		int	maxi,
		int	npabovemax,
		int	maxl,
		int	r,
		AMError	amerr,
		double	maxerr,
		int	errchkf,
		int	regridf,
		int	bufzoner,
		int	fms,
		PlayTimer	tmr,
		File	f,
		int	blines,
		String	dtwrite,
		boolean	endless,
		double	tmax,
		String	datafmt,
		String	energyfmt,
		boolean	enable
	)			throws InitCond.Exception, IllegalArgumentException, OutFileExistsException [inline]

Creates an integrator.

Parameters:

	pde	the partial differential equation to integrate
	ini	the initial conditions
	constrforced	whether to force constraints
	gi	the numerical integration method
	regridder	the regridder
	dtdx	dt/dx
	maxi	base grid size
	npabovemax	number of grid points above infinity (Xmax)
	maxl	maximum allowed refinement level
	r	refinement ratio
	amerr	the error calculation method
	maxerr	the critical error value or 0
	errchkf	error checking frequency
	regridf	regridding frequency
	bufzoner	radius of buffer zone
	fms	milliseconds between two frames
	tmr	timer
	f	the output file
	blines	number of blank lines to write between time slices in the output datafile, in case of text (non-binary) format
	dtwrite	time step for data file writing
	endless	endless
	tmax	the time at which simulation should stop
	datafmt	printf format string for t, x and grid function values
	energyfmt	printf format string for energy values
	enable	enable data file writing

---

Member Function Documentation

void gridripper::amr1d::AutoAMRCore::coarseStepped

(

double

t

)

[inline, protected]

This method is called immediately after each coarse time step on the base grid (before refined grid updates).

Parameters:

t

the mean time of the last time step

Reimplemented from gridripper::amr1d::AMRCore.

AMRCore gridripper::amr1d::AutoAMRCore::cloneAMRCore

(

)

[inline, virtual]

Clones this object.

Returns:

the clone

Implements gridripper::amr1d::AMRCore.

final void gridripper::amr1d::AutoAMRCore::setInParallelMode

(

boolean

v

)

[inline]

In parallel mode, the integrator notifies the visualization thread and waits for it during calculation.

Parameters:

v

true if there is a visualization thread, false otherwise

final boolean gridripper::amr1d::AutoAMRCore::isStepMonitored	(	int	level,
		int	sublevel
	)			[inline, protected, virtual]

Checks if a step should be monitored or not.

Parameters:

	level	the current level
	sublevel	the current sublevel

Returns:

true if the step should be monitored

Implements gridripper::amr1d::AMRCore.

boolean gridripper::amr1d::AutoAMRCore::isLastTime

(

Grid

g

)

[inline, protected, virtual]

Tests whether the last time step is reached.

Returns:

true if no more integration steps are needed, false if simulation should continue

Implements gridripper::amr1d::AMRCore.

final void gridripper::amr1d::AutoAMRCore::monitor	(	int	level,
		int	sublevel,
		String	msg
	)			[inline, virtual]

Wakes up another thread, suspends the integrator thread temporarily.

Also sets the current level and status message.

Parameters:

	level	the current level
	sublevel	the current sublevel
	msg	a message or null

Implements gridripper::amr1d::AMRCore.

---

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

• gridripper/amr1d/AutoAMRCore.java