WmICFunction_Pulses_Fluid13 Class Reference

#include <wmicfunction_pulses_fluid13.h>

Inheritance diagram for WmICFunction_Pulses_Fluid13:

Public Member Functions
	WmICFunction_Pulses_Fluid13 ()
	Create new WmICFunction_Pulses_Fluid13.
	~WmICFunction_Pulses_Fluid13 ()
	Destroy WmICFunction_Pulses_Fluid13.
void	setup (const WxCryptSet &wxc)
	Setup WmICFunction_Pulses_Fluid13 object using supplied cryptset.
void	applyFunction (const real *position, real *value) const
	Evaluate the function at a position and return the result through a pointer.
Public Member Functions inherited from WmICFunction
	WmICFunction ()
	Create new WmICFunction.
virtual	~WmICFunction ()
	Destroy WmICFunction.
virtual void	setup (const WxCryptSet &wxc)
	Setup WmICFunction object using supplied cryptset.
const std::string &	getName () const
	Get name of this function.
int	getNumArguments () const
	Get number of arguments returned by this icFunction.
template<typename T >
void	apply (const real position[3], T *value) const
	Evaluate the function at a position and return the result through a pointer position and value must be double precision.

Protected Member Functions
bool	isInPulse (const real &r, const real *xc, const real *x) const
real	gaussianPulse (const real &r, const real *xc, const real *x) const
virtual void	applyFunction (const real *position, real *value) const =0
	This is the currently apply function call - recasts to real.

Protected Attributes
real	_mass
real	_n0
real	_temperature
real	_jump
Protected Attributes inherited from WmICFunction
std::string	_name
int	_numArgs
real *	_rvalues

Constructor & Destructor Documentation

WmICFunction_Pulses_Fluid13()

WmICFunction_Pulses_Fluid13::WmICFunction_Pulses_Fluid13

(

)

Create new WmICFunction_Pulses_Fluid13.

~WmICFunction_Pulses_Fluid13()

WmICFunction_Pulses_Fluid13::~WmICFunction_Pulses_Fluid13

(

)

Destroy WmICFunction_Pulses_Fluid13.

Member Function Documentation

applyFunction()

void WmICFunction_Pulses_Fluid13::applyFunction ( const real *  position, real *  value  ) const

virtual

Evaluate the function at a position and return the result through a pointer.

Parameters

p	Position to evaluate function (must have at least 3 components)
v	Value evaluated at position (must be allocated outside function)

Implements WmICFunction.

gaussianPulse()

real WmICFunction_Pulses_Fluid13::gaussianPulse ( const real &  r, const real *  xc, const real *  x  ) const

protected

isInPulse()

bool WmICFunction_Pulses_Fluid13::isInPulse ( const real &  r, const real *  xc, const real *  x  ) const

protected

setup()

void WmICFunction_Pulses_Fluid13::setup ( const WxCryptSet &  wxc )

virtual

Setup WmICFunction_Pulses_Fluid13 object using supplied cryptset.

Parameters

wxc	Cryptset to use for setting

Reimplemented from WmICFunction.

Member Data Documentation

_jump

real WmICFunction_Pulses_Fluid13::_jump

protected

_mass

real WmICFunction_Pulses_Fluid13::_mass

protected

_n0

real WmICFunction_Pulses_Fluid13::_n0

protected

_temperature

real WmICFunction_Pulses_Fluid13::_temperature

protected

---

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

• src/initialConditions/wmicfunction_pulses_fluid13.h