Stellarator-Tools
Loading...
Searching...
No Matches
integration_path::test_context Type Reference

A type for the test cases. More...

Inheritance diagram for integration_path::test_context:
integration_path_context::integration_path_context_class

Public Member Functions

procedure run (context, xcart, dxcart, length, dx)
 Call back function to test the integration.
 
- Public Member Functions inherited from integration_path_context::integration_path_context_class
procedure(integration_function), deferred run integration_function
 

Detailed Description

A type for the test cases.

Member Function/Subroutine Documentation

◆ run()

procedure integration_path::test_context::run ( class (test_context), intent(in)  context,
real (rprec), dimension(3), intent(in)  xcart,
real (rprec), dimension(3), intent(in)  dxcart,
real (rprec), intent(in)  length,
real (rprec), intent(in)  dx 
)

Call back function to test the integration.

This defined a function of f(x) = 1.

Parameters
[in]contextGeneric object that contains data for the integration function.
[in]xcartCurrent point in the integration.
[in]dxcartVector direction of the current integration path.
[in]lengthLength along the current integration.
[in]dxScaler length of the current integration path.
Returns
One

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