explicitFunctions.f90 File Reference

Global functions callable from C++ code. More...

Functions/Subroutines
real(dp) function	getfunctionvalue (baseID, intParams, realParams, nip, nrp, xArg, ierr)
	Evaluates an explicit function. More...
real(dp) function	getfunctionderiv (baseID, intParams, realParams, nip, nrp, xArg, ierr)
	Evaluates the derivative of an explicit function. More...
integer function	getfunctiontypeid (functionName)
	Returns the function type Id (enum) of the specified functionName. More...

Detailed Description

Global functions callable from C++ code.

This file contains global function wrappers of subroutines from the explicitfunctionsmodule, such that they can be invoked from C++ or python.

Function/Subroutine Documentation

getfunctionderiv()

real(dp) function getfunctionderiv	(	integer, intent(in)	baseID,
		integer, dimension(nip), intent(in)	intParams,
		real(dp), dimension(nrp), intent(in)	realParams,
		integer, intent(in)	nip,
		integer, intent(in)	nrp,
		real(dp), intent(in)	xArg,
		integer, intent(out)	ierr
	)

Evaluates the derivative of an explicit function.

Parameters

[in]	baseID	Base Id of the explicit function to evaluate
[in]	intParams	Integer function parameters (constant)
[in]	realParams	Double precision function parameters (constant)
[in]	nip	Number of integer parameters
[in]	nrp	Number of double precision parameters
[in]	xArg	Function argument value
[out]	ierr	Error flag

Returns

The function derivative

getfunctiontypeid()

integer function getfunctiontypeid

(

character(len=*), intent(in)

functionName

)

Returns the function type Id (enum) of the specified functionName.

getfunctionvalue()

real(dp) function getfunctionvalue	(	integer, intent(in)	baseID,
		integer, dimension(nip), intent(in)	intParams,
		real(dp), dimension(nrp), intent(in)	realParams,
		integer, intent(in)	nip,
		integer, intent(in)	nrp,
		real(dp), intent(in)	xArg,
		integer, intent(out)	ierr
	)

Evaluates an explicit function.

Parameters

[in]	baseID	Base Id of the explicit function to evaluate
[in]	intParams	Integer function parameters (constant)
[in]	realParams	Double precision function parameters (constant)
[in]	nip	Number of integer parameters
[in]	nrp	Number of double precision parameters
[in]	xArg	Function argument value
[out]	ierr	Error flag

Returns

The function value