CollisionsInter Class Reference

Class describing the inter-species collision operator. More...

Inheritance diagram for CollisionsInter:

Public Member Functions
	CollisionsInter (IdxRangeSpXVx const &mesh, double nustar0)
	The constructor for the operator.
DFieldSpXVx	operator() (DFieldSpXVx allfdistribu, double dt) const override
	Update the distribution function for inter-species collision.
double	get_nustar0 () const
	Get the collision coefficient.
void	get_derivative (DFieldSpXVx df, DConstFieldSpXVx allfdistribu) const
	Computes the expression of the time derivative of the distribution function.

Detailed Description

Class describing the inter-species collision operator.

The inter-species collision operator accounts for momentum and energy transfer between the maxwellian parts of the distribution function of different species. It is solved using a explicit time integrator (RK2 for instance).

The complete description of the operator can be found in rhs docs.

Constructor & Destructor Documentation

CollisionsInter()

CollisionsInter::CollisionsInter	(	IdxRangeSpXVx const &	mesh,
		double	nustar0
	)

The constructor for the operator.

Parameters

[in]	mesh	The index range on which the operator will act.
[in]	nustar0	The normalized collisionality.

Member Function Documentation

operator()()

DFieldSpXVx CollisionsInter::operator() ( DFieldSpXVx  allfdistribu, double  dt  ) const

overridevirtual

Update the distribution function for inter-species collision.

Update the distribution function for both electrons and ions to show how it is modified following collisions between the various species. This operator only handles collisions between particles of different species.

Parameters

[in,out]	allfdistribu	The distribution function.
[in]	dt	The time step over which the collisions occur.

Returns

A field referencing the distribution function passed as argument.

Implements IRightHandSide.

get_nustar0()

double CollisionsInter::get_nustar0

(

)

const

Get the collision coefficient.

Returns

The collisionality.

get_derivative()

void CollisionsInter::get_derivative	(	DFieldSpXVx	df,
		DConstFieldSpXVx	allfdistribu
	)		const

Computes the expression of the time derivative of the distribution function.

The expression is df = C, where C is the inter species collision operator. This function is made for the time integrator that is used to solve the collision operator (RK2 for instance).

Parameters

[in,out]	df	The time derivative.
[in]	allfdistribu	The distribution function.

---

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

• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/geometryXVx/rhs/collisions_inter.hpp