gridripper::amr1d::ParameterParser Class Reference

AMR 1D parameter parser. More...

#include <ParameterParser.h>

List of all members.

Public Member Functions
	ParameterParser (const GrrProperties &props)
	Creates a parameter parser using a property map.
void	parse () throw (InitCond::Exception&, IllegalArgumentException&, IOException&)
	Parses parameters.
GReal_t	getTmax () const throw (InitCond::Exception&)
	Returns the maximum time parameter for the simulation.
string	getTimeFormatString () const throw (InitCond::Exception&)
	Returns a format string suitable for printing the time coordinate.
PDE *	disownPDE ()
	Deny the ownership of the PDE object.
InitCond &	getInitCond () const
	Deny the ownership of the initial condition object.
Integrator *	disownIntegrator ()
	Deny the ownership of the time integrator.
AMError *	disownAMError ()
	Deny the ownership of the numerical error calculator.
Regridder *	disownRegridder ()
	Deny the ownership of the regridder.
Public Attributes
bool	debug
	Debug messages enabled.
bool	constraintForced
	Constraints equations enforced on each time slice.
string	dtdx
	Courant factor dt/dx.
int	maxi
	Maximum grid point index on base grid.
int	numPointsAboveMaxX
	Number of "non-physical" points above maximum x.
int	maxLevel
	The maximum refinement level.
int	refinementRatio
	The refinement ratio.
GReal_t	errorTolerance
	Error tolerance.
int	errorCheckFreq
	Error checking frequency.
int	regridFreq
	Regridding frequency.
int	bufferZoneSize
	Size of the buffer zone.
int	fileNo
int	maxBDataSize
string	dtwrite
	Inverse frequency of data writing.
string	tmax_str
	Simulation must stop at the specified time.
bool	endless
	Simulation never stops if enabled.
int	maxRuntime
int	blankLines
	Number of blank lines between two time slices in case of text output.
string	dataFormat
	Data line format string in case of text output.
string	energyFormatStr
	Energy format string in case of text output.
bool	energyWritten
	Energy is saved if true.
bool	writeIntq
	Write an intq file if enabled.
string	intqHeaderFormat
	Format string for the header of the intq file.
string	intqFormat
	Format string for the intq file.
bool	writeMarker
string	markerHeaderFormat
string	markerFormat
Protected Member Functions
string	getParameter (string key) const
	Gets a parameter.

---

Detailed Description

AMR 1D parameter parser.

Version:

0.5, 05/08/2009

Author:

Peter Csizmadia

---

Constructor & Destructor Documentation

gridripper::amr1d::ParameterParser::ParameterParser

(

const GrrProperties &

props

)

Creates a parameter parser using a property map.

Parameters:

props

the property map

---

Member Function Documentation

AMError* gridripper::amr1d::ParameterParser::disownAMError

(

)

Deny the ownership of the numerical error calculator.

Returns:

the numerical error calculator

Integrator* gridripper::amr1d::ParameterParser::disownIntegrator

(

)

Deny the ownership of the time integrator.

Returns:

the integrator

PDE* gridripper::amr1d::ParameterParser::disownPDE

(

)

Deny the ownership of the PDE object.

Returns:

the PDE

Regridder* gridripper::amr1d::ParameterParser::disownRegridder

(

)

Deny the ownership of the regridder.

Returns:

the regridder.

InitCond& gridripper::amr1d::ParameterParser::getInitCond

(

)

const

Deny the ownership of the initial condition object.

Returns:

the initial condition

string gridripper::amr1d::ParameterParser::getParameter

(

string

key

)

const [protected]

Gets a parameter.

Parameters:

key

the parameter name

string gridripper::amr1d::ParameterParser::getTimeFormatString

(

)

const throw (InitCond::Exception&)

Returns a format string suitable for printing the time coordinate.

Returns:

the format string

GReal_t gridripper::amr1d::ParameterParser::getTmax

(

)

const throw (InitCond::Exception&)

Returns the maximum time parameter for the simulation.

Returns:

the maximum time

---

Member Data Documentation

int gridripper::amr1d::ParameterParser::blankLines

Number of blank lines between two time slices in case of text output.

bool gridripper::amr1d::ParameterParser::constraintForced

Constraints equations enforced on each time slice.

string gridripper::amr1d::ParameterParser::dataFormat

Data line format string in case of text output.

bool gridripper::amr1d::ParameterParser::debug

Debug messages enabled.

string gridripper::amr1d::ParameterParser::dtdx

Courant factor dt/dx.

bool gridripper::amr1d::ParameterParser::endless

Simulation never stops if enabled.

string gridripper::amr1d::ParameterParser::energyFormatStr

Energy format string in case of text output.

bool gridripper::amr1d::ParameterParser::energyWritten

Energy is saved if true.

int gridripper::amr1d::ParameterParser::errorCheckFreq

Error checking frequency.

Numerical error is checked in every n-th step, where n is the specified value.

GReal_t gridripper::amr1d::ParameterParser::errorTolerance

Error tolerance.

A mesh point needs refinement if error is larger than this value.

string gridripper::amr1d::ParameterParser::intqFormat

Format string for the intq file.

string gridripper::amr1d::ParameterParser::intqHeaderFormat

Format string for the header of the intq file.

int gridripper::amr1d::ParameterParser::maxi

Maximum grid point index on base grid.

int gridripper::amr1d::ParameterParser::maxLevel

The maximum refinement level.

int gridripper::amr1d::ParameterParser::numPointsAboveMaxX

Number of "non-physical" points above maximum x.

int gridripper::amr1d::ParameterParser::refinementRatio

The refinement ratio.

int gridripper::amr1d::ParameterParser::regridFreq

Regridding frequency.

Regridding always perform in every n-th step (or earlier), where n is the specified value.

bool gridripper::amr1d::ParameterParser::writeIntq

Write an intq file if enabled.

---

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

• /home/laszloa/SVN/GR/gridripper/include/gridripper/amr1d/ParameterParser.h