IEquilibrium Class Reference

An abstract class for initializing a distribution function in (species,vpar,mu). More...

Inheritance diagram for IEquilibrium:

Public Member Functions
virtual DFieldSpVparMu	operator() (DFieldSpVparMu allfequilibrium) const =0
	Operator for initializing an equilibrium distribution function.
virtual DFieldSpVx	operator() (DFieldSpVx allfequilibrium) const =0
	Operator for initializing a distribution function that does not depend on space.
virtual DFieldSpVxVy	operator() (DFieldSpVxVy allfequilibrium) const =0
	Operator for initializing a distribution function that does not depend on space.

Detailed Description

An abstract class for initializing a distribution function in (species,vpar,mu).

An abstract class for initializing the equilibrium state of the distribution function.

An abstract class for initializing a distribution function that does not depend on space.

The equilibrium state does not depend on spatial dimensions.

Member Function Documentation

operator()() [1/3]

virtual DFieldSpVparMu IEquilibrium::operator() ( DFieldSpVparMu  allfequilibrium ) const

pure virtual

Operator for initializing an equilibrium distribution function.

Parameters

[in,out]

allfequilibrium

On input: the uninitialized distribution function. On output: the initialized distribution function.

Returns

The initialized equilibrium distribution function.

Implemented in MaxwellianEquilibrium.

operator()() [2/3]

virtual DFieldSpVx IEquilibrium::operator() ( DFieldSpVx  allfequilibrium ) const

pure virtual

Operator for initializing a distribution function that does not depend on space.

Parameters

[in,out]

allfequilibrium

On input: the uninitialized distribution function. On output: the initialized distribution function.

Returns

The initialized distribution function.

Implemented in BumpontailEquilibrium, and MaxwellianEquilibrium.

operator()() [3/3]

virtual DFieldSpVxVy IEquilibrium::operator() ( DFieldSpVxVy  allfequilibrium ) const

pure virtual

Operator for initializing a distribution function that does not depend on space.

Parameters

[in,out]

allfequilibrium

On input: the uninitialized distribution function. On output: the initialized distribution function.

Returns

The initialized distribution function.

Implemented in MaxwellianEquilibrium.

---

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

• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/geometryVparMu/initialization/iequilibrium.hpp
• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/geometryXVx/initialization/iequilibrium.hpp
• /home/runner/work/gyselalibxx/gyselalibxx/code_branch/src/geometryXYVxVy/initialization/iequilibrium.hpp