Stellarator-Tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Macros Pages
integration_path::test_search_context Type Reference

A type for the test cases. More...

Inheritance diagram for integration_path::test_search_context:
integration_path_context::search_path_context_class

Public Member Functions

procedure run (context, xcart1, xcart2)
 Call back function to test the search.
 
- Public Member Functions inherited from integration_path_context::search_path_context_class
procedure(search_function), deferred run search_function
 

Detailed Description

A type for the test cases.

Member Function/Subroutine Documentation

◆ run()

procedure integration_path::test_search_context::run ( class (test_search_context), intent(in)  context,
real (rprec), dimension(3), intent(in)  xcart1,
real (rprec), dimension(3), intent(in)  xcart2 
)

Call back function to test the search.

Returns true if the positions bound the loaction we are looking for.

Parameters
[in]contextGeneric object that contains data for the integration function.
[in]xcart1Lower test point.
[in]xcart2Higher test point.

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