OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
Stepper< FieldFunction, Arguments > Class Template Referenceabstract

#include <Stepper.h>

Public Member Functions

 Stepper (const FieldFunction &fieldfunc)
 
virtual bool advance (PartBunchBase< double, 3 > *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 (PartBunchBase< double, 3 > *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:

Definition at line 36 of file Stepper.h.

Constructor & Destructor Documentation

◆ Stepper()

template<typename FieldFunction , typename ... Arguments>
Stepper< FieldFunction, Arguments >::Stepper ( const FieldFunction &  fieldfunc)
inline

Definition at line 40 of file Stepper.h.

◆ ~Stepper()

template<typename FieldFunction , typename ... Arguments>
virtual Stepper< FieldFunction, Arguments >::~Stepper ( )
inlinevirtual

Definition at line 67 of file Stepper.h.

Member Function Documentation

◆ advance()

template<typename FieldFunction , typename ... Arguments>
virtual bool Stepper< FieldFunction, Arguments >::advance ( PartBunchBase< double, 3 > *  bunch,
const size_t &  i,
const double &  t,
const double  dt,
Arguments &...  args 
) const
inlinevirtual

◆ doAdvance_m()

template<typename FieldFunction , typename ... Arguments>
virtual bool Stepper< FieldFunction, Arguments >::doAdvance_m ( PartBunchBase< double, 3 > *  bunch,
const size_t &  i,
const double &  t,
const double  dt,
Arguments &...  args 
) const
privatepure virtual

Member Data Documentation

◆ fieldfunc_m

template<typename FieldFunction , typename ... Arguments>
const FieldFunction& Stepper< FieldFunction, Arguments >::fieldfunc_m
protected

Definition at line 70 of file Stepper.h.


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