OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
CSRWakeFunction Class Reference

#include <CSRWakeFunction.h>

Inheritance diagram for CSRWakeFunction:
Collaboration diagram for CSRWakeFunction:

Public Member Functions

 CSRWakeFunction (const std::string &name, std::vector< Filter * > filters, const unsigned int &N)
void apply (PartBunchBase< double, 3 > *bunch) override
void initialize (const ElementBase *ref) override
virtual WakeType getType () const override
const std::string & getName () const

Protected Attributes

const unsigned int nBins_m

Private Member Functions

void calculateLineDensity (PartBunchBase< double, 3 > *bunch, std::pair< double, double > &meshInfo)
void calculateContributionInside (size_t sliceNumber, double angleOfSlice, double meshSpacing)
void calculateContributionAfter (size_t sliceNumber, double angleOfSlice, double meshSpacing)
double calcPsi (const double &psiInitial, const double &x, const double &Ds) const

Private Attributes

std::vector< Filter * > filters_m
std::shared_ptr< FilterdefaultFilter_m
FilterdiffOp_m
LineDensity lineDensity_m
LineDensity dlineDensitydz_m
std::vector< double > Ez_m
std::vector< double > Psi_m
double Begin_m
double FieldBegin_m
double Length_m
double bendRadius_m
std::string bendName_m
double totalBendAngle_m
const std::string name_m

Detailed Description

Definition at line 29 of file CSRWakeFunction.h.

Constructor & Destructor Documentation

◆ CSRWakeFunction()

CSRWakeFunction::CSRWakeFunction ( const std::string & name,
std::vector< Filter * > filters,
const unsigned int & N )

Definition at line 34 of file CSRWakeFunction.cpp.

References begin(), bendRadius_m, diffOp_m, dlineDensitydz_m, end(), filters_m, lineDensity_m, name, totalBendAngle_m, and WakeFunction::WakeFunction().

Here is the call graph for this function:

Member Function Documentation

◆ apply()

◆ calcPsi()

double CSRWakeFunction::calcPsi ( const double & psiInitial,
const double & x,
const double & Ds ) const
private

solve the equation

\[\Delta s = \frac{R \Psi^3}{24} \frac{\Psi + 4x}{\Psi + x} \]

for \(\Psi\) using Newtons method.

Definition at line 309 of file CSRWakeFunction.cpp.

References bendRadius_m, endl(), ERRORMSG, RootFinderForCSR::hasPositiveRealRoots(), and RootFinderForCSR::searchRoot().

Referenced by calculateContributionAfter().

Here is the call graph for this function:

◆ calculateContributionAfter()

void CSRWakeFunction::calculateContributionAfter ( size_t sliceNumber,
double angleOfSlice,
double meshSpacing )
private

Definition at line 252 of file CSRWakeFunction.cpp.

References bendRadius_m, calcPsi(), dlineDensitydz_m, Ez_m, floor(), lineDensity_m, Psi_m, and totalBendAngle_m.

Referenced by apply().

Here is the call graph for this function:

◆ calculateContributionInside()

void CSRWakeFunction::calculateContributionInside ( size_t sliceNumber,
double angleOfSlice,
double meshSpacing )
private

Definition at line 166 of file CSRWakeFunction.cpp.

References bendRadius_m, dlineDensitydz_m, Ez_m, lineDensity_m, and totalBendAngle_m.

Referenced by apply().

◆ calculateLineDensity()

void CSRWakeFunction::calculateLineDensity ( PartBunchBase< double, 3 > * bunch,
std::pair< double, double > & meshInfo )
private

Definition at line 153 of file CSRWakeFunction.cpp.

References PartBunchBase< T, Dim >::calcLineDensity(), diffOp_m, dlineDensitydz_m, filters_m, lineDensity_m, and WakeFunction::nBins_m.

Referenced by apply().

Here is the call graph for this function:

◆ getName()

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

Definition at line 49 of file WakeFunction.h.

References name_m.

◆ getType()

WakeType CSRWakeFunction::getType ( ) const
overridevirtual

Implements WakeFunction.

Definition at line 340 of file CSRWakeFunction.cpp.

References CSRWakeFunction.

◆ initialize()

void CSRWakeFunction::initialize ( const ElementBase * ref)
overridevirtual

Reimplemented from WakeFunction.

Definition at line 137 of file CSRWakeFunction.cpp.

References Begin_m, bendName_m, bendRadius_m, FieldBegin_m, BendBase::getBendAngle(), Bend2D::getBendRadius(), Bend2D::getDimensions(), Bend2D::getEffectiveCenter(), Bend2D::getEffectiveLength(), ElementBase::getName(), Length_m, RBEND, SBEND, and totalBendAngle_m.

Here is the call graph for this function:

Member Data Documentation

◆ Begin_m

double CSRWakeFunction::Begin_m
private

Definition at line 60 of file CSRWakeFunction.h.

Referenced by initialize().

◆ bendName_m

std::string CSRWakeFunction::bendName_m
private

Definition at line 72 of file CSRWakeFunction.h.

Referenced by apply(), and initialize().

◆ bendRadius_m

double CSRWakeFunction::bendRadius_m
private

◆ defaultFilter_m

std::shared_ptr<Filter> CSRWakeFunction::defaultFilter_m
private

Definition at line 47 of file CSRWakeFunction.h.

◆ diffOp_m

Filter* CSRWakeFunction::diffOp_m
private

Definition at line 48 of file CSRWakeFunction.h.

Referenced by calculateLineDensity(), and CSRWakeFunction().

◆ dlineDensitydz_m

LineDensity CSRWakeFunction::dlineDensitydz_m
private

◆ Ez_m

std::vector<double> CSRWakeFunction::Ez_m
private

◆ FieldBegin_m

double CSRWakeFunction::FieldBegin_m
private

Definition at line 64 of file CSRWakeFunction.h.

Referenced by apply(), and initialize().

◆ filters_m

std::vector<Filter*> CSRWakeFunction::filters_m
private

Definition at line 46 of file CSRWakeFunction.h.

Referenced by calculateLineDensity(), and CSRWakeFunction().

◆ Length_m

double CSRWakeFunction::Length_m
private

Definition at line 67 of file CSRWakeFunction.h.

Referenced by initialize().

◆ lineDensity_m

LineDensity CSRWakeFunction::lineDensity_m
private

◆ name_m

const std::string WakeFunction::name_m
privateinherited

Definition at line 55 of file WakeFunction.h.

Referenced by getName(), and WakeFunction().

◆ nBins_m

const unsigned int WakeFunction::nBins_m
protectedinherited

◆ Psi_m

std::vector<double> CSRWakeFunction::Psi_m
private

Definition at line 57 of file CSRWakeFunction.h.

Referenced by apply(), and calculateContributionAfter().

◆ totalBendAngle_m

double CSRWakeFunction::totalBendAngle_m
private

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