Commit cb4eaa54 authored by snuverink_j's avatar snuverink_j

spelling fixes and add some comments

parent a48c0f81
...@@ -41,6 +41,7 @@ set (CMAKE_CXX_STANDARD 11) ...@@ -41,6 +41,7 @@ set (CMAKE_CXX_STANDARD 11)
set (CMAKE_CXX_STANDARD_REQUIRED ON) set (CMAKE_CXX_STANDARD_REQUIRED ON)
set (CMAKE_CXX_EXTENSIONS OFF) set (CMAKE_CXX_EXTENSIONS OFF)
# Disable compile time assert (used by IPPL)
add_definitions (-DNOCTAssert) add_definitions (-DNOCTAssert)
add_compile_options (-Wall) add_compile_options (-Wall)
...@@ -171,7 +172,7 @@ if (ENABLE_AMR) ...@@ -171,7 +172,7 @@ if (ENABLE_AMR)
endif () endif ()
option (ENABLE_AMR_MG_SOLVER "Enable AMR MG solver" OFF) option (ENABLE_AMR_MG_SOLVER "Enable AMR MG solver" OFF)
option (ENABLE_SAAMG_SOLVER "Enable iteartive SA-AMG-PCG self field solver" OFF) option (ENABLE_SAAMG_SOLVER "Enable iterative SA-AMG-PCG self field solver" OFF)
if (ENABLE_SAAMG_SOLVER OR ENABLE_AMR_MG_SOLVER) if (ENABLE_SAAMG_SOLVER OR ENABLE_AMR_MG_SOLVER)
# #
# :FIXME: We have to add checks whether the required Trilinos modules # :FIXME: We have to add checks whether the required Trilinos modules
......
# #
# Find gtest Google Test includes and library # Find gtest Google Test includes and library
# #
# gtest
# It can be found at:
# http://amas.web.psi.ch/tools/GSL/index.html
#
# GTEST_INCLUDE_DIR - where to find gtest/gtest.h # GTEST_INCLUDE_DIR - where to find gtest/gtest.h
# GTEST_LIBRARY - libgtest.a path # GTEST_LIBRARY - libgtest.a path
# GTEST_MAIN_LIBRARY - libgtest_main.a path # GTEST_MAIN_LIBRARY - libgtest_main.a path
......
...@@ -180,7 +180,7 @@ void RFCavity::initialise(PartBunchBase<double, 3> *bunch, double &startField, d ...@@ -180,7 +180,7 @@ void RFCavity::initialise(PartBunchBase<double, 3> *bunch, double &startField, d
fieldmap_m->getFieldDimensions(startField_m, endField); fieldmap_m->getFieldDimensions(startField_m, endField);
if (endField <= startField_m) { if (endField <= startField_m) {
throw GeneralClassicException("RFCavity::initialise", throw GeneralClassicException("RFCavity::initialise",
"The length of the field map '" + filename_m + "' is zero or negativ"); "The length of the field map '" + filename_m + "' is zero or negative");
} }
msg << level2 << getName() << " using file "; msg << level2 << getName() << " using file ";
......
...@@ -30,8 +30,8 @@ class Fieldmap; ...@@ -30,8 +30,8 @@ class Fieldmap;
// Class TravelingWave // Class TravelingWave
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
/// Interface for RF cavity. /// Interface for Traveling Wave.
// Class TravelingWave defines the abstract interface for RF cavities. // Class TravelingWave defines the abstract interface for Traveling Wave.
class TravelingWave: public RFCavity { class TravelingWave: public RFCavity {
......
...@@ -81,8 +81,8 @@ public: ...@@ -81,8 +81,8 @@ public:
// The beam line to be tracked is [b]bl[/b]. // The beam line to be tracked is [b]bl[/b].
// The particle reference data are taken from [b]data[/b]. // The particle reference data are taken from [b]data[/b].
// The particle bunch is initially empty. // The particle bunch is initially empty.
// If [b]revBeam[/b] is true, the beam runs from s = C to s = 0. // If [b]backBeam[/b] is true, the beam runs from s = C to s = 0.
// If [b]revTrack[/b] is true, we track against the beam. // If [b]backTrack[/b] is true, we track against the beam.
Tracker(const Beamline &, const PartData &, Tracker(const Beamline &, const PartData &,
bool backBeam, bool backTrack); bool backBeam, bool backTrack);
...@@ -90,8 +90,8 @@ public: ...@@ -90,8 +90,8 @@ public:
// The beam line to be tracked is [b]bl[/b]. // The beam line to be tracked is [b]bl[/b].
// The particle reference data are taken from [b]data[/b]. // The particle reference data are taken from [b]data[/b].
// The particle bunch is taken from [b]bunch[/b]. // The particle bunch is taken from [b]bunch[/b].
// If [b]revBeam[/b] is true, the beam runs from s = C to s = 0. // If [b]backBeam[/b] is true, the beam runs from s = C to s = 0.
// If [b]revTrack[/b] is true, we track against the beam. // If [b]backTrack[/b] is true, we track against the beam.
Tracker(const Beamline &, PartBunchBase<double, 3> *bunch, Tracker(const Beamline &, PartBunchBase<double, 3> *bunch,
const PartData &, bool backBeam, bool backTrack); const PartData &, bool backBeam, bool backTrack);
......
...@@ -122,7 +122,7 @@ class PPSolveFactory { ...@@ -122,7 +122,7 @@ class PPSolveFactory {
void getDerivPoints(); void getDerivPoints();
void getDerivs(Mesh::Iterator it); void getDerivs(Mesh::Iterator it);
// nothing calls this method but I don't quite field brave enought to remove // nothing calls this method but I don't quite feel brave enough to remove
// it... // it...
std::vector<double> outOfBoundsPosition(Mesh::Iterator outOfBoundsIt); std::vector<double> outOfBoundsPosition(Mesh::Iterator outOfBoundsIt);
static void nearbyPointsRecursive( static void nearbyPointsRecursive(
......
...@@ -25,7 +25,7 @@ ...@@ -25,7 +25,7 @@
OpalFlexibleCollimator::OpalFlexibleCollimator(): OpalFlexibleCollimator::OpalFlexibleCollimator():
OpalElement(SIZE, "FLEXIBLECOLLIMATOR", OpalElement(SIZE, "FLEXIBLECOLLIMATOR",
"The \"FLEXIBLECOLLIMATOR\" element defines a slit."), "The \"FLEXIBLECOLLIMATOR\" element defines a flexible collimator."),
partMatInt_m(NULL) { partMatInt_m(NULL) {
itsAttr[FNAME] = Attributes::makeString itsAttr[FNAME] = Attributes::makeString
("FNAME", "File name containing description of holes"); ("FNAME", "File name containing description of holes");
......
// //
// Class OpalPepperPot // Class OpalPepperPot
// The PEPPERPOT element. // The PEPPERPOT element.
// The class of OPAL elliptic collimators. // The class of OPAL pepperpot collimators.
// //
// Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland // Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved // All rights reserved
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
OpalPepperPot::OpalPepperPot(): OpalPepperPot::OpalPepperPot():
OpalElement(SIZE, "PEPPERPOT", OpalElement(SIZE, "PEPPERPOT",
"The \"PEPPERPOT\" element defines an elliptic collimator."), "The \"PEPPERPOT\" element defines an pepperpot collimator."),
parmatint_m(NULL) { parmatint_m(NULL) {
itsAttr[XSIZE] = Attributes::makeReal itsAttr[XSIZE] = Attributes::makeReal
("XSIZE", "Size in x of the pepperpot in m"); ("XSIZE", "Size in x of the pepperpot in m");
......
...@@ -125,12 +125,12 @@ namespace Expressions { ...@@ -125,12 +125,12 @@ namespace Expressions {
this->getImage() + "\": " + ex.what()); this->getImage() + "\": " + ex.what());
} catch(std::exception &ex) { } catch(std::exception &ex) {
in_evaluation = false; in_evaluation = false;
throw LogicalError("ADeferred::evaluate()", throw LogicalError("SDeferred::evaluate()",
"Standard C++ exception while evaluating \"" + "Standard C++ exception while evaluating \"" +
this->getImage() + "\": " + ex.what()); this->getImage() + "\": " + ex.what());
} catch(...) { } catch(...) {
in_evaluation = false; in_evaluation = false;
throw LogicalError("ADeferred::evaluate()", throw LogicalError("SDeferred::evaluate()",
"Unknown exception while evaluating \"" + "Unknown exception while evaluating \"" +
this->getImage() + "\": "); this->getImage() + "\": ");
} }
......
...@@ -174,7 +174,7 @@ namespace Expressions { ...@@ -174,7 +174,7 @@ namespace Expressions {
template <class T> template <class T>
double SRefAttr<T>::getReal() { double SRefAttr<T>::getReal() {
throw ParseError("SValue<T>::getReal()", throw ParseError("SRefAttr<T>::getReal()",
"Attribute is not of real type."); "Attribute is not of real type.");
} }
......
...@@ -71,7 +71,7 @@ public: ...@@ -71,7 +71,7 @@ public:
MemberType itsType; MemberType itsType;
// ada 4.5 2000 to speed up matching, add a pointer to // ada 4.5 2000 to speed up matching, add a pointer to
// opal elements in order to avoid serching the opal elements // opal elements in order to avoid searching the opal elements
Pointer<Element> OpalElement; Pointer<Element> OpalElement;
......
...@@ -34,8 +34,7 @@ ...@@ -34,8 +34,7 @@
/* /*
A and B are the half apperture of the box A and B are the half aperture of the box
/ (A,B) / (A,B)
/ /
...@@ -85,7 +84,7 @@ public: ...@@ -85,7 +84,7 @@ public:
std::string interpl); std::string interpl);
~BoxCornerDomain(); ~BoxCornerDomain();
/// as a function of z, determine the hight (B) of the geometry /// as a function of z, determine the height (B) of the geometry
inline double getB(double z) const { inline double getB(double z) const {
if((z < getZRangeMin()) || (z > getZRangeMax())) if((z < getZRangeMin()) || (z > getZRangeMax()))
return getYRangeMax(); return getYRangeMax();
......
...@@ -73,10 +73,10 @@ namespace { ...@@ -73,10 +73,10 @@ namespace {
// FOR FFT BASED SOLVER // FOR FFT BASED SOLVER
MX, // mesh sixe in x MX, // mesh sixe in x
MY, // mesh sixe in y MY, // mesh sixe in y
MT, // mesh sixe in z MT, // mesh sixe in z
PARFFTX, // parallelized grind in x PARFFTX, // parallelized grid in x
PARFFTY, // parallelized grind in y PARFFTY, // parallelized grid in y
PARFFTT, // parallelized grind in z PARFFTT, // parallelized grid in z
BCFFTX, // boundary condition in x [FFT + AMR_MG only] BCFFTX, // boundary condition in x [FFT + AMR_MG only]
BCFFTY, // boundary condition in y [FFT + AMR_MG only] BCFFTY, // boundary condition in y [FFT + AMR_MG only]
BCFFTZ, // boundary condition in z [FFT + AMR_MG only] BCFFTZ, // boundary condition in z [FFT + AMR_MG only]
...@@ -248,15 +248,15 @@ FieldSolver::FieldSolver(): ...@@ -248,15 +248,15 @@ FieldSolver::FieldSolver():
16); 16);
itsAttr[AMR_BFX] = Attributes::makeReal("AMR_BFX", itsAttr[AMR_BFX] = Attributes::makeReal("AMR_BFX",
"Blocking factor in x for AMR (AMR_MAXGRIDX needs to be a multiple", "Blocking factor in x for AMR (AMR_MAXGRIDX needs to be a multiple)",
8); 8);
itsAttr[AMR_BFY] = Attributes::makeReal("AMR_BFY", itsAttr[AMR_BFY] = Attributes::makeReal("AMR_BFY",
"Blocking factor in y for AMR (AMR_MAXGRIDY needs to be a multiple", "Blocking factor in y for AMR (AMR_MAXGRIDY needs to be a multiple)",
8); 8);
itsAttr[AMR_BFZ] = Attributes::makeReal("AMR_BFZ", itsAttr[AMR_BFZ] = Attributes::makeReal("AMR_BFZ",
"Blocking factor in y for AMR (AMR_MAXGRIDZ needs to be a multiple", "Blocking factor in y for AMR (AMR_MAXGRIDZ needs to be a multiple)",
8); 8);
itsAttr[AMR_TAGGING] = Attributes::makeUpperCaseString("AMR_TAGGING", itsAttr[AMR_TAGGING] = Attributes::makeUpperCaseString("AMR_TAGGING",
...@@ -278,7 +278,7 @@ FieldSolver::FieldSolver(): ...@@ -278,7 +278,7 @@ FieldSolver::FieldSolver():
itsAttr[AMR_SCALING] = Attributes::makeReal("AMR_SCALING", itsAttr[AMR_SCALING] = Attributes::makeReal("AMR_SCALING",
"Scaling value for maximum value tagging " "Scaling value for maximum value tagging "
"(only POTENTIAL / CHARGE_DENSITY / " "(only POTENTIAL / CHARGE_DENSITY / "
"MOMENTA", 0.75); "MOMENTA)", 0.75);
itsAttr[AMR_DOMAIN_RATIO] = Attributes::makeRealArray("AMR_DOMAIN_RATIO", itsAttr[AMR_DOMAIN_RATIO] = Attributes::makeRealArray("AMR_DOMAIN_RATIO",
"Box ratio of AMR computation domain. Default: [-1, 1]^3"); "Box ratio of AMR computation domain. Default: [-1, 1]^3");
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
// //
// Class: TrackEnd // Class: TrackEnd
// The class fore the OPAL ENDTRACK command. // The class for the OPAL ENDTRACK command.
// //
// ------------------------------------------------------------------------ // ------------------------------------------------------------------------
// //
......
...@@ -3,4 +3,7 @@ at https://www.aps.anl.gov/Accelerator-Operations-Physics/Software#SDDS%20Source ...@@ -3,4 +3,7 @@ at https://www.aps.anl.gov/Accelerator-Operations-Physics/Software#SDDS%20Source
Unpack the sources, change to the directory epics/extensions/src/ and then upack the archive SDDSCMakeLists.tar.gz Unpack the sources, change to the directory epics/extensions/src/ and then upack the archive SDDSCMakeLists.tar.gz
in this directory. Finally apply the patch SDDS.patch with the command in this directory. Finally apply the patch SDDS.patch with the command
$ patch -p1 < /path/to/patch/SDDS.patch $ patch -p1 < /path/to/patch/SDDS.patch
Now you can use cmake to compile and install the SDDS library. Now you can use cmake to compile and install the SDDS library.
\ No newline at end of file
Comment from Christof:
These two programs (not scripts) export particle positions and momenta from HDF5 files to SDDS and from SDDS to ASCII (which then can be used to as FROMFILE distribution)
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment