diff --git a/src/Distribution/ClosedOrbitFinder.h b/src/Distribution/ClosedOrbitFinder.h index 5b7fc2af64e2b1712350db76b9739a40d34c0cc7..b5201f65936c518c54ade96b4d7ed7c74fd80824 100644 --- a/src/Distribution/ClosedOrbitFinder.h +++ b/src/Distribution/ClosedOrbitFinder.h @@ -1,15 +1,29 @@ -/** - * @file ClosedOrbitFinder.h - * The algorithm is based on the paper of M. M. Gordon: "Computation of closed orbits and basic focusing properties for - * sector-focused cyclotrons and the design of 'cyclops'" (1983) - * As template arguments one chooses the type of the variables and the integrator for the ODEs. The supported steppers can - * be found on - * http://www.boost.org/ where it is part of the library Odeint. - * - * @author Matthias Frey - * @version 1.0 - */ - +// +// Class ClosedOrbitFinder +// This class finds a closed orbit of a cyclotron for a given energy. +// The algorithm is based on the paper of M. M. Gordon: "Computation of +// closed orbits and basic focusing properties for sector-focused cyclotrons +// and the design of 'cyclops'" (1983) +// As template arguments one chooses the type of the variables and the +// integrator for the ODEs. The supported steppers can be found on +// http://www.boost.org/ where it is part of the library Odeint. +// +// Copyright (c) 2014, Matthias Frey, ETH Zürich +// All rights reserved +// +// Implemented as part of the Semester thesis by Matthias Frey +// "Matched Distributions in Cyclotrons" +// +// This file is part of OPAL. +// +// OPAL is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// You should have received a copy of the GNU General Public License +// along with OPAL. If not, see <https://www.gnu.org/licenses/>. +// #ifndef CLOSEDORBITFINDER_H #define CLOSEDORBITFINDER_H @@ -37,7 +51,6 @@ extern Inform *gmsg; -/// Finds a closed orbit of a cyclotron for a given energy template<typename Value_type, typename Size_type, class Stepper> class ClosedOrbitFinder { diff --git a/src/Distribution/Harmonics.h b/src/Distribution/Harmonics.h index 11b53e3332b95f7e82360c770fa685e40fcfe7c5..1c78ca3f72f3c4be248d7c160bcaf7a67b9729ba 100644 --- a/src/Distribution/Harmonics.h +++ b/src/Distribution/Harmonics.h @@ -1,12 +1,22 @@ -/** - * @file Harmonics.h - * This class computes the cyclotron map based on harmonics. - * All functions are copied and translated to C++ from the original program inj2_ana.c of Dr. C. Baumgarten. - * - * @author Matthias Frey - * @version 1.0 - */ - +// +// Class Harmonics +// This class computes the cyclotron map based on harmonics. +// All functions are copied and translated to C++ from the original program inj2_ana.c of Dr. C. Baumgarten. +// +// Copyright (c) 2014 - 2015, Christian Baumgarten, Paul Scherrer Institut, Villigen PSI, Switzerland +// Matthias Frey, ETH Zürich +// All rights reserved +// +// This file is part of OPAL. +// +// OPAL is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// You should have received a copy of the GNU General Public License +// along with OPAL. If not, see <https://www.gnu.org/licenses/>. +// #ifndef HARMONICS_H #define HARMONICS_H diff --git a/src/Distribution/matrix_vector_operation.h b/src/Distribution/matrix_vector_operation.h index 4cb0740fed32d3963e84bc34673efc789d14f054..12be154050052d80faf5723c0d2b62d962504172 100644 --- a/src/Distribution/matrix_vector_operation.h +++ b/src/Distribution/matrix_vector_operation.h @@ -1,11 +1,24 @@ -/** - * @file matrix_vector_operation.h - * This file provides additional functions for the matrix classes of uBLAS that is part of the - * BOOST library (http://www.boost.org/). - * - * @author Matthias Frey - * @version 1.0 - */ +// +// File with Boost uBLAS extensions +// This file provides additional functions for the matrix classes +// of uBLAS that is part of the Boost library (http://www.boost.org/). +// +// Copyright (c) 2014, Matthias Frey, ETH Zürich +// All rights reserved +// +// Implemented as part of the Semester thesis by Matthias Frey +// "Matched Distributions in Cyclotrons" +// +// This file is part of OPAL. +// +// OPAL is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// You should have received a copy of the GNU General Public License +// along with OPAL. If not, see <https://www.gnu.org/licenses/>. +// #ifndef MATRIX_OPERATION_H #define MATRIX_OPERATION_H @@ -23,7 +36,6 @@ * @{ */ -/// @brief Expands the existing functions of the boost library uBLAS (http://www.boost.org/). namespace matt_boost { namespace ublas = boost::numeric::ublas;