OPAL (Object Oriented Parallel Accelerator Library): CoordinateSystemTrafo Class Reference

OPAL (Object Oriented Parallel Accelerator Library) 2024.2

OPAL

#include <CoordinateSystemTrafo.h>

Collaboration diagram for CoordinateSystemTrafo:

Public Member Functions
	CoordinateSystemTrafo ()
	CoordinateSystemTrafo (const CoordinateSystemTrafo &right)
	CoordinateSystemTrafo (const Vector_t &origin, const Quaternion &orientation)
Vector_t	transformTo (const Vector_t &r) const
Vector_t	transformFrom (const Vector_t &r) const
Vector_t	rotateTo (const Vector_t &r) const
Vector_t	rotateFrom (const Vector_t &r) const
void	invert ()
CoordinateSystemTrafo	inverted () const
CoordinateSystemTrafo &	operator= (const CoordinateSystemTrafo &right)=default
CoordinateSystemTrafo	operator* (const CoordinateSystemTrafo &right) const
void	operator*= (const CoordinateSystemTrafo &right)
Vector_t	getOrigin () const
Quaternion	getRotation () const
void	print (std::ostream &) const

Private Attributes
Vector_t	origin_m
Quaternion	orientation_m
matrix_t	rotationMatrix_m

Detailed Description

Definition at line 8 of file CoordinateSystemTrafo.h.

Constructor & Destructor Documentation

◆ CoordinateSystemTrafo() [1/3]

CoordinateSystemTrafo::CoordinateSystemTrafo ( )

Definition at line 6 of file CoordinateSystemTrafo.cpp.

References orientation_m, origin_m, and rotationMatrix_m.

Referenced by CoordinateSystemTrafo(), inverted(), operator*(), operator*=(), and operator=().

◆ CoordinateSystemTrafo() [2/3]

CoordinateSystemTrafo::CoordinateSystemTrafo ( const CoordinateSystemTrafo & right )

Definition at line 22 of file CoordinateSystemTrafo.cpp.

References CoordinateSystemTrafo(), orientation_m, origin_m, and rotationMatrix_m.

Here is the call graph for this function:

◆ CoordinateSystemTrafo() [3/3]

CoordinateSystemTrafo::CoordinateSystemTrafo	(	const Vector_t &	origin,
		const Quaternion &	orientation )

Definition at line 28 of file CoordinateSystemTrafo.cpp.

References orientation_m, origin_m, and rotationMatrix_m.

Member Function Documentation

◆ getOrigin()

Vector_t CoordinateSystemTrafo::getOrigin ( ) const

inline

Definition at line 60 of file CoordinateSystemTrafo.h.

References origin_m.

Referenced by OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), OpalRBend3D::update(), OpalRBend::update(), and OpalSBend::update().

◆ getRotation()

Quaternion CoordinateSystemTrafo::getRotation ( ) const

inline

Definition at line 65 of file CoordinateSystemTrafo.h.

References orientation_m.

Referenced by OpalBeamline::save3DInput(), OpalRBend3D::update(), OpalRBend::update(), OpalSBend::update(), and H5PartWrapperForPT::writeStepHeader().

◆ invert()

void CoordinateSystemTrafo::invert ( )

Definition at line 35 of file CoordinateSystemTrafo.cpp.

References orientation_m, origin_m, and rotationMatrix_m.

Referenced by inverted().

◆ inverted()

CoordinateSystemTrafo CoordinateSystemTrafo::inverted ( ) const

inline

Definition at line 70 of file CoordinateSystemTrafo.h.

References CoordinateSystemTrafo(), and invert().

Referenced by MeshGenerator::add(), Undulator::apply(), ParallelTTracker::computeExternalFields(), ParallelTTracker::computeParticleMatterInteraction(), ParallelTTracker::computeSpaceChargeFields(), ParallelTTracker::computeWakefield(), ParallelTTracker::emitParticles(), ThickTracker::ThickTracker(), and ThickTracker::ThickTracker().

Here is the call graph for this function:

◆ operator*()

CoordinateSystemTrafo CoordinateSystemTrafo::operator* ( const CoordinateSystemTrafo & right ) const

Definition at line 42 of file CoordinateSystemTrafo.cpp.

References CoordinateSystemTrafo().

Here is the call graph for this function:

◆ operator*=()

void CoordinateSystemTrafo::operator*= ( const CoordinateSystemTrafo & right )

Definition at line 49 of file CoordinateSystemTrafo.cpp.

References Quaternion::conjugate(), CoordinateSystemTrafo(), orientation_m, origin_m, Quaternion::rotate(), and rotationMatrix_m.

Here is the call graph for this function:

◆ operator=()

CoordinateSystemTrafo & CoordinateSystemTrafo::operator= ( const CoordinateSystemTrafo & right )

default

References CoordinateSystemTrafo().

Here is the call graph for this function:

◆ print()

void CoordinateSystemTrafo::print ( std::ostream & os ) const

inline

Definition at line 53 of file CoordinateSystemTrafo.h.

References orientation_m, and origin_m.

Referenced by operator<<(), and operator<<().

◆ rotateFrom()

Vector_t CoordinateSystemTrafo::rotateFrom ( const Vector_t & r ) const

inline

Definition at line 89 of file CoordinateSystemTrafo.h.

References prod_boost_vector(), and rotationMatrix_m.

Referenced by Bend2D::calcEntranceFringeField(), Bend2D::calcExitFringeField(), ScatteringPhysics::computeCoulombScattering(), transformFrom(), and ParallelTTracker::updateReferenceParticle().

Here is the call graph for this function:

◆ rotateTo()

Vector_t CoordinateSystemTrafo::rotateTo ( const Vector_t & r ) const

inline

Definition at line 85 of file CoordinateSystemTrafo.h.

References prod_boost_vector(), and rotationMatrix_m.

Referenced by MeshGenerator::add(), Undulator::apply(), ScatteringPhysics::computeCoulombScattering(), ParallelTTracker::computeExternalFields(), ParallelTTracker::computeParticleMatterInteraction(), ParallelTTracker::computeSpaceChargeFields(), ParallelTTracker::computeWakefield(), Monitor::driftToCorrectPositionAndSave(), ParallelTTracker::emitParticles(), ParallelTTracker::execute(), ParallelTTracker::transformBunch(), and ParallelTTracker::updateReferenceParticle().

Here is the call graph for this function:

◆ transformFrom()

Vector_t CoordinateSystemTrafo::transformFrom ( const Vector_t & r ) const

inline

Definition at line 81 of file CoordinateSystemTrafo.h.

References origin_m, and rotateFrom().

Referenced by ScatteringPhysics::computeCoulombScattering(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), and Bend2D::setFieldCalcParam().

Here is the call graph for this function:

◆ transformTo()

Vector_t CoordinateSystemTrafo::transformTo ( const Vector_t & r ) const

inline

Definition at line 77 of file CoordinateSystemTrafo.h.

References origin_m, prod_boost_vector(), and rotationMatrix_m.

Referenced by MeshGenerator::add(), Undulator::apply(), Bend2D::calcEntranceFringeField(), Bend2D::calcExitFringeField(), Bend2D::calculateMapField(), ParallelTTracker::computeExternalFields(), ParallelTTracker::computeParticleMatterInteraction(), ParallelTTracker::computeSpaceChargeFields(), ParallelTTracker::computeWakefield(), Monitor::driftToCorrectPositionAndSave(), ParallelTTracker::emitParticles(), ParallelTTracker::execute(), Bend2D::getOutline(), Bend2D::getSurfaceMesh(), Bend2D::inMagnetCentralRegion(), Bend2D::inMagnetExitRegion(), Bend2D::isPositionInExitField(), Bend2D::setFieldCalcParam(), ParallelTTracker::transformBunch(), SingleMultipole< 4 >::update(), and ParallelTTracker::updateReferenceParticle().

Here is the call graph for this function:

Member Data Documentation

◆ orientation_m

Quaternion CoordinateSystemTrafo::orientation_m

private

Definition at line 36 of file CoordinateSystemTrafo.h.

Referenced by CoordinateSystemTrafo(), CoordinateSystemTrafo(), CoordinateSystemTrafo(), getRotation(), invert(), operator*=(), and print().

◆ origin_m

Vector_t CoordinateSystemTrafo::origin_m

private

Definition at line 35 of file CoordinateSystemTrafo.h.

Referenced by CoordinateSystemTrafo(), CoordinateSystemTrafo(), CoordinateSystemTrafo(), getOrigin(), invert(), operator*=(), print(), transformFrom(), and transformTo().

◆ rotationMatrix_m

matrix_t CoordinateSystemTrafo::rotationMatrix_m

private

Definition at line 37 of file CoordinateSystemTrafo.h.

Referenced by CoordinateSystemTrafo(), CoordinateSystemTrafo(), CoordinateSystemTrafo(), invert(), operator*=(), rotateFrom(), rotateTo(), and transformTo().

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