Classes | Public Member Functions

gridripper::amr1d::InitCond Class Reference

Initial condition for a PDE. More...

#include <InitCond.h>

Inheritance diagram for gridripper::amr1d::InitCond:
gridripper::amr1d::FuncInitCond gridripper::amr1d::initcond::BData gridripper::amr1d::initcond::ODERelaxInit gridripper::amr1d::initcond::UserDef gridripper::amr1d::initcond::Zero gridripper::amr1d::initcond::ODEShootInit

List of all members.

Classes

class  Exception
 Exception thrown by InitCond::init. More...

Public Member Functions

virtual int init (tvalarray< tvector< Grid * > > &grids, PDE *pde, GReal_t dt, int r, int maxlevel, int bufzone, AMError *amerr, double maxerr)=0 throw (InitCond::Exception&)
 Creates and initializes base grid and initial subgrids.
virtual GReal_t getTime () const =0
 Gets the time parameter at the initialization.
virtual bool isOnInitialHypersurface () const
 Is the the initial condition applied on the initial hypersurface?
virtual bool isAppended (const string &fname) const
 Should the output be appended to an existing data file?
virtual string getMessage () const
 Gets information about initial condition generation.

Detailed Description

Initial condition for a PDE.

Version:
0.5, 04/24/2007
Author:
Peter Csizmadia

Member Function Documentation

virtual string gridripper::amr1d::InitCond::getMessage (  )  const [inline, virtual]

Gets information about initial condition generation.

Returns:
information message

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

virtual GReal_t gridripper::amr1d::InitCond::getTime (  )  const [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.

virtual int gridripper::amr1d::InitCond::init ( tvalarray< tvector< Grid * > > &  grids,
PDE pde,
GReal_t  dt,
int  r,
int  maxlevel,
int  bufzone,
AMError amerr,
double  maxerr 
) throw (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.

virtual bool gridripper::amr1d::InitCond::isAppended ( const string &  fname  )  const [inline, virtual]

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.

virtual bool gridripper::amr1d::InitCond::isOnInitialHypersurface (  )  const [inline, virtual]

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.


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