gridripper::amr1d::Sigma Class Reference

The sigma factor of the numerical dissipation term. More...

#include <Sigma.h>

Inheritance diagram for gridripper::amr1d::Sigma:

List of all members.

Public Member Functions
virtual GReal_t	getValue (GReal_t x, int ileft, int iright) const =0
	Gets the value of the numerical dissipation factor in the specified point.
virtual Sigma *	cloneSigma () const =0
	Clones the object.
virtual	~Sigma ()
	Added by Andras Laszlo to make the compiler happy:.
Static Public Member Functions
static Sigma *	create (const string &cmd, const Parameters &param, const PDE &pde) throw (IllegalArgumentException&)
	Instantiates a Sigma implementation.

---

Detailed Description

The sigma factor of the numerical dissipation term.

Version:

0.5, 02/18/2009

Since:

GridRipper 0.5, 05/15/2008

Author:

Peter Csizmadia

---

Member Function Documentation

virtual GReal_t gridripper::amr1d::Sigma::getValue	(	GReal_t	x,
		int	ileft,
		int	iright
	)			const [pure virtual]

Gets the value of the numerical dissipation factor in the specified point.

Parameters:

	x	the x coordinate
	ileft	point index relative to the left bound (positive or zero) if the current grid contains the left bound, numeric_limits<int>::max() otherwise.
	iright	point index relative to the right bound (negative or zero) if the current grid contains the right bound, numeric_limits<int>::min() otherwise

Implemented in gridripper::amr1d::sigma::ConstantSigma, gridripper::amr1d::sigma::LStepSigma, gridripper::amr1d::sigma::VanishingSigma, and gridripper::amr1d::sigma::VaryingSigma.

virtual Sigma* gridripper::amr1d::Sigma::cloneSigma

(

)

const [pure virtual]

Clones the object.

Returns:

the clone

Implemented in gridripper::amr1d::sigma::ConstantSigma, gridripper::amr1d::sigma::LStepSigma, gridripper::amr1d::sigma::VanishingSigma, and gridripper::amr1d::sigma::VaryingSigma.

static Sigma* gridripper::amr1d::Sigma::create	(	const string &	cmd,
		const Parameters &	param,
		const PDE &	pde
	)			throw (IllegalArgumentException&) [static]

Instantiates a Sigma implementation.

Parameters:

	cmd	the class name and arguments
	param	the parameters
	pde	the PDE

Returns:

the Sigma instance

---

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

• gridripper/amr1d/Sigma.h