From 8ae1a95ec6545e0c29ac97908f2ce6f0bbbf43fd Mon Sep 17 00:00:00 2001 From: Lanny91 Date: Tue, 17 Jan 2017 18:14:20 +0000 Subject: [PATCH] Legal banners and module descriptions --- extras/Hadrons/Modules/MLoop/NoiseLoop.hpp | 43 +++++++++++++++++++++- extras/Hadrons/Modules/MSource/Wall.hpp | 33 +++++++++++++++-- 2 files changed, 72 insertions(+), 4 deletions(-) diff --git a/extras/Hadrons/Modules/MLoop/NoiseLoop.hpp b/extras/Hadrons/Modules/MLoop/NoiseLoop.hpp index d1ede0c5..3d2850d1 100644 --- a/extras/Hadrons/Modules/MLoop/NoiseLoop.hpp +++ b/extras/Hadrons/Modules/MLoop/NoiseLoop.hpp @@ -1,3 +1,31 @@ +/************************************************************************************* + +Grid physics library, www.github.com/paboyle/Grid + +Source file: extras/Hadrons/Modules/MLoop/NoiseLoop.hpp + +Copyright (C) 2016 + +Author: Andrew Lawson + +This program 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 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +See the full license in the file "LICENSE" in the top level distribution directory +*************************************************************************************/ +/* END LEGAL */ + #ifndef Hadrons_NoiseLoop_hpp_ #define Hadrons_NoiseLoop_hpp_ @@ -7,6 +35,19 @@ BEGIN_HADRONS_NAMESPACE +/* + + Noise loop propagator + ----------------------------- + * loop_x = q_x * adj(eta_x) + + * options: + - q = Result of inversion on noise source. + - eta = noise source. + + */ + + /****************************************************************************** * NoiseLoop * ******************************************************************************/ @@ -16,7 +57,7 @@ class NoiseLoopPar: Serializable { public: GRID_SERIALIZABLE_CLASS_MEMBERS(NoiseLoopPar, - std::string, q, + std::string, q, std::string, eta); }; diff --git a/extras/Hadrons/Modules/MSource/Wall.hpp b/extras/Hadrons/Modules/MSource/Wall.hpp index c299a7bf..9d22e23b 100644 --- a/extras/Hadrons/Modules/MSource/Wall.hpp +++ b/extras/Hadrons/Modules/MSource/Wall.hpp @@ -1,3 +1,31 @@ +/************************************************************************************* + +Grid physics library, www.github.com/paboyle/Grid + +Source file: extras/Hadrons/Modules/MSource/Wall.hpp + +Copyright (C) 2016 + +Author: Andrew Lawson + +This program 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 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +See the full license in the file "LICENSE" in the top level distribution directory +*************************************************************************************/ +/* END LEGAL */ + #ifndef Hadrons_Wall_hpp_ #define Hadrons_Wall_hpp_ @@ -11,11 +39,10 @@ BEGIN_HADRONS_NAMESPACE Wall source ----------------------------- - * src_x = theta(x_3 - tA) * theta(tB - x_3) * exp(i x.mom) + * src_x = delta(x_3 - tW) * exp(i x.mom) * options: - - tA: begin timeslice (integer) - - tB: end timeslice (integer) + - tW: source timeslice (integer) - mom: momentum insertion, space-separated float sequence (e.g ".1 .2 1. 0.") */