Stepper< FieldFunction, Arguments > Class Template Reference

#include <Stepper.h>

Collaboration diagram for Stepper< FieldFunction, Arguments >:

Public Member Functions
	Stepper (const FieldFunction &fieldfunc)
virtual bool	advance (PartBunch_t *bunch, const size_t &i, const double &t, const double dt, Arguments &... args) const
virtual	~Stepper ()

Protected Attributes
const FieldFunction &	fieldfunc_m

Private Member Functions
virtual bool	doAdvance_m (PartBunch_t *bunch, const size_t &i, const double &t, const double dt, Arguments &... args) const =0

Detailed Description

template<typename FieldFunction, typename... Arguments>
class Stepper< FieldFunction, Arguments >

@precondition The field function has to return a boolean and take at least the following arguments in that order:

• double specifying the time
• int specifying the i-th particle
• Vector_t<double, 3> specifying the electric field
• Vector_t<double, 3> specifying the magnetic field

Definition at line 37 of file Stepper.h.

Constructor & Destructor Documentation

Stepper()

template<typename FieldFunction , typename... Arguments>

Stepper< FieldFunction, Arguments >::Stepper ( const FieldFunction &  fieldfunc )

inline

Definition at line 39 of file Stepper.h.

~Stepper()

template<typename FieldFunction , typename... Arguments>

virtual Stepper< FieldFunction, Arguments >::~Stepper ( )

inlinevirtual

Definition at line 61 of file Stepper.h.

Member Function Documentation

advance()

template<typename FieldFunction , typename... Arguments>

virtual bool Stepper< FieldFunction, Arguments >::advance ( PartBunch_t *  bunch, const size_t &  i, const double &  t, const double  dt, Arguments &...  args  ) const

inlinevirtual

Definition at line 41 of file Stepper.h.

References Stepper< FieldFunction, Arguments >::doAdvance_m().

Here is the call graph for this function:

doAdvance_m()

template<typename FieldFunction , typename... Arguments>

virtual bool Stepper< FieldFunction, Arguments >::doAdvance_m ( PartBunch_t *  bunch, const size_t &  i, const double &  t, const double  dt, Arguments &...  args  ) const

privatepure virtual

Implemented in LF2< FieldFunction, Arguments >, and RK4< FieldFunction, Arguments >.

Referenced by Stepper< FieldFunction, Arguments >::advance().

Member Data Documentation

fieldfunc_m

template<typename FieldFunction , typename... Arguments>

const FieldFunction& Stepper< FieldFunction, Arguments >::fieldfunc_m

protected

Definition at line 64 of file Stepper.h.

---

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

• Stepper.h