#include <MultipoleTConfig.h>
Public Attributes | |
| unsigned int | maxFOrder_m {3} |
| unsigned int | maxXOrder_m {20} |
| Kokkos::Array< double, NumPoles > | transverseProfile_m {} |
| unsigned int | transverseProfileMaxOrder_m {1} |
| double | length_m {1.0} |
| double | entranceAngle_m {0.0} |
| double | rotation_m {0.0} |
| double | bendAngle_m {0.0} |
| bool | variableRadius_m {false} |
| double | entryOffset_m {0.0} |
| double | verticalAperture_m {0.5} |
| double | horizontalAperture_m {0.5} |
| double | boundingBoxLength_m {0.0} |
| double | fringeS0_m |
| double | fringeLambdaLeft_m |
| double | fringeLambdaRight_m |
Static Public Attributes | |
| static constexpr unsigned int | NumPoles = 6 |
Detailed Description
A structure containing the magnet configuration parameters
Definition at line 24 of file MultipoleTConfig.h.
Member Data Documentation
◆ bendAngle_m
| double MultipoleTConfig::bendAngle_m {0.0} |
Definition at line 37 of file MultipoleTConfig.h.
Referenced by MultipoleT::bends(), MultipoleT::chooseImplementation(), MultipoleTCurvedConstRadius::computeBField(), MultipoleT::getBendAngle(), MultipoleT::setBendAngle(), and MultipoleTCurvedConstRadius::toMagnetCoords().
◆ boundingBoxLength_m
| double MultipoleTConfig::boundingBoxLength_m {0.0} |
Definition at line 43 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getBoundingBoxLength(), and MultipoleT::setBoundingBoxLength().
◆ entranceAngle_m
| double MultipoleTConfig::entranceAngle_m {0.0} |
Definition at line 35 of file MultipoleTConfig.h.
Referenced by MultipoleT::getEntranceAngle(), MultipoleTBase::rotateFrame(), and MultipoleT::setEntranceAngle().
◆ entryOffset_m
| double MultipoleTConfig::entryOffset_m {0.0} |
Definition at line 39 of file MultipoleTConfig.h.
Referenced by MultipoleT::getEntryOffset(), and MultipoleT::setEntryOffset().
◆ fringeLambdaLeft_m
| double MultipoleTConfig::fringeLambdaLeft_m |
Definition at line 46 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getFringeField(), and MultipoleT::setFringeField().
◆ fringeLambdaRight_m
| double MultipoleTConfig::fringeLambdaRight_m |
Definition at line 47 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getFringeField(), and MultipoleT::setFringeField().
◆ fringeS0_m
| double MultipoleTConfig::fringeS0_m |
Fringe field parameters
Definition at line 45 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getFringeField(), and MultipoleT::setFringeField().
◆ horizontalAperture_m
| double MultipoleTConfig::horizontalAperture_m {0.5} |
Definition at line 42 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getAperture(), and MultipoleT::setAperture().
◆ length_m
| double MultipoleTConfig::length_m {1.0} |
Magnet parameters
Definition at line 34 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleT::getLength(), MultipoleT::setElementLength(), MultipoleTCurvedConstRadius::toMagnetCoords(), and MultipoleTStraight::toMagnetCoords().
◆ maxFOrder_m
| unsigned int MultipoleTConfig::maxFOrder_m {3} |
Number of terms in z expansion used in calculating field components
Definition at line 26 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getMaxFOrder(), MultipoleT::setMaxOrder(), and MultipoleT::validateConfiguration().
◆ maxXOrder_m
| unsigned int MultipoleTConfig::maxXOrder_m {20} |
Highest order of polynomial expansions in x
Definition at line 28 of file MultipoleTConfig.h.
Referenced by MultipoleT::getMaxXOrder(), and MultipoleT::setMaxOrder().
◆ NumPoles
|
staticconstexpr |
List of transverse profile coefficients
Definition at line 30 of file MultipoleTConfig.h.
Referenced by MultipoleTBase::calcTransverseDerivatives(), MultipoleT::setTransProfile(), and TEST_F().
◆ rotation_m
| double MultipoleTConfig::rotation_m {0.0} |
Definition at line 36 of file MultipoleTConfig.h.
Referenced by MultipoleT::getRotation(), MultipoleTBase::rotateFrame(), and MultipoleT::setRotation().
◆ transverseProfile_m
| Kokkos::Array<double, NumPoles> MultipoleTConfig::transverseProfile_m {} |
Definition at line 31 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getTransProfile(), and MultipoleT::setTransProfile().
◆ transverseProfileMaxOrder_m
| unsigned int MultipoleTConfig::transverseProfileMaxOrder_m {1} |
Definition at line 32 of file MultipoleTConfig.h.
Referenced by MultipoleT::getTransMaxOrder(), and MultipoleT::setTransProfile().
◆ variableRadius_m
| bool MultipoleTConfig::variableRadius_m {false} |
Definition at line 38 of file MultipoleTConfig.h.
Referenced by MultipoleT::getVariableRadius(), and MultipoleT::setBendAngle().
◆ verticalAperture_m
| double MultipoleTConfig::verticalAperture_m {0.5} |
Define the zone in which the field is calculated
Definition at line 41 of file MultipoleTConfig.h.
Referenced by MultipoleTCurvedConstRadius::computeBField(), MultipoleTStraight::computeBField(), MultipoleT::getAperture(), and MultipoleT::setAperture().
The documentation for this struct was generated from the following file:
