WmICFunction_Pulses_Fluid5 Class Reference

#include <wmicfunction_pulses_fluid5.h>

Inheritance diagram for WmICFunction_Pulses_Fluid5:

Public Member Functions
	WmICFunction_Pulses_Fluid5 ()
	Create new WmICFunction_Pulses_Fluid5.
	~WmICFunction_Pulses_Fluid5 ()
	Destroy WmICFunction_Pulses_Fluid5.
void	setup (const WxCryptSet &wxc)
	Setup WmICFunction_Pulses_Fluid5 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
real	calcRadiusPosition (const real *xc, const real *x) const
bool	isInPulse (const real &a, const real &r) const
real	gaussianPulse (const real &a, const real &r) const
real	polynomialPulse (const real &a, const real &r) 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	_n1
real	_temperature
real	_gas_gamma
real	_radius
real	_num_cols
bool	_gaussian
bool	_polynomial
real	_k
std::vector< real >	_center_x
std::vector< real >	_center_y
std::vector< real >	_center_z
Protected Attributes inherited from WmICFunction
std::string	_name
int	_numArgs
real *	_rvalues

Constructor & Destructor Documentation

WmICFunction_Pulses_Fluid5()

WmICFunction_Pulses_Fluid5::WmICFunction_Pulses_Fluid5

(

)

Create new WmICFunction_Pulses_Fluid5.

~WmICFunction_Pulses_Fluid5()

WmICFunction_Pulses_Fluid5::~WmICFunction_Pulses_Fluid5

(

)

Destroy WmICFunction_Pulses_Fluid5.

Member Function Documentation

applyFunction()

void WmICFunction_Pulses_Fluid5::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.

calcRadiusPosition()

real WmICFunction_Pulses_Fluid5::calcRadiusPosition ( const real *  xc, const real *  x  ) const

protected

gaussianPulse()

real WmICFunction_Pulses_Fluid5::gaussianPulse ( const real &  a, const real &  r  ) const

protected

isInPulse()

bool WmICFunction_Pulses_Fluid5::isInPulse ( const real &  a, const real &  r  ) const

protected

polynomialPulse()

real WmICFunction_Pulses_Fluid5::polynomialPulse ( const real &  a, const real &  r  ) const

protected

setup()

void WmICFunction_Pulses_Fluid5::setup ( const WxCryptSet &  wxc )

virtual

Setup WmICFunction_Pulses_Fluid5 object using supplied cryptset.

Parameters

wxc	Cryptset to use for setting

Reimplemented from WmICFunction.

Member Data Documentation

_center_x

std::vector<real> WmICFunction_Pulses_Fluid5::_center_x

protected

_center_y

std::vector<real> WmICFunction_Pulses_Fluid5::_center_y

protected

_center_z

std::vector<real> WmICFunction_Pulses_Fluid5::_center_z

protected

_gas_gamma

real WmICFunction_Pulses_Fluid5::_gas_gamma

protected

_gaussian

bool WmICFunction_Pulses_Fluid5::_gaussian

protected

_k

real WmICFunction_Pulses_Fluid5::_k

protected

_mass

real WmICFunction_Pulses_Fluid5::_mass

protected

_n0

real WmICFunction_Pulses_Fluid5::_n0

protected

_n1

real WmICFunction_Pulses_Fluid5::_n1

protected

_num_cols

real WmICFunction_Pulses_Fluid5::_num_cols

protected

_polynomial

bool WmICFunction_Pulses_Fluid5::_polynomial

protected

_radius

real WmICFunction_Pulses_Fluid5::_radius

protected

_temperature

real WmICFunction_Pulses_Fluid5::_temperature

protected

---

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

• src/initialConditions/wmicfunction_pulses_fluid5.h