wxm::functions::maxwell::harris_current_sheet Class Reference

#include <harris_current_sheet_field.h>

Inheritance diagram for wxm::functions::maxwell::harris_current_sheet:

Public Member Functions
	harris_current_sheet ()
	Create new harris_current_sheet.
	~harris_current_sheet ()
	Destroy harris_current_sheet.
void	setup (const WxCryptSet &wxc)
	Setup harris_current_sheet 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.

Additional Inherited Members
virtual void	applyFunction (const real *position, real *value) const =0
	This is the currently apply function call - recasts to real.
Protected Attributes inherited from WmICFunction
std::string	_name
int	_numArgs
real *	_rvalues

Constructor & Destructor Documentation

harris_current_sheet()

wxm::functions::maxwell::harris_current_sheet::harris_current_sheet

(

)

Create new harris_current_sheet.

~harris_current_sheet()

wxm::functions::maxwell::harris_current_sheet::~harris_current_sheet

(

)

Destroy harris_current_sheet.

Member Function Documentation

applyFunction()

void wxm::functions::maxwell::harris_current_sheet::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.

setup()

void wxm::functions::maxwell::harris_current_sheet::setup ( const WxCryptSet &  wxc )

virtual

Setup harris_current_sheet object using supplied cryptset.

Parameters

wxc	Cryptset to use for setting

Reimplemented from WmICFunction.

---

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

• src/initialConditions/harris_current_sheet_field.h