Cooling channel parameters. More...

#include <coolingchannel.h>

Inheritance diagram for GMAD::CoolingChannel:

Collaboration diagram for GMAD::CoolingChannel:

Public Member Functions
	CoolingChannel ()
	Constructor.

void	clear ()
	Reset.

void	print () const
	Print some properties.

template<typename T >
void	set_value (const std::string &property, T value)
	Set methods by property name and value.

void	set_value (const std::string &property, Array *value)
	Set method for lists.

Public Member Functions inherited from GMAD::Published< CoolingChannel >
bool	NameExists (const std::string &name) const

Published< CoolingChannel >::template AttributeMap< T > &	attribute_map () const

Data Fields
std::string	name
	Object name.

std::string	surroundingMaterial

int	nCells

double	cellLengthZ

int	nCoils

std::list< double >	coilInnerRadius

std::list< double >	coilRadialThickness

std::list< double >	coilLengthZ

std::list< double >	coilCurrent

std::list< double >	coilOffsetZ

std::list< std::string >	coilMaterial

bool	mirrorCoils

double	onAxisTolerance

int	nSheets

int	nDipoles

std::list< double >	dipoleAperture

std::list< double >	dipoleLengthZ

std::list< double >	dipoleFieldStrength

std::list< double >	dipoleEngeCoefficient

std::list< double >	dipoleOffsetZ

int	nAbsorbers

std::list< std::string >	absorberType

std::list< std::string >	absorberMaterial

std::list< double >	absorberOffsetZ

std::list< double >	absorberCylinderLength

std::list< double >	absorberCylinderRadius

std::list< double >	absorberWedgeOpeningAngle

std::list< double >	absorberWedgeHeight

std::list< double >	absorberWedgeRotationAngle

std::list< double >	absorberWedgeOffsetX

std::list< double >	absorberWedgeOffsetY

std::list< double >	absorberWedgeApexToBase

int	nRFCavities

std::list< double >	rfOffsetZ

std::list< double >	rfLength

std::list< double >	rfVoltage

std::list< double >	rfPhase

std::list< double >	rfFrequency

std::list< double >	rfWindowThickness

std::list< std::string >	rfWindowMaterial

std::list< double >	rfWindowRadius

std::list< std::string >	rfCavityMaterial

std::list< std::string >	rfCavityVacuumMaterial

std::list< double >	rfCavityRadius

std::list< double >	rfCavityThickness

std::list< double >	rfTimeOffset

std::string	integrator

std::string	magneticFieldModel

std::string	electricFieldModel

std::string	dipoleFieldModel

Private Member Functions
void	PublishMembers ()
	publish members

Private Attributes
std::map< std::string, std::list< double > * >	attribute_map_list_double

std::map< std::string, std::list< std::string > * >	attribute_map_list_string

Additional Inherited Members
Protected Types inherited from GMAD::Published< CoolingChannel >
using	AttributeMap = typename std::unordered_map< std::string, T C::* >
	Define AttributeMap of string and class member pointer.

Protected Member Functions inherited from GMAD::Published< CoolingChannel >
void	publish (const std::string &name, T C::*mp)
	Make pointer to member from class C and type T with accessible with a name.

void	set (CoolingChannel instance, const CoolingChannel instance2, const std::string &name)
	Set member with name of class instance to value of second instance.

AttributeMap< T > &	attribute_map () const
	Access method to static map for type T and class C.

T	get (const CoolingChannel *instance, const std::string &name) const
	Get method for class C.

void	set (CoolingChannel *instance, const std::string &name, double value)

void	set (CoolingChannel instance, const std::string &name, GMAD::Array const &value)

void	set (CoolingChannel *instance, const std::string &name, const T &value)

Detailed Description

Cooling channel parameters.

Author: Laurie Nevay

Definition at line 38 of file coolingchannel.h.

Constructor & Destructor Documentation

◆ CoolingChannel()

CoolingChannel::CoolingChannel ( )

Constructor.

Definition at line 23 of file coolingchannel.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void CoolingChannel::clear ( )

Reset.

Definition at line 29 of file coolingchannel.cc.

References name.

Referenced by CoolingChannel().

Here is the caller graph for this function:

◆ print()

void CoolingChannel::print ( ) const

Print some properties.

Definition at line 189 of file coolingchannel.cc.

References name.

◆ PublishMembers()

void CoolingChannel::PublishMembers ( )

private

publish members

Definition at line 89 of file coolingchannel.cc.

References name, and GMAD::Published< CoolingChannel >::publish().

Referenced by CoolingChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_value() [1/2]

void CoolingChannel::set_value	(	const std::string &	property,
		Array *	value
	)

Set method for lists.

Definition at line 254 of file coolingchannel.cc.

References GMAD::Array::set_vector().

Here is the call graph for this function:

◆ set_value() [2/2]

template<typename T >

void GMAD::CoolingChannel::set_value	(	const std::string &	property,
		T	value
	)

Set methods by property name and value.

Definition at line 121 of file coolingchannel.h.

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

Here is the call graph for this function:

Field Documentation

◆ absorberCylinderLength

std::list<double> GMAD::CoolingChannel::absorberCylinderLength

Definition at line 70 of file coolingchannel.h.

◆ absorberCylinderRadius

std::list<double> GMAD::CoolingChannel::absorberCylinderRadius

Definition at line 71 of file coolingchannel.h.

◆ absorberMaterial

std::list<std::string> GMAD::CoolingChannel::absorberMaterial

Definition at line 68 of file coolingchannel.h.

◆ absorberOffsetZ

std::list<double> GMAD::CoolingChannel::absorberOffsetZ

Definition at line 69 of file coolingchannel.h.

◆ absorberType

std::list<std::string> GMAD::CoolingChannel::absorberType

Definition at line 67 of file coolingchannel.h.

◆ absorberWedgeApexToBase

std::list<double> GMAD::CoolingChannel::absorberWedgeApexToBase

Definition at line 77 of file coolingchannel.h.

◆ absorberWedgeHeight

std::list<double> GMAD::CoolingChannel::absorberWedgeHeight

Definition at line 73 of file coolingchannel.h.

◆ absorberWedgeOffsetX

std::list<double> GMAD::CoolingChannel::absorberWedgeOffsetX

Definition at line 75 of file coolingchannel.h.

◆ absorberWedgeOffsetY

std::list<double> GMAD::CoolingChannel::absorberWedgeOffsetY

Definition at line 76 of file coolingchannel.h.

◆ absorberWedgeOpeningAngle

std::list<double> GMAD::CoolingChannel::absorberWedgeOpeningAngle

Definition at line 72 of file coolingchannel.h.

◆ absorberWedgeRotationAngle

std::list<double> GMAD::CoolingChannel::absorberWedgeRotationAngle

Definition at line 74 of file coolingchannel.h.

◆ attribute_map_list_double

std::map<std::string, std::list<double>*> GMAD::CoolingChannel::attribute_map_list_double

private

Definition at line 116 of file coolingchannel.h.

◆ attribute_map_list_string

std::map<std::string, std::list<std::string>*> GMAD::CoolingChannel::attribute_map_list_string

private

Definition at line 117 of file coolingchannel.h.

◆ cellLengthZ

double GMAD::CoolingChannel::cellLengthZ

Definition at line 46 of file coolingchannel.h.

◆ coilCurrent

std::list<double> GMAD::CoolingChannel::coilCurrent

Definition at line 52 of file coolingchannel.h.

◆ coilInnerRadius

std::list<double> GMAD::CoolingChannel::coilInnerRadius

Definition at line 49 of file coolingchannel.h.

◆ coilLengthZ

std::list<double> GMAD::CoolingChannel::coilLengthZ

Definition at line 51 of file coolingchannel.h.

◆ coilMaterial

std::list<std::string> GMAD::CoolingChannel::coilMaterial

Definition at line 54 of file coolingchannel.h.

◆ coilOffsetZ

std::list<double> GMAD::CoolingChannel::coilOffsetZ

Definition at line 53 of file coolingchannel.h.

◆ coilRadialThickness

std::list<double> GMAD::CoolingChannel::coilRadialThickness

Definition at line 50 of file coolingchannel.h.

◆ dipoleAperture

std::list<double> GMAD::CoolingChannel::dipoleAperture

Definition at line 60 of file coolingchannel.h.

◆ dipoleEngeCoefficient

std::list<double> GMAD::CoolingChannel::dipoleEngeCoefficient

Definition at line 63 of file coolingchannel.h.

◆ dipoleFieldModel

std::string GMAD::CoolingChannel::dipoleFieldModel

Definition at line 97 of file coolingchannel.h.

◆ dipoleFieldStrength

std::list<double> GMAD::CoolingChannel::dipoleFieldStrength

Definition at line 62 of file coolingchannel.h.

◆ dipoleLengthZ

std::list<double> GMAD::CoolingChannel::dipoleLengthZ

Definition at line 61 of file coolingchannel.h.

◆ dipoleOffsetZ

std::list<double> GMAD::CoolingChannel::dipoleOffsetZ

Definition at line 64 of file coolingchannel.h.

◆ electricFieldModel

std::string GMAD::CoolingChannel::electricFieldModel

Definition at line 96 of file coolingchannel.h.

◆ integrator

std::string GMAD::CoolingChannel::integrator

Definition at line 94 of file coolingchannel.h.

◆ magneticFieldModel

std::string GMAD::CoolingChannel::magneticFieldModel

Definition at line 95 of file coolingchannel.h.

◆ mirrorCoils

bool GMAD::CoolingChannel::mirrorCoils

Definition at line 55 of file coolingchannel.h.

◆ nAbsorbers

int GMAD::CoolingChannel::nAbsorbers

Definition at line 66 of file coolingchannel.h.

◆ name

std::string GMAD::CoolingChannel::name

Object name.

Definition at line 41 of file coolingchannel.h.

Referenced by BDS::BuildMuonCooler(), BDS::BuildMuonCoolerAbsorberInfo(), BDS::BuildMuonCoolerCoilInfos(), clear(), print(), and PublishMembers().

◆ nCells

int GMAD::CoolingChannel::nCells

Definition at line 45 of file coolingchannel.h.

◆ nCoils

int GMAD::CoolingChannel::nCoils

Definition at line 48 of file coolingchannel.h.

◆ nDipoles

int GMAD::CoolingChannel::nDipoles

Definition at line 59 of file coolingchannel.h.

◆ nRFCavities

int GMAD::CoolingChannel::nRFCavities

Definition at line 79 of file coolingchannel.h.

◆ nSheets

int GMAD::CoolingChannel::nSheets

Definition at line 57 of file coolingchannel.h.

◆ onAxisTolerance

double GMAD::CoolingChannel::onAxisTolerance

Definition at line 56 of file coolingchannel.h.

◆ rfCavityMaterial

std::list<std::string> GMAD::CoolingChannel::rfCavityMaterial

Definition at line 88 of file coolingchannel.h.

◆ rfCavityRadius

std::list<double> GMAD::CoolingChannel::rfCavityRadius

Definition at line 90 of file coolingchannel.h.

◆ rfCavityThickness

std::list<double> GMAD::CoolingChannel::rfCavityThickness

Definition at line 91 of file coolingchannel.h.

◆ rfCavityVacuumMaterial

std::list<std::string> GMAD::CoolingChannel::rfCavityVacuumMaterial

Definition at line 89 of file coolingchannel.h.

◆ rfFrequency

std::list<double> GMAD::CoolingChannel::rfFrequency

Definition at line 84 of file coolingchannel.h.

◆ rfLength

std::list<double> GMAD::CoolingChannel::rfLength

Definition at line 81 of file coolingchannel.h.

◆ rfOffsetZ

std::list<double> GMAD::CoolingChannel::rfOffsetZ

Definition at line 80 of file coolingchannel.h.

◆ rfPhase

std::list<double> GMAD::CoolingChannel::rfPhase

Definition at line 83 of file coolingchannel.h.

◆ rfTimeOffset

std::list<double> GMAD::CoolingChannel::rfTimeOffset

Definition at line 92 of file coolingchannel.h.

◆ rfVoltage

std::list<double> GMAD::CoolingChannel::rfVoltage

Definition at line 82 of file coolingchannel.h.

◆ rfWindowMaterial

std::list<std::string> GMAD::CoolingChannel::rfWindowMaterial

Definition at line 86 of file coolingchannel.h.

◆ rfWindowRadius

std::list<double> GMAD::CoolingChannel::rfWindowRadius

Definition at line 87 of file coolingchannel.h.

◆ rfWindowThickness

std::list<double> GMAD::CoolingChannel::rfWindowThickness

Definition at line 85 of file coolingchannel.h.

◆ surroundingMaterial

std::string GMAD::CoolingChannel::surroundingMaterial

Definition at line 43 of file coolingchannel.h.

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

/__w/bdsim/bdsim/parser/coolingchannel.h
/__w/bdsim/bdsim/parser/coolingchannel.cc

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CoolingChannel()

Member Function Documentation

◆ clear()

◆ print()

◆ PublishMembers()

◆ set_value() [1/2]

◆ set_value() [2/2]

Field Documentation

◆ absorberCylinderLength

◆ absorberCylinderRadius

◆ absorberMaterial

◆ absorberOffsetZ

◆ absorberType

◆ absorberWedgeApexToBase

◆ absorberWedgeHeight

◆ absorberWedgeOffsetX

◆ absorberWedgeOffsetY

◆ absorberWedgeOpeningAngle

◆ absorberWedgeRotationAngle

◆ attribute_map_list_double

◆ attribute_map_list_string

◆ cellLengthZ

◆ coilCurrent

◆ coilInnerRadius

◆ coilLengthZ

◆ coilMaterial

◆ coilOffsetZ

◆ coilRadialThickness

◆ dipoleAperture

◆ dipoleEngeCoefficient

◆ dipoleFieldModel

◆ dipoleFieldStrength

◆ dipoleLengthZ

◆ dipoleOffsetZ

◆ electricFieldModel

◆ integrator

◆ magneticFieldModel

◆ mirrorCoils

◆ nAbsorbers

◆ name

◆ nCells

◆ nCoils

◆ nDipoles

◆ nRFCavities

◆ nSheets

◆ onAxisTolerance

◆ rfCavityMaterial

◆ rfCavityRadius

◆ rfCavityThickness

◆ rfCavityVacuumMaterial

◆ rfFrequency

◆ rfLength

◆ rfOffsetZ

◆ rfPhase

◆ rfTimeOffset

◆ rfVoltage

◆ rfWindowMaterial

◆ rfWindowRadius

◆ rfWindowThickness

◆ surroundingMaterial