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

ScorerMesh class for parser. More...

#include <scorermesh.h>

Inheritance diagram for GMAD::ScorerMesh:
Inheritance graph
Collaboration diagram for GMAD::ScorerMesh:
Collaboration graph

Public Member Functions

 ScorerMesh ()
 constructor More...
 
void clear ()
 reset 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< ScorerMesh >
bool NameExists (const std::string &name) const
 
Published< ScorerMesh >::template AttributeMap< T > & attribute_map () const
 

Data Fields

std::string name
 Name of this placement. More...
 
std::string scoreQuantity
 Name of scorer object to use. More...
 
std::string geometryType
 Name of scorermesh geometry to use. More...
 
int nx
 Number of bins in x. More...
 
int ny
 Number of bins in y. More...
 
int nz
 Number of bins in z. More...
 
int nr
 Number of bins in R. More...
 
int nphi
 Number of bins in Phi. More...
 
int ne
 Number of bins in E. More...
 
double xsize
 X total width. More...
 
double ysize
 Y total width. More...
 
double zsize
 Z total width. More...
 
double rsize
 R total length. More...
 
double eLow
 E Low limit. More...
 
double eHigh
 E High limit. More...
 
std::string eScale
 E scaling type. More...
 
std::string eBinsEdgesFilenamePath
 E bins edges filename path. More...
 
std::string sequence
 Name of sequence to place. More...
 
std::string referenceElement
 Name of reference element w.r.t. to place to. More...
 
int referenceElementNumber
 Index of repetition of element if there are multiple uses. More...
 
double s
 Curvilinear s position to place w.r.t.. More...
 
double x
 Offset in x. More...
 
double y
 Offset in y. More...
 
double z
 
bool axisAngle
 Flag to use the axis angle construction of rotation. More...
 
double phi
 Euler angle for rotation. More...
 
double theta
 Euler angle for rotation. More...
 
double psi
 Euler angle for rotation. More...
 
double axisX
 
double axisY
 
double axisZ
 
double angle
 

Private Member Functions

void PublishMembers ()
 publish members More...
 

Additional Inherited Members

- Protected Types inherited from GMAD::Published< ScorerMesh >
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< ScorerMesh >
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 (ScorerMesh *instance, const ScorerMesh *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 ScorerMesh *instance, const std::string &name) const
 Get method for class C. More...
 
void set (ScorerMesh *instance, const std::string &name, double value)
 
void set (ScorerMesh *instance, const std::string &name, GMAD::Array *const &value)
 
void set (ScorerMesh *instance, const std::string &name, const T &value)
 

Detailed Description

ScorerMesh class for parser.

Author
Laurie Nevay

Definition at line 37 of file scorermesh.h.

Constructor & Destructor Documentation

◆ ScorerMesh()

ScorerMesh::ScorerMesh ( )

constructor

Definition at line 23 of file scorermesh.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void ScorerMesh::clear ( )

reset

Definition at line 29 of file scorermesh.cc.

References angle, axisAngle, axisX, axisY, axisZ, eBinsEdgesFilenamePath, eHigh, eLow, eScale, geometryType, name, ne, nphi, nr, nx, ny, nz, phi, psi, referenceElement, referenceElementNumber, rsize, s, scoreQuantity, sequence, theta, x, xsize, y, ysize, z, and zsize.

Referenced by ScorerMesh().

Here is the caller graph for this function:

◆ print()

void ScorerMesh::print ( ) const

print some properties

Definition at line 102 of file scorermesh.cc.

References angle, axisAngle, axisX, axisY, axisZ, eHigh, eLow, eScale, name, ne, nx, ny, nz, phi, psi, referenceElement, referenceElementNumber, s, scoreQuantity, sequence, theta, x, xsize, y, ysize, z, and zsize.

◆ PublishMembers()

void ScorerMesh::PublishMembers ( )
private

publish members

Definition at line 66 of file scorermesh.cc.

References angle, axisAngle, axisX, axisY, axisZ, eBinsEdgesFilenamePath, eHigh, eLow, eScale, geometryType, name, ne, nphi, nr, nx, ny, nz, phi, psi, GMAD::Published< ScorerMesh >::publish(), referenceElement, referenceElementNumber, rsize, s, scoreQuantity, sequence, theta, x, xsize, y, ysize, z, and zsize.

Referenced by ScorerMesh().

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

◆ set_value()

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

set methods by property name and value

Definition at line 96 of file scorermesh.h.

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

Here is the call graph for this function:

Field Documentation

◆ angle

double GMAD::ScorerMesh::angle

Axis angle rotation.

Definition at line 76 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisAngle

bool GMAD::ScorerMesh::axisAngle

Flag to use the axis angle construction of rotation.

Definition at line 78 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisX

double GMAD::ScorerMesh::axisX

Axis angle rotation.

Definition at line 73 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisY

double GMAD::ScorerMesh::axisY

Axis angle rotation.

Definition at line 74 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisZ

double GMAD::ScorerMesh::axisZ

Axis angle rotation.

Definition at line 75 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ eBinsEdgesFilenamePath

std::string GMAD::ScorerMesh::eBinsEdgesFilenamePath

E bins edges filename path.

Definition at line 57 of file scorermesh.h.

Referenced by clear(), and PublishMembers().

◆ eHigh

double GMAD::ScorerMesh::eHigh

E High limit.

Definition at line 55 of file scorermesh.h.

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

◆ eLow

double GMAD::ScorerMesh::eLow

E Low limit.

Definition at line 54 of file scorermesh.h.

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

◆ eScale

std::string GMAD::ScorerMesh::eScale

E scaling type.

Definition at line 56 of file scorermesh.h.

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

◆ geometryType

std::string GMAD::ScorerMesh::geometryType

Name of scorermesh geometry to use.

Definition at line 42 of file scorermesh.h.

Referenced by clear(), and PublishMembers().

◆ name

std::string GMAD::ScorerMesh::name

Name of this placement.

Definition at line 40 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ ne

int GMAD::ScorerMesh::ne

Number of bins in E.

Definition at line 49 of file scorermesh.h.

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

◆ nphi

int GMAD::ScorerMesh::nphi

Number of bins in Phi.

Definition at line 48 of file scorermesh.h.

Referenced by clear(), and PublishMembers().

◆ nr

int GMAD::ScorerMesh::nr

Number of bins in R.

Definition at line 47 of file scorermesh.h.

Referenced by clear(), and PublishMembers().

◆ nx

int GMAD::ScorerMesh::nx

Number of bins in x.

Definition at line 44 of file scorermesh.h.

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

◆ ny

int GMAD::ScorerMesh::ny

Number of bins in y.

Definition at line 45 of file scorermesh.h.

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

◆ nz

int GMAD::ScorerMesh::nz

Number of bins in z.

Definition at line 46 of file scorermesh.h.

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

◆ phi

double GMAD::ScorerMesh::phi

Euler angle for rotation.

Definition at line 68 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ psi

double GMAD::ScorerMesh::psi

Euler angle for rotation.

Definition at line 70 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ referenceElement

std::string GMAD::ScorerMesh::referenceElement

Name of reference element w.r.t. to place to.

Definition at line 61 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ referenceElementNumber

int GMAD::ScorerMesh::referenceElementNumber

Index of repetition of element if there are multiple uses.

Definition at line 62 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ rsize

double GMAD::ScorerMesh::rsize

R total length.

Definition at line 53 of file scorermesh.h.

Referenced by clear(), and PublishMembers().

◆ s

double GMAD::ScorerMesh::s

Curvilinear s position to place w.r.t..

Definition at line 63 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ scoreQuantity

std::string GMAD::ScorerMesh::scoreQuantity

Name of scorer object to use.

Definition at line 41 of file scorermesh.h.

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

◆ sequence

std::string GMAD::ScorerMesh::sequence

Name of sequence to place.

Definition at line 60 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ theta

double GMAD::ScorerMesh::theta

Euler angle for rotation.

Definition at line 69 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ x

double GMAD::ScorerMesh::x

Offset in x.

Definition at line 64 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ xsize

double GMAD::ScorerMesh::xsize

X total width.

Definition at line 50 of file scorermesh.h.

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

◆ y

double GMAD::ScorerMesh::y

Offset in y.

Definition at line 65 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ ysize

double GMAD::ScorerMesh::ysize

Y total width.

Definition at line 51 of file scorermesh.h.

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

◆ z

double GMAD::ScorerMesh::z

Offset in z.

Definition at line 66 of file scorermesh.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ zsize

double GMAD::ScorerMesh::zsize

Z total width.

Definition at line 52 of file scorermesh.h.

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


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