#include <GreenWakeFunction.h>

Inheritance diagram for GreenWakeFunction:

Collaboration diagram for GreenWakeFunction:

Classes
class	Wake

Public Member Functions
	~GreenWakeFunction ()

	GreenWakeFunction (const std::string &name, std::vector< Filter * > filters, int NBIN, double Z0, double radius, double sigma, int acMode, double tau, int direction, bool constLength, std::string fname)

std::pair< int, int >	distrIndices (int vectLen)
	given a vector of length N, distribute the indexes among the available processors More...

void	apply (PartBunchBase< double, 3 > *bunch)

void	setWakeFromFile (int NBin, double spacing)
	reads in the wakefield from file More...

virtual const std::string	getType () const

Public Member Functions inherited from WakeFunction
	WakeFunction (std::string name, unsigned int n)

virtual	~WakeFunction ()

virtual void	initialize (const ElementBase *)

const std::string &	getName () const

Private Member Functions
template<class F >
double	simpson (F &f, double a, double b, unsigned int N)
	Simpson-Integration from the function f from a to b with N steps. More...

void	compEnergy (const double K, const double charge, const double lambda, double OutEnergy)
	just a Testfunction! Calculate the energy of the Wakefunction with the lambda More...

void	compEnergy (const double K, const double charge, std::vector< double > lambda, double *OutEnergy)
	Calculate the energy of the Wakefunction with the lambda. More...

void	CalcWakeFFT (double spacing)
	Calculate the FFT of the Wakefunction. More...

Private Attributes
std::vector< double >	lineDensity_m
	save the line Density of the particle bunch More...

std::vector< double >	FftWField_m
	FFT of the zero padded wakefield. More...

int	NBin_m
	divides the particle bunch in NBin slices More...

double	Z0_m
	impedance More...

double	radius_m
	radius More...

double	sigma_m
	material constant More...

int	acMode_m
	conductivity either 1="AC" or 2="DC" More...

double	tau_m
	material constant More...

int	direction_m
	direction either 1="Longitudinal" 2= "Transversal" More...

bool	constLength_m
	true if the length of the particle bunch is considered as constant More...

std::string	filename_m
	filename of the wakefield More...

std::vector< Filter * >	filters_m

Additional Inherited Members
Protected Attributes inherited from WakeFunction
const unsigned int	nBins_m

Detailed Description

Definition at line 38 of file GreenWakeFunction.h.

Constructor & Destructor Documentation

◆ ~GreenWakeFunction()

GreenWakeFunction::~GreenWakeFunction ( )

Definition at line 83 of file GreenWakeFunction.cpp.

◆ GreenWakeFunction()

GreenWakeFunction::GreenWakeFunction	(	const std::string &	name,
		std::vector< Filter * >	filters,
		int	NBIN,
		double	Z0,
		double	radius,
		double	sigma,
		int	acMode,
		double	tau,
		int	direction,
		bool	constLength,
		std::string	fname
	)

Todo:

In this code one can only apply either the longitudinal wakefield or the transversal wakefield. One should implement that both wakefields can be applied to the particle beam

NBins must be set equal to MT of the fieldsolver. This should be changed. (the length of lineDensity_m must be NBins and not to MT)

Parameters

[in]	NBIN	number of Bins
[in]	Z0	impedance of the tube
[in]	radius	radius of the tube
[in]	sigma	material constant
[in]	acMode	1 for AC and 2 for DC
[in]	tau	material constant
[in]	direction	0 for transversal and 1 for Longitudinal
[in]	constLength	true if the length of the particle bunch is considered as constant
[in]	fname	read wake from file

Definition at line 52 of file GreenWakeFunction.cpp.

References endl(), and gmsg.

Here is the call graph for this function:

Member Function Documentation

◆ apply()

void GreenWakeFunction::apply ( PartBunchBase< double, 3 > * bunch )

virtual

Implements WakeFunction.

Definition at line 115 of file GreenWakeFunction.cpp.

References abs(), Physics::c, PartBunchBase< T, Dim >::calcBeamParameters(), PartBunchBase< T, Dim >::calcLineDensity(), CalcWakeFFT(), compEnergy(), constLength_m, direction_m, PartBunchBase< T, Dim >::Ef, endl(), FftWField_m, filename_m, filters_m, floor(), PartBunchBase< T, Dim >::get_bounds(), PartBunchBase< T, Dim >::getChargePerParticle(), PartBunchBase< T, Dim >::getLocalNum(), gmsg, lineDensity_m, LONGITUDINAL, NBin_m, WakeFunction::nBins_m, PAssert, PartBunchBase< T, Dim >::R, setWakeFromFile(), sqrt(), TRANSVERSAL, and Z0_m.

Here is the call graph for this function:

◆ CalcWakeFFT()

void GreenWakeFunction::CalcWakeFFT ( double spacing )

private

Calculate the FFT of the Wakefunction.

Parameters

[in] spacing distance between 2 slice in the line distribution

Calculate the Wakefield on all processors

Reduce the results

Definition at line 366 of file GreenWakeFunction.cpp.

References a, acMode_m, direction_m, distrIndices(), FftWField_m, NBin_m, radius_m, real(), reduce(), sigma_m, simpson(), tau_m, and Z0_m.

Referenced by apply().

Here is the call graph for this function:

◆ compEnergy() [1/2]

void GreenWakeFunction::compEnergy	(	const double	K,
		const double	charge,
		const double *	lambda,
		double *	OutEnergy
	)

private

just a Testfunction! Calculate the energy of the Wakefunction with the lambda

Parameters

[in]	K	a constant
[in]	charge	a constant
[in]	lambda	the distribution of the Particles
[out]	OutEnergy	this is the Output

Definition at line 249 of file GreenWakeFunction.cpp.

References FftWField_m, NBin_m, and real().

Referenced by apply().

Here is the call graph for this function:

◆ compEnergy() [2/2]

void GreenWakeFunction::compEnergy	(	const double	K,
		const double	charge,
		std::vector< double >	lambda,
		double *	OutEnergy
	)

private

Calculate the energy of the Wakefunction with the lambda.

Parameters

[in]	K	a constant
[in]	charge	a constant
[in]	lambda	the distribution of the Particles
[out]	OutEnergy	this is the Output

Definition at line 309 of file GreenWakeFunction.cpp.

References FftWField_m, NBin_m, and real().

Here is the call graph for this function:

◆ distrIndices()

std::pair< int, int > GreenWakeFunction::distrIndices ( int vectLen )

given a vector of length N, distribute the indexes among the available processors

Todo:: make this function general available

Parameters

[in]	length	of vector
[out]	first	lowIndex, second: hiIndex

Definition at line 100 of file GreenWakeFunction.cpp.

References IpplInfo::getNodes(), and IpplInfo::myNode().

Referenced by CalcWakeFFT().

Here is the call graph for this function:

◆ getType()

const std::string GreenWakeFunction::getType ( ) const

virtual

Implements WakeFunction.

Definition at line 523 of file GreenWakeFunction.cpp.

◆ setWakeFromFile()

void GreenWakeFunction::setWakeFromFile	(	int	NBin,
		double	spacing
	)

reads in the wakefield from file

Definition at line 446 of file GreenWakeFunction.cpp.

References endl(), FftWField_m, filename_m, Hypervolume::fs, name, NBin_m, and real().

Referenced by apply().

Here is the call graph for this function:

◆ simpson()

template<class F >

double GreenWakeFunction::simpson	(	F &	f,
		double	a,
		double	b,
		unsigned int	N
	)

inlineprivate

Simpson-Integration from the function f from a to b with N steps.

Parameters

[in]	f	the function to integrate
[in]	a	integrate from a
[in]	b	integrate to b
[in]	N	Number of integration points

Returns: function value of the integration

Definition at line 140 of file GreenWakeFunction.h.

References a, and PAssert.

Referenced by CalcWakeFFT().

Member Data Documentation

◆ acMode_m

int GreenWakeFunction::acMode_m

private

conductivity either 1="AC" or 2="DC"

Definition at line 174 of file GreenWakeFunction.h.

Referenced by CalcWakeFFT().

◆ constLength_m

bool GreenWakeFunction::constLength_m

private

true if the length of the particle bunch is considered as constant

Definition at line 180 of file GreenWakeFunction.h.

Referenced by apply().

◆ direction_m

int GreenWakeFunction::direction_m

private

direction either 1="Longitudinal" 2= "Transversal"

Definition at line 178 of file GreenWakeFunction.h.

Referenced by apply(), and CalcWakeFFT().

◆ FftWField_m

std::vector<double> GreenWakeFunction::FftWField_m

private

FFT of the zero padded wakefield.

Definition at line 163 of file GreenWakeFunction.h.

Referenced by apply(), CalcWakeFFT(), compEnergy(), and setWakeFromFile().

◆ filename_m

std::string GreenWakeFunction::filename_m

private

filename of the wakefield

Definition at line 182 of file GreenWakeFunction.h.

Referenced by apply(), and setWakeFromFile().

◆ filters_m

std::vector<Filter *> GreenWakeFunction::filters_m

private

Definition at line 184 of file GreenWakeFunction.h.

Referenced by apply().

◆ lineDensity_m

std::vector<double> GreenWakeFunction::lineDensity_m

private

save the line Density of the particle bunch

Definition at line 161 of file GreenWakeFunction.h.

Referenced by apply().

◆ NBin_m

int GreenWakeFunction::NBin_m

private

divides the particle bunch in NBin slices

Definition at line 166 of file GreenWakeFunction.h.

Referenced by apply(), CalcWakeFFT(), compEnergy(), and setWakeFromFile().

◆ radius_m

double GreenWakeFunction::radius_m

private

radius

Definition at line 170 of file GreenWakeFunction.h.

Referenced by CalcWakeFFT().

◆ sigma_m

double GreenWakeFunction::sigma_m

private

material constant

Definition at line 172 of file GreenWakeFunction.h.

Referenced by CalcWakeFFT().

◆ tau_m

double GreenWakeFunction::tau_m

private

material constant

Definition at line 176 of file GreenWakeFunction.h.

Referenced by CalcWakeFFT().

◆ Z0_m

double GreenWakeFunction::Z0_m

private

impedance

Definition at line 168 of file GreenWakeFunction.h.

Referenced by apply(), and CalcWakeFFT().

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

/Users/gsell/src/OPAL/src/src/Classic/Solvers/GreenWakeFunction.h
/Users/gsell/src/OPAL/src/src/Classic/Solvers/GreenWakeFunction.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GreenWakeFunction()

◆ GreenWakeFunction()

Member Function Documentation

◆ apply()

◆ CalcWakeFFT()

◆ compEnergy() [1/2]

◆ compEnergy() [2/2]

◆ distrIndices()

◆ getType()

◆ setWakeFromFile()

◆ simpson()

Member Data Documentation

◆ acMode_m

◆ constLength_m

◆ direction_m

◆ FftWField_m

◆ filename_m

◆ filters_m

◆ lineDensity_m

◆ NBin_m

◆ radius_m

◆ sigma_m

◆ tau_m

◆ Z0_m