OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
WakeFunction Class Referenceabstract

#include <WakeFunction.h>

Inheritance diagram for WakeFunction:
Collaboration diagram for WakeFunction:

Public Member Functions

 WakeFunction (std::string name, unsigned int n)
virtual ~WakeFunction ()
virtual void initialize (const ElementBase *)
virtual void apply (PartBunchBase< double, 3 > *bunch)=0
virtual WakeType getType () const =0
const std::string & getName () const

Protected Attributes

const unsigned int nBins_m

Private Attributes

const std::string name_m

Detailed Description

Definition at line 34 of file WakeFunction.h.

Constructor & Destructor Documentation

◆ WakeFunction()

WakeFunction::WakeFunction ( std::string name,
unsigned int n )
inline

◆ ~WakeFunction()

virtual WakeFunction::~WakeFunction ( )
inlinevirtual

Definition at line 41 of file WakeFunction.h.

Member Function Documentation

◆ apply()

virtual void WakeFunction::apply ( PartBunchBase< double, 3 > * bunch)
pure virtual

◆ getName()

const std::string & WakeFunction::getName ( ) const
inline

Definition at line 49 of file WakeFunction.h.

References name_m.

◆ getType()

virtual WakeType WakeFunction::getType ( ) const
pure virtual

◆ initialize()

virtual void WakeFunction::initialize ( const ElementBase * )
inlinevirtual

Reimplemented in CSRIGFWakeFunction, and CSRWakeFunction.

Definition at line 43 of file WakeFunction.h.

Referenced by ParallelTTracker::computeWakefield().

Member Data Documentation

◆ name_m

const std::string WakeFunction::name_m
private

Definition at line 55 of file WakeFunction.h.

Referenced by getName(), and WakeFunction().

◆ nBins_m

const unsigned int WakeFunction::nBins_m
protected

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