#include <OrbitThreader.h>

Collaboration diagram for OrbitThreader:

Classes
struct	elementPosition

struct	elementPositionComp

Public Member Functions
	OrbitThreader (const PartData &ref, const Vector_t< double, 3 > &r, const Vector_t< double, 3 > &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

const ReferencePathModel &	getReferencePathModel () const
	Return the threader-owned reference-path model.

const ReferencePathModel &	getActionRangeRegistrationModel () const
	Return the action-range registration model.

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< double, 3 > &r, const Vector_t< double, 3 > &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< double, 3 > &position, const Vector_t< double, 3 > &direction) const

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

Private Attributes
Vector_t< double, 3 >	r_m
	position of reference particle in lab coordinates

Vector_t< double, 3 >	p_m
	momentum of reference particle

double	pathLength_m
	position of reference particle in path length

double	distTrackBack_m

double	time_m
	the simulated time

double	dt_m
	the time step

ValueRange< long >	stepRange_m

long	currentStep_m {0}

StepSizeConfig	stepSizes_m
	final position in path length

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::shared_ptr< Component >, elementPosition, std::owner_less< std::shared_ptr< Component > > >	elementRegistry_m

ReferencePathModel	actionRangeRegistrationModel_m

Detailed Description

Definition at line 38 of file OrbitThreader.h.

Class Documentation

◆ OrbitThreader::elementPosition

struct OrbitThreader::elementPosition

Definition at line 110 of file OrbitThreader.h.

Collaboration diagram for OrbitThreader::elementPosition:

Class Members
double	elementEdge_m
double	endField_m
double	startField_m

Constructor & Destructor Documentation

◆ OrbitThreader()

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

Definition at line 46 of file OrbitThreader.cpp.

References Util::combineFilePath(), computeBoundingBox(), distTrackBack_m, dt_m, ValueRange< T >::enlargeIfOutside(), OpalData::getInstance(), StepSizeConfig::getNumStepsFinestResolution(), StepSizeConfig::getPathLengthRange(), logger_m, loggingFrequency_m, 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 293 of file OrbitThreader.cpp.

References Options::autoPhase, dt_m, 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 93 of file OrbitThreader.cpp.

References 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, 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< double, 3 > &	position,
		const Vector_t< double, 3 > &	direction
	)		const

private

Definition at line 479 of file OrbitThreader.cpp.

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

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 279 of file OrbitThreader.cpp.

References RFCAVITY, and TRAVELINGWAVE.

Referenced by execute().

◆ execute()

void OrbitThreader::execute ( )

Definition at line 122 of file OrbitThreader.cpp.

References IndexMap::add(), ANY, autophaseCavities(), Physics::c, checkElementLengths(), computeDriftLengthToBoundingBox(), containsCavity(), currentStep_m, dt_m, 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, 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 ParallelTracker::execute(), TEST_F(), and TEST_F().

Here is the call graph for this function:

◆ getActionRangeRegistrationModel()

const ReferencePathModel & OrbitThreader::getActionRangeRegistrationModel ( ) const

inline

Return the action-range registration model.

This model is distinct from the traced reference-path occupancy model. It records the element passages that are later converted into backward-compatible action ranges and legacy ELEMEDGE-anchored intervals on the elements.

Definition at line 169 of file OrbitThreader.h.

References actionRangeRegistrationModel_m.

Referenced by TEST_F(), and TEST_F().

◆ getBoundingBox()

BoundingBox OrbitThreader::getBoundingBox ( ) const

inline

Definition at line 163 of file OrbitThreader.h.

References globalBoundingBox_m.

Referenced by ParallelTracker::execute().

◆ getMaxDesignEnergy()

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

private

Definition at line 313 of file OrbitThreader.cpp.

References RFCavity::getDesignEnergy(), 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 154 of file OrbitThreader.h.

References IndexMap::getRange(), and imap_m.

Here is the call graph for this function:

◆ getReferencePathModel()

const ReferencePathModel & OrbitThreader::getReferencePathModel ( ) const

inline

Return the threader-owned reference-path model.

This model stores the ordered active-element sets on the reporting coordinate \(s\) that are traced by the reference particle through the summed fields. In other words, it is the occupancy model derived from the reference-particle integration, not a privileged-element ownership model. The returned reference remains owned by the OrbitThreader.

Definition at line 165 of file OrbitThreader.h.

References IndexMap::getReferencePathModel(), and imap_m.

Referenced by TEST_F(), and TEST_F().

Here is the call graph for this function:

◆ getTouchingElements()

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

inline

Definition at line 159 of file OrbitThreader.h.

References IndexMap::getTouchingElements(), and imap_m.

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 199 of file OrbitThreader.cpp.

References Physics::c, currentStep_m, dot(), dt_m, BoundingBox::enlargeToContainPosition(), EOL, errorFlag_m, euclidean_norm(), Units::eV2MeV, EVERYTHINGFINE, OpalBeamline::getCSTrafoLab2Local(), OpalBeamline::getElements(), OpalData::getInstance(), PartData::getM(), PartData::getQ(), globalBoundingBox_m, HITMATERIAL, integrator_m, ValueRange< T >::isOutside(), itsOpalBeamline_m, BorisPusher::kick(), logger_m, loggingFrequency_m, p_m, pathLength_m, pathLengthRange_m, BorisPusher::push(), r_m, reference_m, OpalBeamline::rotateFromLocalCS(), OpalBeamline::rotateToLocalCS(), Units::s2ns, 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 386 of file OrbitThreader.cpp.

References actionRangeRegistrationModel_m, ReferencePathModel::clear(), elementRegistry_m, ReferencePathSegment::getBegin(), and ReferencePathSegment::getEnd().

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 149 of file OrbitThreader.h.

References imap_m, and IndexMap::query().

Referenced by ParallelTracker::computeExternalFields().

Here is the call graph for this function:

◆ registerElement()

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

private

Definition at line 357 of file OrbitThreader.cpp.

References elementRegistry_m, euclidean_norm(), itsOpalBeamline_m, pathLength_m, 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(), PartData::getM(), p_m, reference_m, RFCAVITY, and TRAVELINGWAVE.

Referenced by execute().

Here is the call graph for this function:

◆ trackBack()

void OrbitThreader::trackBack ( )

private

Definition at line 329 of file OrbitThreader.cpp.

References Physics::c, computeDriftLengthToBoundingBox(), currentStep_m, distTrackBack_m, dt_m, ValueRange< T >::enlargeIfOutside(), OpalBeamline::getElements(), integrate(), integrator_m, itsOpalBeamline_m, 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 470 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

◆ actionRangeRegistrationModel_m

ReferencePathModel OrbitThreader::actionRangeRegistrationModel_m

private

Definition at line 126 of file OrbitThreader.h.

Referenced by getActionRangeRegistrationModel(), and processElementRegister().

◆ currentStep_m

long OrbitThreader::currentStep_m {0}

private

Definition at line 90 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 84 of file OrbitThreader.h.

Referenced by OrbitThreader(), and trackBack().

◆ dt_m

double OrbitThreader::dt_m

private

the time step

Definition at line 88 of file OrbitThreader.h.

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

◆ elementRegistry_m

std::multimap< std::shared_ptr<Component>, elementPosition, std::owner_less<std::shared_ptr<Component> > > OrbitThreader::elementRegistry_m

private

Definition at line 125 of file OrbitThreader.h.

Referenced by processElementRegister(), and registerElement().

◆ errorFlag_m

unsigned int OrbitThreader::errorFlag_m

private

Definition at line 100 of file OrbitThreader.h.

Referenced by execute(), and integrate().

◆ globalBoundingBox_m

BoundingBox OrbitThreader::globalBoundingBox_m

private

Definition at line 108 of file OrbitThreader.h.

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

◆ imap_m

IndexMap OrbitThreader::imap_m

private

Definition at line 98 of file OrbitThreader.h.

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

◆ integrator_m

BorisPusher OrbitThreader::integrator_m

private

Definition at line 102 of file OrbitThreader.h.

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

◆ itsOpalBeamline_m

OpalBeamline& OrbitThreader::itsOpalBeamline_m

private

Definition at line 97 of file OrbitThreader.h.

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

◆ logger_m

std::ofstream OrbitThreader::logger_m

private

Definition at line 105 of file OrbitThreader.h.

Referenced by integrate(), and OrbitThreader().

◆ loggingFrequency_m

size_t OrbitThreader::loggingFrequency_m

private

Definition at line 106 of file OrbitThreader.h.

Referenced by integrate(), and OrbitThreader().

◆ p_m

Vector_t<double, 3> OrbitThreader::p_m

private

momentum of reference particle

Definition at line 79 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 81 of file OrbitThreader.h.

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

◆ pathLengthRange_m

ValueRange<double> OrbitThreader::pathLengthRange_m

private

Definition at line 95 of file OrbitThreader.h.

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

◆ r_m

Vector_t<double, 3> OrbitThreader::r_m

private

position of reference particle in lab coordinates

Definition at line 77 of file OrbitThreader.h.

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

◆ reference_m

const PartData& OrbitThreader::reference_m

private

Definition at line 103 of file OrbitThreader.h.

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

◆ stepRange_m

ValueRange<long> OrbitThreader::stepRange_m

private

Definition at line 89 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 93 of file OrbitThreader.h.

Referenced by checkElementLengths(), and OrbitThreader().

◆ time_m

double OrbitThreader::time_m

private

the simulated time

Definition at line 86 of file OrbitThreader.h.

Referenced by autophaseCavities(), and integrate().

◆ zstop_m

const double OrbitThreader::zstop_m

private

Definition at line 94 of file OrbitThreader.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Class Documentation

◆ OrbitThreader::elementPosition

Constructor & Destructor Documentation

◆ OrbitThreader()

Member Function Documentation

◆ autophaseCavities()

◆ checkElementLengths()

◆ computeBoundingBox()

◆ computeDriftLengthToBoundingBox()

◆ containsCavity()

◆ execute()

◆ getActionRangeRegistrationModel()

◆ getBoundingBox()

◆ getMaxDesignEnergy()

◆ getRange()

◆ getReferencePathModel()

◆ getTouchingElements()

◆ integrate()

◆ processElementRegister()

◆ query()

◆ registerElement()

◆ setDesignEnergy()

◆ trackBack()

◆ updateBoundingBoxWithCurrentPosition()

Member Data Documentation

◆ actionRangeRegistrationModel_m

◆ currentStep_m

◆ distTrackBack_m

◆ dt_m

◆ elementRegistry_m

◆ errorFlag_m

◆ globalBoundingBox_m

◆ imap_m

◆ integrator_m

◆ itsOpalBeamline_m

◆ logger_m

◆ loggingFrequency_m

◆ p_m

◆ pathLength_m

◆ pathLengthRange_m

◆ r_m

◆ reference_m

◆ stepRange_m

◆ stepSizes_m

◆ time_m

◆ zstop_m