From 3fb95eb775620888f022695c3e7d04aae8a80f08 Mon Sep 17 00:00:00 2001 From: Cristian C Lalescu <Cristian.Lalescu@mpcdf.mpg.de> Date: Sat, 2 Dec 2023 10:52:49 +0100 Subject: [PATCH] adds readme --- examples/field_convergence/NSVE_error.cpp | 23 +++++++++++++++++++ examples/field_convergence/NSVE_error.hpp | 27 +++++++++++++++++++++-- examples/field_convergence/README.rst | 13 +++++++++++ 3 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 examples/field_convergence/README.rst diff --git a/examples/field_convergence/NSVE_error.cpp b/examples/field_convergence/NSVE_error.cpp index 735ed4f7..b42e12de 100644 --- a/examples/field_convergence/NSVE_error.cpp +++ b/examples/field_convergence/NSVE_error.cpp @@ -1,3 +1,26 @@ +/****************************************************************************** +* * +* 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" diff --git a/examples/field_convergence/NSVE_error.hpp b/examples/field_convergence/NSVE_error.hpp index b7e50d60..2a8f5cea 100644 --- a/examples/field_convergence/NSVE_error.hpp +++ b/examples/field_convergence/NSVE_error.hpp @@ -1,7 +1,30 @@ -#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" diff --git a/examples/field_convergence/README.rst b/examples/field_convergence/README.rst new file mode 100644 index 00000000..530f46f2 --- /dev/null +++ b/examples/field_convergence/README.rst @@ -0,0 +1,13 @@ +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. -- GitLab