PyOpal::PyEndFieldModel Namespace Reference

Functions
template<class C>
double	function (PyOpalObjectNS::PyOpalObject< C > pyobject, double x, int n)

Variables
std::string	functionDocstring

Function Documentation

function()

template<class C>

double PyOpal::PyEndFieldModel::function	(	PyOpalObjectNS::PyOpalObject< C >	pyobject,
		double	x,
		int	n )

Definition at line 19 of file PyEndFieldModel.h.

References endfieldmodel::EndFieldModel::getEndFieldModel(), PyOpal::PyOpalObjectNS::PyOpalObject< C >::getOpalShared(), and name.

Referenced by PyOpal::PyAsymmetricEnge::BOOST_PYTHON_MODULE(), and PyOpal::PyEnge::BOOST_PYTHON_MODULE().

Here is the call graph for this function:

Variable Documentation

functionDocstring

std::string PyOpal::PyEndFieldModel::functionDocstring

Initial value:

= 
"update the Enge object and then calculate the enge function or derivative\n"
"- x [float]: position at which to evaluate the function\n"
"- n [int]: derivative to calculate; 0 will return the enge function, 1 will\n"
"           return the 1st derivative, etc. Note that floating point precision\n"
"           becomes increasingly limiting for n > 10 or so.\n"
"Returns the function value or derivative.\n"

Definition at line 10 of file PyEndFieldModel.h.