#include <Tanh.h>

Inheritance diagram for endfieldmodel::Tanh:

Collaboration diagram for endfieldmodel::Tanh:

Public Member Functions
	Tanh (double x0, double lambda, int max_index)

	Tanh ()

	Tanh (const Tanh &rhs)

	~Tanh ()

Tanh *	clone () const

void	rescale (double scaleFactor)

double	function (double x, int n) const

double	getCentreLength () const

double	getEndLength () const

double	getTanh (double x, int n) const

double	getNegTanh (double x, int n) const

double	getLambda () const

double	getX0 () const

void	setLambda (double lambda)

void	setX0 (double x0)

virtual void	setMaximumDerivative (size_t n)

std::ostream &	print (std::ostream &out) const

Public Member Functions inherited from endfieldmodel::EndFieldModel
virtual	~EndFieldModel ()

virtual std::ostream &	print (std::ostream &out) const =0

virtual double	function (double x, int n) const =0

virtual double	getCentreLength () const =0

virtual double	getEndLength () const =0

virtual EndFieldModel *	clone () const =0

virtual void	setMaximumDerivative (size_t n)=0

virtual void	rescale (double scaleFactor)=0

Static Public Member Functions
static std::vector< std::vector< int > >	getTanhDiffIndices (size_t n)

static void	setTanhDiffIndices (size_t n)

Static Public Member Functions inherited from endfieldmodel::EndFieldModel
static std::shared_ptr< EndFieldModel >	getEndFieldModel (std::string name)

static void	setEndFieldModel (std::string name, std::shared_ptr< EndFieldModel > efm)

static std::string	getName (std::shared_ptr< EndFieldModel > efm)

Private Attributes
double	_x0

double	_lambda

Static Private Attributes
static std::vector< std::vector< std::vector< int > > >	_tdi

Detailed Description

Calculate the Tanh function (e.g. for multipole end fields).

DoubleTanh function is given by
\(T(x) = (tanh( (x+x0)/\lambda )-tanh( (x-x0)/\lambda ))/2\)
The derivatives of tanh(x) are given by
\(d^p tanh(x)/dx^p = \sum_q I_{pq} tanh^{q}(x)\)
where \(I_{pq}\) are calculated using some recursion relation. Using these expressions, one can calculate a recursion relation for higher order derivatives and hence calculate analytical derivatives at arbitrary order.

Definition at line 48 of file Tanh.h.

Constructor & Destructor Documentation

◆ Tanh() [1/3]

endfieldmodel::Tanh::Tanh	(	double	x0,
		double	lambda,
		int	max_index
	)

Create a double tanh function

Here x0 is the centre length and lambda is the end length. max_index is used to set up for differentiation - don't try to calculate higher differentials than exist in max_index.

Definition at line 39 of file Tanh.cpp.

References setTanhDiffIndices().

Here is the call graph for this function:

◆ Tanh() [2/3]

endfieldmodel::Tanh::Tanh ( )

inline

Default constructor (initialises x0 and lambda to 0)

Definition at line 59 of file Tanh.h.

References setTanhDiffIndices().

Referenced by clone().

Here is the call graph for this function:

◆ Tanh() [3/3]

endfieldmodel::Tanh::Tanh ( const Tanh & rhs )

inline

Copy constructor

Definition at line 62 of file Tanh.h.

◆ ~Tanh()

endfieldmodel::Tanh::~Tanh ( )

Destructor (no mallocs so does nothing)

Definition at line 43 of file Tanh.cpp.

Member Function Documentation

◆ clone()

Tanh * endfieldmodel::Tanh::clone ( ) const

virtual

Inherited copy constructor.

Implements endfieldmodel::EndFieldModel.

Definition at line 45 of file Tanh.cpp.

References Tanh().

Here is the call graph for this function:

◆ function()

double endfieldmodel::Tanh::function	(	double	x,
		int	n
	)		const

virtual

Double Tanh is given by
\(d(x) = \)

Implements endfieldmodel::EndFieldModel.

Definition at line 72 of file Tanh.cpp.

References getNegTanh(), getTanh(), and Hypervolume::n.

Here is the call graph for this function:

◆ getCentreLength()

double endfieldmodel::Tanh::getCentreLength ( ) const

inlinevirtual

Nominal flat top length is twice x0 (one x0 in each direction)

Implements endfieldmodel::EndFieldModel.

Definition at line 79 of file Tanh.h.

References getX0().

Here is the call graph for this function:

◆ getEndLength()

double endfieldmodel::Tanh::getEndLength ( ) const

inlinevirtual

Return nominal fringe field length

Implements endfieldmodel::EndFieldModel.

Definition at line 82 of file Tanh.h.

References getLambda().

Here is the call graph for this function:

◆ getLambda()

double endfieldmodel::Tanh::getLambda ( ) const

inline

Return lambda (end length)

Definition at line 101 of file Tanh.h.

References _lambda.

Referenced by MultipoleT::apply(), getEndLength(), MultipoleT::getFringeLength(), MultipoleTBase::getFringeLength(), and MultipoleT::transformCoords().

◆ getNegTanh()

double endfieldmodel::Tanh::getNegTanh	(	double	x,
		int	n
	)		const

Returns the value of tanh((x-x0)/lambda) or its \(n^{th}\) derivative.

Definition at line 61 of file Tanh.cpp.

References _lambda, _tdi, _x0, Hypervolume::n, and tanh().

Referenced by function(), MultipoleTBase::getFringeDeriv(), and MultipoleT::getFringeDeriv().

Here is the call graph for this function:

◆ getTanh()

double endfieldmodel::Tanh::getTanh	(	double	x,
		int	n
	)		const

Returns the value of tanh((x+x0)/lambda) or its \(n^{th}\) derivative.

Definition at line 50 of file Tanh.cpp.

References _lambda, _tdi, _x0, Hypervolume::n, and tanh().

Referenced by function(), MultipoleTBase::getFringeDeriv(), and MultipoleT::getFringeDeriv().

Here is the call graph for this function:

◆ getTanhDiffIndices()

std::vector< std::vector< int > > endfieldmodel::Tanh::getTanhDiffIndices ( size_t n )

static

Get all the tanh differential indices \(I_{pq}\).

Returns vector of vector of ints where p indexes the differential and q indexes the tanh power - so

Definition at line 107 of file Tanh.cpp.

References _tdi, Hypervolume::n, and setTanhDiffIndices().

Here is the call graph for this function:

◆ getX0()

double endfieldmodel::Tanh::getX0 ( ) const

inline

Return x0 (flat top length)

Definition at line 104 of file Tanh.h.

References _x0.

Referenced by MultipoleT::apply(), getCentreLength(), and MultipoleT::transformCoords().

◆ print()

std::ostream & endfieldmodel::Tanh::print ( std::ostream & out ) const

virtual

Prints a human readable string to out

Implements endfieldmodel::EndFieldModel.

Definition at line 119 of file Tanh.cpp.

References _lambda, and _x0.

◆ rescale()

void endfieldmodel::Tanh::rescale ( double scaleFactor )

virtual

Rescale the end field by a factor x0

Implements endfieldmodel::EndFieldModel.

Definition at line 112 of file Tanh.cpp.

References _lambda, and _x0.

◆ setLambda()

void endfieldmodel::Tanh::setLambda ( double lambda )

inline

Set lambda (end length)

Definition at line 107 of file Tanh.h.

References _lambda.

Referenced by OpalScalingFFAMagnet::setupDefaultEndField(), and OpalVerticalFFAMagnet::update().

◆ setMaximumDerivative()

void endfieldmodel::Tanh::setMaximumDerivative ( size_t n )

virtual

Set the maximum derivative prior to tracking

Implements endfieldmodel::EndFieldModel.

Definition at line 76 of file Tanh.cpp.

References Hypervolume::n, and setTanhDiffIndices().

Here is the call graph for this function:

◆ setTanhDiffIndices()

void endfieldmodel::Tanh::setTanhDiffIndices ( size_t n )

static

Set the value of tanh differential indices to nth order differentials.

Definition at line 81 of file Tanh.cpp.

References _tdi, endfieldmodel::CompactVector(), and Hypervolume::n.

Referenced by getTanhDiffIndices(), setMaximumDerivative(), Tanh(), and OpalVerticalFFAMagnet::update().

Here is the call graph for this function:

◆ setX0()

void endfieldmodel::Tanh::setX0 ( double x0 )

inline

Set x0 (flat top length)

Definition at line 110 of file Tanh.h.

References _x0.

Referenced by OpalScalingFFAMagnet::setupDefaultEndField(), and OpalVerticalFFAMagnet::update().

Member Data Documentation

◆ _lambda

double endfieldmodel::Tanh::_lambda

private

Definition at line 118 of file Tanh.h.

Referenced by getLambda(), getNegTanh(), getTanh(), print(), rescale(), and setLambda().

◆ _tdi

std::vector< std::vector< std::vector< int > > > endfieldmodel::Tanh::_tdi

staticprivate

_tdi indexes powers of tanh in d^n tanh/dx^n as sum of powers of tanh

For some reason we index as n, +a, -a, but the third index is redundant

Definition at line 124 of file Tanh.h.

Referenced by getNegTanh(), getTanh(), getTanhDiffIndices(), and setTanhDiffIndices().

◆ _x0

double endfieldmodel::Tanh::_x0

private

Definition at line 118 of file Tanh.h.

Referenced by getNegTanh(), getTanh(), getX0(), print(), rescale(), and setX0().

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

/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/EndFieldModel/Tanh.h
/Users/gsell/src/OPAL/src/src/Classic/AbsBeamline/EndFieldModel/Tanh.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Tanh() [1/3]

◆ Tanh() [2/3]

◆ Tanh() [3/3]

◆ ~Tanh()

Member Function Documentation

◆ clone()

◆ function()

◆ getCentreLength()

◆ getEndLength()

◆ getLambda()

◆ getNegTanh()

◆ getTanh()

◆ getTanhDiffIndices()

◆ getX0()

◆ print()

◆ rescale()

◆ setLambda()

◆ setMaximumDerivative()

◆ setTanhDiffIndices()

◆ setX0()

Member Data Documentation

◆ _lambda

◆ _tdi

◆ _x0