adds readme

examples/field_convergence/NSVE_error.cpp

+/******************************************************************************
+*                                                                             *
+*  Copyright 2023 TurTLE team                                                 *
+*                                                                             *
+*  This file is part of TurTLE.                                               *
+*                                                                             *
+*  TurTLE 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.                                     *
+*                                                                             *
+*  TurTLE 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 TurTLE.  If not, see <http://www.gnu.org/licenses/>             *
+*                                                                             *
+* Contact: Cristian.Lalescu@mpcdf.mpg.de                                      *
+*                                                                             *
+******************************************************************************/
+
 
 //#include "NSVE_error.hpp"
 #include "scope_timer.hpp"

examples/field_convergence/NSVE_error.hpp

-#ifndef NSVE_ERROR_HPP
-#define NSVE_ERROR_HPP
+/******************************************************************************
+*                                                                             *
+*  Copyright 2023 TurTLE team                                                 *
+*                                                                             *
+*  This file is part of TurTLE.                                               *
+*                                                                             *
+*  TurTLE 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.                                     *
+*                                                                             *
+*  TurTLE 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 TurTLE.  If not, see <http://www.gnu.org/licenses/>             *
+*                                                                             *
+* Contact: Cristian.Lalescu@mpcdf.mpg.de                                      *
+*                                                                             *
+******************************************************************************/
+
 
 
+#ifndef NSVE_ERROR_HPP
+#define NSVE_ERROR_HPP
 
 #include "full_code/NSVE.hpp"
 

examples/field_convergence/README.rst

+Error analysis for Navier-Stokes solvers
+========================================
+
+This is a code to analyze errors of the fluid solver in TurTLE.
+
+There are two main goals to achieve:
+
+* perform error analysis for Navier-Stokes solvers.
+
+* provide an example of TurTLE facilitating "exotic" studies, i.e. use TurTLE as a framework.
+
+This folder contains a basic C++ class to compute the errors, as well as
+a Python wrapper that will launch jobs and read the results.