Gyselalib++
 
Loading...
Searching...
No Matches
CollisionInfoRadial< GridR > Class Template Reference

Class to collect information to initialize the collision operator. More...

Public Types

using DFieldMemR = DFieldMem< IdxRangeR >
 Type alias for a field memory block on a grid of radial values.
 
using DFieldR = DField< IdxRangeR >
 Type alias for a field defined on a grid of radial values.
 
using DConstFieldR = DConstField< IdxRangeR >
 Type alias for a field defined on a grid of radial values.
 
using radial_chunk_type = DConstFieldR
 radial_chunk_type used to treat the 0D case for radial profile
 

Public Member Functions

void compute_coeff_AD (IdxRangeR idxrange_r)
 Computation of the radial profile of AD.
 
 CollisionInfoRadial (double const rpeak, double const q_rpeak, double const R0, double const nustar0_rpeak, std::int8_t const collisions_interspecies, IdxRangeR idxrange_r)
 The constructor for the CollisionInfoRadial class.
 
std::int8_t collisions_interspecies () const
 A method for accessing the collisions_interspecies member variable of the class.
 
DConstFieldR coeff_AD () const
 A method for accessing coeff_AD (the radial profile of AD coeff) variable of the class.
 

Detailed Description

template<class GridR>
class CollisionInfoRadial< GridR >

Class to collect information to initialize the collision operator.

Constructor & Destructor Documentation

◆ CollisionInfoRadial()

template<class GridR >
CollisionInfoRadial< GridR >::CollisionInfoRadial ( double const  rpeak,
double const  q_rpeak,
double const  R0,
double const  nustar0_rpeak,
std::int8_t const  collisions_interspecies,
IdxRangeR  idxrange_r 
)
inline

The constructor for the CollisionInfoRadial class.

Parameters
[in]rpeakthe radial reference position r = rpeak
[in]q_rpeakthe safety factor value at r = rpeak
[in]R0the major radius at the magnetic axis
[in]nustar0_rpeakthe value of nustar at r = rpeak
[in]collisions_interspecieslogical value equal to true if interspecies collisions are taken into account
[in]idxrange_rradial index range

Member Function Documentation

◆ compute_coeff_AD()

template<class GridR >
void CollisionInfoRadial< GridR >::compute_coeff_AD ( IdxRangeR  idxrange_r)
inline

Computation of the radial profile of AD.

\[ AD(rpeak) = \sqrt(2)*eps_rpeak^(3/2)/(q_rpeak R0)*nustar0_rpeak \]

where R0, q_rpeak, nustar0_rpeak are given as input data and eps_rpeak = eps(rpeak) with eps(r) = r/R0 is the aspect ratio.

Parameters
[in]idxrange_rradial index range

This function should be private but is public due to Kokkos restrictions.

◆ collisions_interspecies()

template<class GridR >
std::int8_t CollisionInfoRadial< GridR >::collisions_interspecies ( ) const
inline

A method for accessing the collisions_interspecies member variable of the class.

Returns
A boolean containing the collisions_interspecies value.

◆ coeff_AD()

template<class GridR >
DConstFieldR CollisionInfoRadial< GridR >::coeff_AD ( ) const
inline

A method for accessing coeff_AD (the radial profile of AD coeff) variable of the class.

Returns
A field containing the radial profile of the AD coefficients.

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