CollisionInfo Class Reference

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

Public Types
using	radial_chunk_type = double
	radial_chunk_type used to treat the 0D case for radial profile

Public Member Functions
	CollisionInfo (PC_tree_t const &yaml_input_file)
	The constructor for the CollisionFrequency class.
std::int8_t	collisions_interspecies () const
	A method for accessing the collisions_interspecies member variable of the class.
double	coeff_AD () const
	A method for accessing the coeff_AD variable of the class.

Detailed Description

Class to collect information to initialize the collision operator.

Constructor & Destructor Documentation

CollisionInfo()

CollisionInfo::CollisionInfo ( PC_tree_t const &  yaml_input_file )

inlineexplicit

The constructor for the CollisionFrequency class.

Parameters

[in]

yaml_input_file

YAML input file containing CollisionsInfo

Computation of the radial profile of ADi that is required for koliop interface

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

eps_rpeak = eps(rpeak) with eps(r) = r/R0 is the aspect ratio.

In this specific case, where AD is a scalar all values are forced to 1, so coeff_AD_atrpeak = sqrt(2)

Member Function Documentation

collisions_interspecies()

std::int8_t CollisionInfo::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()

double CollisionInfo::coeff_AD ( ) const

inline

A method for accessing the coeff_AD variable of the class.

Returns

A double containing the coeff_AD value.

---

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

• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/collisions/collisioninfo.hpp