Gyselalib++
 
Loading...
Searching...
No Matches
IAdvectionVelocity< Geometry, GridV > Class Template Referenceabstract

A class which provides an advection operator. More...

Inheritance diagram for IAdvectionVelocity< Geometry, GridV >:
BslAdvectionVelocity< Geometry, GridV >

Public Member Functions

virtual DField< typename Geometry::IdxRangeFdistribu > operator() (DField< typename Geometry::IdxRangeFdistribu > allfdistribu, DConstField< typename Geometry::IdxRangeSpatial > electric_field, double dt) const =0
 operates a transport of the distribution function.
 

Detailed Description

template<class Geometry, class GridV>
class IAdvectionVelocity< Geometry, GridV >

A class which provides an advection operator.

A generic class for a velocity advection.

An abstract class which implements a function that applies the transport along a velocity direction of the phase space.

Member Function Documentation

◆ operator()()

template<class Geometry , class GridV >
virtual DField< typename Geometry::IdxRangeFdistribu > IAdvectionVelocity< Geometry, GridV >::operator() ( DField< typename Geometry::IdxRangeFdistribu >  allfdistribu,
DConstField< typename Geometry::IdxRangeSpatial >  electric_field,
double  dt 
) const
pure virtual

operates a transport of the distribution function.

Parameters
[in,out]allfdistribuReference to an array containing the value of the distribution function.
[in]electric_fieldThe electric field which derives from electrostatic potential and is the advection speed.
[in]dtTime step.
Returns
A reference to an array containing the value of distribution the function at the updated time t+dt.

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