Stellarator-Tools
Loading...
Searching...
No Matches
intpol::intpol_pol_context Type Reference

Struture to hole all memort needed to be sent to the integration callback function. More...

Inheritance diagram for intpol::intpol_pol_context:
integration_path_context::integration_path_context_class

Public Member Functions

procedure run (context, xcart, dxcart, length, dx)
 Polarmetry callback function.
 
- Public Member Functions inherited from integration_path_context::integration_path_context_class
procedure(integration_function), deferred run integration_function
 

Public Attributes

class(model_class), pointer model => null()
 Reference to a model::model_class object.
 

Detailed Description

Struture to hole all memort needed to be sent to the integration callback function.

Member Function/Subroutine Documentation

◆ run()

procedure intpol::intpol_pol_context::run ( class (intpol_pol_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 
)

Polarmetry callback function.

Returns the value of the denisty times the dot product of the magnetic field vector and the path direction. The denisty is provided by model::model_get_ne. The magnetic field vector is proved by equilibrium::equilibrium_get_B_vec

See also
integration_path
Parameters
[in]contextA model.
[in]xcartA integration point.
[in]dxcartA vector change in path.
[in]lengthLength along the integration. Not used in this function.
[in]dxA scalar change in path. Not used in this function.
Returns
The ne(x)*B.dl at point x.

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