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.
PDEdisownPDE ()
 Deny the ownership of the PDE object.
InitCondgetInitCond () const
 Deny the ownership of the initial condition object.
IntegratordisownIntegrator ()
 Deny the ownership of the time integrator.
AMErrordisownAMError ()
 Deny the ownership of the numerical error calculator.
RegridderdisownRegridder ()
 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

GReal_t gridripper::amr1d::ParameterParser::getTmax (  )  const throw (InitCond::Exception&)

Returns the maximum time parameter for the simulation.

Returns:
the maximum time

string gridripper::amr1d::ParameterParser::getTimeFormatString (  )  const throw (InitCond::Exception&)

Returns a format string suitable for printing the time coordinate.

Returns:
the format string

PDE* gridripper::amr1d::ParameterParser::disownPDE (  ) 

Deny the ownership of the PDE object.

Returns:
the PDE

InitCond& gridripper::amr1d::ParameterParser::getInitCond (  )  const

Deny the ownership of the initial condition object.

Returns:
the initial condition

Integrator* gridripper::amr1d::ParameterParser::disownIntegrator (  ) 

Deny the ownership of the time integrator.

Returns:
the integrator

AMError* gridripper::amr1d::ParameterParser::disownAMError (  ) 

Deny the ownership of the numerical error calculator.

Returns:
the numerical error calculator

Regridder* gridripper::amr1d::ParameterParser::disownRegridder (  ) 

Deny the ownership of the regridder.

Returns:
the regridder.

string gridripper::amr1d::ParameterParser::getParameter ( string  key  )  const [protected]

Gets a parameter.

Parameters:
key the parameter name


Member Data Documentation

Debug messages enabled.

Constraints equations enforced on each time slice.

Courant factor dt/dx.

Maximum grid point index on base grid.

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

The maximum refinement level.

The refinement ratio.

Error tolerance.

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

Error checking frequency.

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

Regridding frequency.

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

Simulation never stops if enabled.

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

Data line format string in case of text output.

Energy format string in case of text output.

Energy is saved if true.

Write an intq file if enabled.

Format string for the header of the intq file.

Format string for the intq file.


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

Generated on Wed Jun 17 18:46:52 2009 for GridRipper by  doxygen 1.5.6