OrbitThreader Class Reference

#include <OrbitThreader.h>

Collaboration diagram for OrbitThreader:

Classes
struct	elementPosition
struct	elementPositionComp

Public Member Functions
	OrbitThreader (const PartData &ref, const Vector_t &r, const Vector_t &p, double s, double maxDiffZBunch, double t, double dT, StepSizeConfig stepSizes, OpalBeamline &bl)
void	execute ()
IndexMap::value_t	query (IndexMap::key_t::first_type step, IndexMap::key_t::second_type length)
IndexMap::key_t	getRange (const IndexMap::value_t::value_type &element, double position) const
IndexMap::value_t	getTouchingElements (const IndexMap::key_t &range) const
BoundingBox	getBoundingBox () const

Private Member Functions
void	trackBack ()
void	integrate (const IndexMap::value_t &activeSet, double maxDrift=10.0)
bool	containsCavity (const IndexMap::value_t &activeSet)
void	autophaseCavities (const IndexMap::value_t &activeSet, const std::set< std::string > &visitedElements)
double	getMaxDesignEnergy (const IndexMap::value_t &elementSet) const
void	registerElement (const IndexMap::value_t &elementSet, double, const Vector_t &r, const Vector_t &p)
void	processElementRegister ()
void	setDesignEnergy (FieldList &allElements, const std::set< std::string > &visitedElements)
void	computeBoundingBox ()
void	updateBoundingBoxWithCurrentPosition ()
double	computeDriftLengthToBoundingBox (const std::set< std::shared_ptr< Component > > &elements, const Vector_t &position, const Vector_t &direction) const
void	checkElementLengths (const std::set< std::shared_ptr< Component > > &elements)

Private Attributes
Vector_t	r_m
	position of reference particle in lab coordinates More...
Vector_t	p_m
	momentum of reference particle More...
double	pathLength_m
	position of reference particle in path length More...
double	distTrackBack_m
double	time_m
	the simulated time More...
double	dt_m
	the time step More...
ValueRange< long >	stepRange_m
long	currentStep_m {0}
StepSizeConfig	stepSizes_m
	final position in path length More...
const double	zstop_m
ValueRange< double >	pathLengthRange_m
OpalBeamline &	itsOpalBeamline_m
IndexMap	imap_m
unsigned int	errorFlag_m
BorisPusher	integrator_m
const PartData &	reference_m
std::ofstream	logger_m
size_t	loggingFrequency_m
BoundingBox	globalBoundingBox_m
std::multimap< std::string, elementPosition >	elementRegistry_m

Detailed Description

Definition at line 36 of file OrbitThreader.h.

Constructor & Destructor Documentation

OrbitThreader()

OrbitThreader::OrbitThreader	(	const PartData &	ref,
		const Vector_t &	r,
		const Vector_t &	p,
		double	s,
		double	maxDiffZBunch,
		double	t,
		double	dT,
		StepSizeConfig	stepSizes,
		OpalBeamline &	bl
	)

Definition at line 48 of file OrbitThreader.cpp.

References abs(), Util::combineFilePath(), computeBoundingBox(), distTrackBack_m, dt_m, Physics::e, endl(), ValueRange< T >::enlargeIfOutside(), OpalData::getInstance(), StepSizeConfig::getNumStepsFinestResolution(), StepSizeConfig::getPathLengthRange(), logger_m, loggingFrequency_m, max(), min(), IpplInfo::myNode(), pathLength_m, pathLengthRange_m, stepRange_m, stepSizes_m, OpalData::WRITE, and zstop_m.

Here is the call graph for this function:

Member Function Documentation

autophaseCavities()

void OrbitThreader::autophaseCavities ( const IndexMap::value_t &  activeSet, const std::set< std::string > &  visitedElements  )

private

Definition at line 301 of file OrbitThreader.cpp.

References Options::autoPhase, dt_m, end(), CavityAutophaser::getPhaseAtMaxEnergy(), itsOpalBeamline_m, p_m, r_m, reference_m, RFCAVITY, OpalBeamline::rotateToLocalCS(), time_m, OpalBeamline::transformToLocalCS(), and TRAVELINGWAVE.

Referenced by execute().

Here is the call graph for this function:

checkElementLengths()

void OrbitThreader::checkElementLengths ( const std::set< std::shared_ptr< Component > > &  elements )

private

Definition at line 112 of file OrbitThreader.cpp.

References abs(), Physics::c, euclidean_norm(), StepSizeConfig::getdT(), Util::getGamma(), StepSizeConfig::getZStop(), p_m, pathLength_m, StepSizeConfig::reachedEnd(), and stepSizes_m.

Referenced by execute().

Here is the call graph for this function:

computeBoundingBox()

void OrbitThreader::computeBoundingBox ( )

private

Definition at line 456 of file OrbitThreader.cpp.

References ANY, end(), BoundingBox::enlargeToContainBoundingBox(), OpalBeamline::getElementByType(), globalBoundingBox_m, itsOpalBeamline_m, MARKER, and updateBoundingBoxWithCurrentPosition().

Referenced by OrbitThreader().

Here is the call graph for this function:

computeDriftLengthToBoundingBox()

double OrbitThreader::computeDriftLengthToBoundingBox ( const std::set< std::shared_ptr< Component > > &  elements, const Vector_t &  position, const Vector_t &  direction  ) const

private

Definition at line 480 of file OrbitThreader.cpp.

References DRIFT, euclidean_norm(), BoundingBox::getIntersectionPoint(), globalBoundingBox_m, and max().

Referenced by execute(), and trackBack().

Here is the call graph for this function:

containsCavity()

bool OrbitThreader::containsCavity ( const IndexMap::value_t &  activeSet )

private

Definition at line 287 of file OrbitThreader.cpp.

References end(), RFCAVITY, and TRAVELINGWAVE.

Referenced by execute().

Here is the call graph for this function:

execute()

void OrbitThreader::execute

(

)

Definition at line 135 of file OrbitThreader.cpp.

References IndexMap::add(), ANY, autophaseCavities(), Physics::c, checkElementLengths(), computeDriftLengthToBoundingBox(), containsCavity(), copysign(), currentStep_m, dt_m, end(), endl(), ValueRange< T >::enlargeIfOutside(), EOL, errorFlag_m, EVERYTHINGFINE, OpalBeamline::getElementByType(), OpalBeamline::getElements(), gmsg, HITMATERIAL, imap_m, integrate(), integrator_m, ValueRange< T >::isInside(), ValueRange< T >::isOutside(), itsOpalBeamline_m, level1(), p_m, pathLength_m, pathLengthRange_m, processElementRegister(), BorisPusher::push(), r_m, registerElement(), IndexMap::saveSDDS(), setDesignEnergy(), stepRange_m, IndexMap::tidyUp(), trackBack(), updateBoundingBoxWithCurrentPosition(), and zstop_m.

Referenced by ParallelTTracker::execute().

Here is the call graph for this function:

getBoundingBox()

BoundingBox OrbitThreader::getBoundingBox ( ) const

inline

Definition at line 146 of file OrbitThreader.h.

References globalBoundingBox_m.

Referenced by ParallelTTracker::execute().

getMaxDesignEnergy()

double OrbitThreader::getMaxDesignEnergy ( const IndexMap::value_t &  elementSet ) const

private

Definition at line 326 of file OrbitThreader.cpp.

References end(), RFCavity::getDesignEnergy(), max(), RFCAVITY, and TRAVELINGWAVE.

Here is the call graph for this function:

getRange()

IndexMap::key_t OrbitThreader::getRange ( const IndexMap::value_t::value_type &  element, double  position  ) const

inline

Definition at line 135 of file OrbitThreader.h.

References IndexMap::getRange(), and imap_m.

Referenced by ParallelTTracker::computeParticleMatterInteraction().

Here is the call graph for this function:

getTouchingElements()

IndexMap::value_t OrbitThreader::getTouchingElements ( const IndexMap::key_t &  range ) const

inline

Definition at line 141 of file OrbitThreader.h.

References IndexMap::getTouchingElements(), and imap_m.

Referenced by ParallelTTracker::computeParticleMatterInteraction().

Here is the call graph for this function:

integrate()

void OrbitThreader::integrate ( const IndexMap::value_t &  activeSet, double  maxDrift = 10.0  )

private

Definition at line 209 of file OrbitThreader.cpp.

References Physics::c, copysign(), currentStep_m, dot(), dt_m, end(), endl(), BoundingBox::enlargeToContainPosition(), EOL, errorFlag_m, euclidean_norm(), Units::eV2MeV, EVERYTHINGFINE, OpalBeamline::getCSTrafoLab2Local(), OpalBeamline::getElements(), OpalData::getInstance(), PartData::getM(), globalBoundingBox_m, HITMATERIAL, integrator_m, ValueRange< T >::isOutside(), itsOpalBeamline_m, BorisPusher::kick(), logger_m, loggingFrequency_m, IpplInfo::myNode(), p_m, pathLength_m, pathLengthRange_m, BorisPusher::push(), r_m, reference_m, OpalBeamline::rotateFromLocalCS(), OpalBeamline::rotateToLocalCS(), Units::s2ns, sqrt(), stepRange_m, time_m, OpalBeamline::transformToLocalCS(), and zstop_m.

Referenced by execute(), and trackBack().

Here is the call graph for this function:

processElementRegister()

void OrbitThreader::processElementRegister ( )

private

Definition at line 403 of file OrbitThreader.cpp.

References ANY, elementRegistry_m, end(), OpalBeamline::getElementByType(), itsOpalBeamline_m, and name.

Referenced by execute().

Here is the call graph for this function:

query()

IndexMap::value_t OrbitThreader::query ( IndexMap::key_t::first_type  step, IndexMap::key_t::second_type  length  )

inline

Definition at line 129 of file OrbitThreader.h.

References imap_m, and IndexMap::query().

Referenced by ParallelTTracker::computeExternalFields().

Here is the call graph for this function:

registerElement()

void OrbitThreader::registerElement ( const IndexMap::value_t &  elementSet, double  start, const Vector_t &  r, const Vector_t &  p  )

private

Definition at line 371 of file OrbitThreader.cpp.

References abs(), Physics::e, elementRegistry_m, end(), euclidean_norm(), itsOpalBeamline_m, name, pathLength_m, Attrib::Distribution::R, OpalBeamline::rotateToLocalCS(), and OpalBeamline::transformToLocalCS().

Referenced by execute().

Here is the call graph for this function:

setDesignEnergy()

void OrbitThreader::setDesignEnergy ( FieldList &  allElements, const std::set< std::string > &  visitedElements  )

private

Definition at line 440 of file OrbitThreader.cpp.

References dot(), end(), PartData::getM(), p_m, reference_m, RFCAVITY, sqrt(), and TRAVELINGWAVE.

Referenced by execute().

Here is the call graph for this function:

trackBack()

void OrbitThreader::trackBack ( )

private

Definition at line 343 of file OrbitThreader.cpp.

References abs(), Physics::c, computeDriftLengthToBoundingBox(), currentStep_m, distTrackBack_m, dt_m, ValueRange< T >::enlargeIfOutside(), OpalBeamline::getElements(), integrate(), integrator_m, itsOpalBeamline_m, min(), p_m, pathLength_m, pathLengthRange_m, BorisPusher::push(), r_m, and stepRange_m.

Referenced by execute().

Here is the call graph for this function:

updateBoundingBoxWithCurrentPosition()

void OrbitThreader::updateBoundingBoxWithCurrentPosition ( )

private

Definition at line 473 of file OrbitThreader.cpp.

References Physics::c, dt_m, BoundingBox::enlargeToContainPosition(), Util::getGamma(), globalBoundingBox_m, p_m, and r_m.

Referenced by computeBoundingBox(), and execute().

Here is the call graph for this function:

Member Data Documentation

currentStep_m

long OrbitThreader::currentStep_m {0}

private

Definition at line 76 of file OrbitThreader.h.

Referenced by execute(), integrate(), and trackBack().

distTrackBack_m

double OrbitThreader::distTrackBack_m

private

distance to track back before tracking forward (length of bunch but not beyond cathode)

Definition at line 70 of file OrbitThreader.h.

Referenced by OrbitThreader(), and trackBack().

dt_m

double OrbitThreader::dt_m

private

the time step

Definition at line 74 of file OrbitThreader.h.

Referenced by autophaseCavities(), execute(), integrate(), OrbitThreader(), trackBack(), and updateBoundingBoxWithCurrentPosition().

elementRegistry_m

std::multimap<std::string, elementPosition> OrbitThreader::elementRegistry_m

private

Definition at line 108 of file OrbitThreader.h.

Referenced by processElementRegister(), and registerElement().

errorFlag_m

unsigned int OrbitThreader::errorFlag_m

private

Definition at line 86 of file OrbitThreader.h.

Referenced by execute(), and integrate().

globalBoundingBox_m

BoundingBox OrbitThreader::globalBoundingBox_m

private

Definition at line 94 of file OrbitThreader.h.

Referenced by computeBoundingBox(), computeDriftLengthToBoundingBox(), getBoundingBox(), integrate(), and updateBoundingBoxWithCurrentPosition().

imap_m

IndexMap OrbitThreader::imap_m

private

Definition at line 84 of file OrbitThreader.h.

Referenced by execute(), getRange(), getTouchingElements(), and query().

integrator_m

BorisPusher OrbitThreader::integrator_m

private

Definition at line 88 of file OrbitThreader.h.

Referenced by execute(), integrate(), and trackBack().

itsOpalBeamline_m

OpalBeamline& OrbitThreader::itsOpalBeamline_m

private

Definition at line 83 of file OrbitThreader.h.

Referenced by autophaseCavities(), computeBoundingBox(), execute(), integrate(), processElementRegister(), registerElement(), and trackBack().

logger_m

std::ofstream OrbitThreader::logger_m

private

Definition at line 91 of file OrbitThreader.h.

Referenced by integrate(), and OrbitThreader().

loggingFrequency_m

size_t OrbitThreader::loggingFrequency_m

private

Definition at line 92 of file OrbitThreader.h.

Referenced by integrate(), and OrbitThreader().

p_m

Vector_t OrbitThreader::p_m

private

momentum of reference particle

Definition at line 65 of file OrbitThreader.h.

Referenced by autophaseCavities(), checkElementLengths(), execute(), integrate(), setDesignEnergy(), trackBack(), and updateBoundingBoxWithCurrentPosition().

pathLength_m

double OrbitThreader::pathLength_m

private

position of reference particle in path length

Definition at line 67 of file OrbitThreader.h.

Referenced by checkElementLengths(), execute(), integrate(), OrbitThreader(), registerElement(), and trackBack().

pathLengthRange_m

ValueRange<double> OrbitThreader::pathLengthRange_m

private

Definition at line 81 of file OrbitThreader.h.

Referenced by execute(), integrate(), OrbitThreader(), and trackBack().

r_m

Vector_t OrbitThreader::r_m

private

position of reference particle in lab coordinates

Definition at line 63 of file OrbitThreader.h.

Referenced by autophaseCavities(), execute(), integrate(), trackBack(), and updateBoundingBoxWithCurrentPosition().

reference_m

const PartData& OrbitThreader::reference_m

private

Definition at line 89 of file OrbitThreader.h.

Referenced by autophaseCavities(), integrate(), and setDesignEnergy().

stepRange_m

ValueRange<long> OrbitThreader::stepRange_m

private

Definition at line 75 of file OrbitThreader.h.

Referenced by execute(), integrate(), OrbitThreader(), and trackBack().

stepSizes_m

StepSizeConfig OrbitThreader::stepSizes_m

private

final position in path length

Definition at line 79 of file OrbitThreader.h.

Referenced by checkElementLengths(), and OrbitThreader().

time_m

double OrbitThreader::time_m

private

the simulated time

Definition at line 72 of file OrbitThreader.h.

Referenced by autophaseCavities(), and integrate().

zstop_m

const double OrbitThreader::zstop_m

private

Definition at line 80 of file OrbitThreader.h.

Referenced by execute(), integrate(), and OrbitThreader().

---

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

• /Users/gsell/src/OPAL/src/src/Algorithms/OrbitThreader.h
• /Users/gsell/src/OPAL/src/src/Algorithms/OrbitThreader.cpp