PatchRep Class Reference

Representation for a geometry patch. More...

#include <PatchRep.h>

Inheritance diagram for PatchRep:

Collaboration diagram for PatchRep:

Public Member Functions
	PatchRep (const std::string &name)
	Constructor with given name. More...
	PatchRep ()
	PatchRep (const PatchRep &)
virtual	~PatchRep ()
virtual ElementBase *	clone () const
	Return clone. More...
virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel. More...
virtual NullField &	getField ()
	Get field. More...
virtual const NullField &	getField () const
	Get field. More...
virtual NullGeometry &	getGeometry ()
	Get geometry. More...
virtual const NullGeometry &	getGeometry () const
	Get geometry. More...
virtual const Euclid3D &	getPatch () const
	Get patch. More...
void	setPatch (const Euclid3D &euclid)
	Set patch. More...
void	setPatch (double x, double y, double z, double vx, double vy, double vz)
	Set patch. More...
virtual ElementImage *	getImage () const
	Construct an image. More...
double	getX () const
	Get displacement. More...
double	getY () const
	Get displacement. More...
double	getZ () const
	Get displacement. More...
double	getVX () const
	Get rotation. More...
double	getVY () const
	Get rotation. More...
double	getVZ () const
	Get rotation. More...
void	setX (double)
	Set displacement. More...
void	setY (double)
	Set displacement. More...
void	setZ (double)
	Set displacement. More...
void	setVX (double)
	Set rotation. More...
void	setVY (double)
	Set rotation. More...
void	setVZ (double)
	Set rotation. More...
Public Member Functions inherited from Patch
	Patch (const std::string &name)
	Constructor with given name. More...
	Patch ()
	Patch (const Patch &)
virtual	~Patch ()
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to patch. More...
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
virtual void	finalise () override
virtual bool	bends () const override
virtual ElementBase::ElementType	getType () const override
	Get element type std::string. More...
virtual void	getDimensions (double &zBegin, double &zEnd) const override
Public Member Functions inherited from Component
	Component (const std::string &name)
	Constructor with given name. More...
	Component ()
	Component (const Component &right)
virtual	~Component ()
EVector	Efield (const Point3D &P) const
	Return the field in a point. More...
BVector	Bfield (const Point3D &P) const
	Return the field in a point. More...
EVector	Efield (const Point3D &P, double t) const
	Return the field in a point. More...
BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...
EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...
EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...
virtual void	addKR (int i, double t, Vector_t &K)
virtual void	addKT (int i, double t, Vector_t &K)
virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B)
virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
virtual bool	getPotential (const Vector_t &R, const double &t, Vector_t &A, double &phi)
virtual double	getDesignEnergy () const
virtual void	setDesignEnergy (const double &energy, bool changeable)
virtual void	goOnline (const double &kineticEnergy)
virtual void	goOffline ()
virtual bool	Online ()
virtual void	setComponentType (std::string)
virtual std::string	getComponentType () const
virtual const ElementBase &	getDesign () const
	Return design element. More...
virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...
virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...
void	setExitFaceSlope (const double &)
Public Member Functions inherited from ElementBase
	ElementBase (const std::string &name)
	Constructor with given name. More...
	ElementBase ()
	ElementBase (const ElementBase &)
virtual	~ElementBase ()
virtual const std::string &	getName () const
	Get element name. More...
virtual void	setName (const std::string &name)
	Set element name. More...
std::string	getTypeString () const
virtual double	getArcLength () const
	Get arc length. More...
virtual double	getElementLength () const
	Get design length. More...
virtual void	setElementLength (double length)
	Set design length. More...
virtual void	getElementDimensions (double &begin, double &end) const
virtual double	getOrigin () const
	Get origin position. More...
virtual double	getEntrance () const
	Get entrance position. More...
virtual double	getExit () const
	Get exit position. More...
virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...
virtual Euclid3D	getTransform (double s) const
	Get transform. More...
virtual Euclid3D	getTotalTransform () const
	Get transform. More...
virtual Euclid3D	getEntranceFrame () const
	Get transform. More...
virtual Euclid3D	getExitFrame () const
	Get transform. More...
virtual Euclid3D	getEntrancePatch () const
	Get patch. More...
virtual Euclid3D	getExitPatch () const
	Get patch. More...
virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...
virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...
virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...
virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...
virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...
virtual ElementBase *	copyStructure ()
	Make a structural copy. More...
bool	isSharable () const
	Test if the element can be shared. More...
virtual void	makeSharable ()
	Set sharable flag. More...
virtual ElementBase *	makeAlignWrapper ()
	Allow misalignment. More...
virtual ElementBase *	makeFieldWrapper ()
	Allow field errors. More...
virtual ElementBase *	makeWrappers ()
	Allow errors. More...
virtual ElementBase *	removeAlignWrapper ()
	Remove align wrapper. More...
virtual const ElementBase *	removeAlignWrapper () const
	Remove align wrapper. More...
virtual ElementBase *	removeFieldWrapper ()
	Remove field wrapper. More...
virtual const ElementBase *	removeFieldWrapper () const
	Remove field wrapper. More...
virtual ElementBase *	removeWrappers ()
	Return the design element. More...
virtual const ElementBase *	removeWrappers () const
	Return the design element. More...
bool	update (const AttributeSet &)
	Update element. More...
virtual void	setBoundaryGeometry (BoundaryGeometry *geo)
virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...
virtual bool	hasBoundaryGeometry () const
virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...
virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...
virtual bool	hasWake () const
virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const
virtual bool	hasParticleMatterInteraction () const
ElemType	getElType () const
	returns element type as enumeration needed in the envelope tracker More...
void	setElType (ElemType elt)
	set the element type as enumeration needed in the envelope tracker More...
void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)
CoordinateSystemTrafo	getCSTrafoGlobal2Local () const
void	releasePosition ()
void	fixPosition ()
bool	isPositioned () const
virtual CoordinateSystemTrafo	getEdgeToBegin () const
virtual CoordinateSystemTrafo	getEdgeToEnd () const
void	setAperture (const ApertureType &type, const std::vector< double > &args)
std::pair < ElementBase::ApertureType, std::vector< double > >	getAperture () const
virtual bool	isInside (const Vector_t &r) const
void	setMisalignment (double x, double y, double s)
void	setMisalignment (const CoordinateSystemTrafo &cst)
void	getMisalignment (double &x, double &y, double &s) const
CoordinateSystemTrafo	getMisalignment () const
void	setActionRange (const std::queue< std::pair< double, double > > &range)
void	setCurrentSCoordinate (double s)
void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame. More...
double	getRotationAboutZ () const
void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...
double	getElementPosition () const
bool	isElementPositionSet () const
Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...
int	removeReference () const
	Decrement the reference count. More...
bool	isShared () const
	Test for sharing. More...

Private Member Functions
void	operator= (const PatchRep &)

Private Attributes
NullField	field
	The zero magnetic field. More...
NullGeometry	geometry
	The geometry. More...
Euclid3D	patch
	The geometry patch. More...

Additional Inherited Members
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
enum	ElementType {   ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,   BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,   CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,   DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,   LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,   MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,   PARALLELPLATE, PATCH, PROBE, RBEND,   RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,   RING, SBEND3D, SBEND, SBENDWRAPPER,   SEPARATOR, SEPTUM, SOLENOID, SOURCE,   STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY }
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)
Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r, double f=1) const
Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...
	RCObject (const RCObject &)
	Copy constructor. More...
virtual	~RCObject ()=0
RCObject &	operator= (const RCObject &right)
Protected Attributes inherited from Component
double	exit_face_slope_m
PartBunchBase< double, 3 > *	RefPartBunch_m
bool	online_m
Protected Attributes inherited from ElementBase
bool	shareFlag
CoordinateSystemTrafo	csTrafoGlobal2Local_m
CoordinateSystemTrafo	misalignment_m
std::pair< ApertureType, std::vector< double > >	aperture_m
double	elementEdge_m
double	rotationZAxis_m
Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Representation for a geometry patch.

Definition at line 33 of file PatchRep.h.

Constructor & Destructor Documentation

PatchRep::PatchRep ( const std::string &  name )

explicit

Constructor with given name.

Definition at line 85 of file PatchRep.cpp.

PatchRep::PatchRep

(

)

Definition at line 75 of file PatchRep.cpp.

Referenced by clone().

PatchRep::PatchRep

(

const PatchRep &

rhs

)

Definition at line 80 of file PatchRep.cpp.

PatchRep::~PatchRep ( )

virtual

Definition at line 90 of file PatchRep.cpp.

Member Function Documentation

ElementBase * PatchRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 94 of file PatchRep.cpp.

References PatchRep().

Here is the call graph for this function:

Channel * PatchRep::getChannel ( const std::string &  aKey, bool  create = false  )

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 99 of file PatchRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

NullField & PatchRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 110 of file PatchRep.cpp.

References field.

const NullField & PatchRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 114 of file PatchRep.cpp.

References field.

NullGeometry & PatchRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 119 of file PatchRep.cpp.

References geometry.

const NullGeometry & PatchRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 124 of file PatchRep.cpp.

References geometry.

ElementImage * PatchRep::getImage ( ) const

virtual

Construct an image.

Reimplemented from ElementBase.

Definition at line 145 of file PatchRep.cpp.

References ElementBase::getImage(), and AttributeSet::setAttribute().

Here is the call graph for this function:

const Euclid3D & PatchRep::getPatch ( ) const

virtual

Get patch.

Implements Patch.

Definition at line 129 of file PatchRep.cpp.

References patch.

double PatchRep::getVX

(

)

const

Get rotation.

Definition at line 171 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), and patch.

Here is the call graph for this function:

double PatchRep::getVY

(

)

const

Get rotation.

Definition at line 178 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), and patch.

Here is the call graph for this function:

double PatchRep::getVZ

(

)

const

Get rotation.

Definition at line 185 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), and patch.

Here is the call graph for this function:

double PatchRep::getX

(

)

const

Get displacement.

Definition at line 156 of file PatchRep.cpp.

References Euclid3D::getX(), and patch.

Here is the call graph for this function:

double PatchRep::getY

(

)

const

Get displacement.

Definition at line 161 of file PatchRep.cpp.

References Euclid3D::getY(), and patch.

Here is the call graph for this function:

double PatchRep::getZ

(

)

const

Get displacement.

Definition at line 166 of file PatchRep.cpp.

References Euclid3D::getZ(), and patch.

Here is the call graph for this function:

void PatchRep::operator= ( const PatchRep &  )

private

void PatchRep::setPatch

(

const Euclid3D &

euclid

)

Set patch.

Definition at line 134 of file PatchRep.cpp.

References patch.

Referenced by Flatten< Member >::handleBeamline(), OpalSRot::update(), OpalYRot::update(), and OpalPatch::update().

void PatchRep::setPatch	(	double	x,
		double	y,
		double	z,
		double	vx,
		double	vy,
		double	vz
	)

Set patch.

Definition at line 139 of file PatchRep.cpp.

References patch.

void PatchRep::setVX

(

double

v

)

Set rotation.

Definition at line 207 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), patch, and Euclid3D::setRotation().

Here is the call graph for this function:

void PatchRep::setVY

(

double

v

)

Set rotation.

Definition at line 215 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), patch, and Euclid3D::setRotation().

Here is the call graph for this function:

void PatchRep::setVZ

(

double

v

)

Set rotation.

Definition at line 223 of file PatchRep.cpp.

References Rotation3D::getAxis(), Euclid3D::getRotation(), patch, and Euclid3D::setRotation().

Here is the call graph for this function:

void PatchRep::setX

(

double

x

)

Set displacement.

Definition at line 192 of file PatchRep.cpp.

References patch, and Euclid3D::setX().

Here is the call graph for this function:

void PatchRep::setY

(

double

y

)

Set displacement.

Definition at line 197 of file PatchRep.cpp.

References patch, and Euclid3D::setY().

Here is the call graph for this function:

void PatchRep::setZ

(

double

z

)

Set displacement.

Definition at line 202 of file PatchRep.cpp.

References patch, and Euclid3D::setZ().

Here is the call graph for this function:

Member Data Documentation

NullField PatchRep::field

private

The zero magnetic field.

Definition at line 143 of file PatchRep.h.

Referenced by getField().

NullGeometry PatchRep::geometry

private

The geometry.

Definition at line 146 of file PatchRep.h.

Referenced by getGeometry().

Euclid3D PatchRep::patch

private

The geometry patch.

Definition at line 149 of file PatchRep.h.

Referenced by getPatch(), getVX(), getVY(), getVZ(), getX(), getY(), getZ(), setPatch(), setVX(), setVY(), setVZ(), setX(), setY(), and setZ().

---

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

• src/Classic/BeamlineCore/PatchRep.h
• src/Classic/BeamlineCore/PatchRep.cpp