BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions | Data Fields
GMAD::CavityModel Class Reference

RF CavityModel class for parser. More...

#include <cavitymodel.h>

Inheritance diagram for GMAD::CavityModel:
Inheritance graph
Collaboration diagram for GMAD::CavityModel:
Collaboration graph

Public Member Functions

 CavityModel ()
 constructor More...
 
void clear ()
 reset More...
 
void PublishMembers ()
 publish members More...
 
void print () const
 print some properties More...
 
template<typename T >
void set_value (std::string property, T value)
 set methods by property name and value More...
 
- Public Member Functions inherited from GMAD::Published< CavityModel >
bool NameExists (const std::string &name) const
 
Published< CavityModel >::template AttributeMap< T > & attribute_map () const
 

Data Fields

std::string name
 name More...
 
std::string type
 geometry type More...
 
std::string material
 material name More...
 
double irisRadius
 iris radius More...
 
double equatorRadius
 equator radius More...
 
double halfCellLength
 half cell length More...
 
double equatorHorizontalAxis
 equator ellipse vertical semi axis; More...
 
double equatorVerticalAxis
 equator ellipse horizontal semi axis; More...
 
double irisHorizontalAxis
 iris horizontal axis More...
 
double irisVerticalAxis
 Iris axis. More...
 
double tangentLineAngle
 tangent angle More...
 
double thickness
 thickness More...
 
int numberOfPoints
 
int numberOfCells
 number of cells per cavity More...
 

Additional Inherited Members

- Protected Types inherited from GMAD::Published< CavityModel >
using AttributeMap = typename std::unordered_map< std::string, T C::* >
 Define AttributeMap of string and class member pointer. More...
 
- Protected Member Functions inherited from GMAD::Published< CavityModel >
void publish (const std::string &name, T C::*mp)
 Make pointer to member from class C and type T with accessible with a name. More...
 
void set (CavityModel *instance, const CavityModel *instance2, const std::string &name)
 Set member with name of class instance to value of second instance. More...
 
AttributeMap< T > & attribute_map () const
 Access method to static map for type T and class C.
 
get (const CavityModel *instance, const std::string &name) const
 Get method for class C. More...
 
void set (CavityModel *instance, const std::string &name, double value)
 
void set (CavityModel *instance, const std::string &name, GMAD::Array *const &value)
 
void set (CavityModel *instance, const std::string &name, const T &value)
 

Detailed Description

RF CavityModel class for parser.

Author
Jochem Snuverink

Definition at line 35 of file cavitymodel.h.

Constructor & Destructor Documentation

◆ CavityModel()

CavityModel::CavityModel ( )

constructor

Definition at line 23 of file cavitymodel.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void CavityModel::clear ( )

reset

Definition at line 29 of file cavitymodel.cc.

References equatorHorizontalAxis, equatorRadius, equatorVerticalAxis, halfCellLength, irisHorizontalAxis, irisRadius, irisVerticalAxis, material, name, numberOfCells, numberOfPoints, tangentLineAngle, thickness, and type.

Referenced by CavityModel().

Here is the caller graph for this function:

◆ print()

void CavityModel::print ( ) const

◆ PublishMembers()

void CavityModel::PublishMembers ( )

publish members

Definition at line 47 of file cavitymodel.cc.

References equatorHorizontalAxis, equatorRadius, equatorVerticalAxis, halfCellLength, irisHorizontalAxis, irisRadius, irisVerticalAxis, material, name, numberOfCells, numberOfPoints, GMAD::Published< CavityModel >::publish(), tangentLineAngle, thickness, and type.

Referenced by CavityModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_value()

template<typename T >
void GMAD::CavityModel::set_value ( std::string  property,
value 
)

set methods by property name and value

Definition at line 70 of file cavitymodel.h.

References GMAD::Published< CavityModel >::set().

Here is the call graph for this function:

Field Documentation

◆ equatorHorizontalAxis

double GMAD::CavityModel::equatorHorizontalAxis

equator ellipse vertical semi axis;

Definition at line 43 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ equatorRadius

double GMAD::CavityModel::equatorRadius

equator radius

Definition at line 41 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ equatorVerticalAxis

double GMAD::CavityModel::equatorVerticalAxis

equator ellipse horizontal semi axis;

Definition at line 44 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ halfCellLength

double GMAD::CavityModel::halfCellLength

half cell length

Definition at line 42 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ irisHorizontalAxis

double GMAD::CavityModel::irisHorizontalAxis

iris horizontal axis

Definition at line 45 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ irisRadius

double GMAD::CavityModel::irisRadius

iris radius

Definition at line 40 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ irisVerticalAxis

double GMAD::CavityModel::irisVerticalAxis

Iris axis.

Definition at line 46 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ material

std::string GMAD::CavityModel::material

material name

Definition at line 39 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ name

std::string GMAD::CavityModel::name

name

Definition at line 37 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ numberOfCells

int GMAD::CavityModel::numberOfCells

number of cells per cavity

Definition at line 54 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ numberOfPoints

int GMAD::CavityModel::numberOfPoints

number of points that will be used to make the cell shape more will be more accurate but will also increase tracking time

Definition at line 52 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ tangentLineAngle

double GMAD::CavityModel::tangentLineAngle

tangent angle

Definition at line 47 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ thickness

double GMAD::CavityModel::thickness

thickness

Definition at line 48 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().

◆ type

std::string GMAD::CavityModel::type

geometry type

Definition at line 38 of file cavitymodel.h.

Referenced by clear(), print(), and PublishMembers().


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