Public Member Functions | Protected Member Functions

gridripper::amr1d::initcond::UserDef Class Reference

User defined initial condition. More...

#include <UserDef.h>

Inheritance diagram for gridripper::amr1d::initcond::UserDef:
gridripper::amr1d::FuncInitCond gridripper::amr1d::InitCond gridripper::amr1d::initcond::ODEShootInit

List of all members.

Public Member Functions

 UserDef (string &args, const Parameters *p, const PDE &pde) throw (InitCond::Exception&)
 Creates initial condition.
virtual GReal_t getTime () const
 Gets the time parameter at the initialization.

Protected Member Functions

void init (PDE *pde, GReal_t x, FieldWrapper &phi) throw (InitCond::Exception&)
 Initializes the grid at the specified point.

Detailed Description

User defined initial condition.

Version:
0.5, 02/27/2009
Since:
GridRipper 0.5, 11/29/2008
Author:
Peter Csizmadia

Constructor & Destructor Documentation

gridripper::amr1d::initcond::UserDef::UserDef ( string &  args,
const Parameters p,
const PDE pde 
) throw (InitCond::Exception&)

Creates initial condition.

Parameters:
args the arguments
p the parameters
pde the PDE

Member Function Documentation

virtual GReal_t gridripper::amr1d::initcond::UserDef::getTime (  )  const [inline, virtual]

Gets the time parameter at the initialization.

The default implementation returns 0.

Returns:
the time

Reimplemented from gridripper::amr1d::FuncInitCond.

void gridripper::amr1d::initcond::UserDef::init ( PDE pde,
GReal_t  x,
FieldWrapper phi 
) throw (InitCond::Exception&) [protected, virtual]

Initializes the grid at the specified point.

Parameters:
pde the PDE
x the x coordinate
phi output array for the field values

Implements gridripper::amr1d::FuncInitCond.

Reimplemented in gridripper::amr1d::initcond::ODEShootInit.


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