License

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -1,3 +1,17 @@
+# Copyright 2017-2023 Ian Jauslin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 PROJECTNAME=nstrophy
 VERSION=0.0
 

README.md

@@ -0,0 +1,112 @@
+Nstrophy is a tool to solve the two-dimensional Navier-Stokes equation as well
+as Gallavotti's reversible Navier-Stokes equation and compare them.
+
+**Nstrophy is under active development**
+
+# Building
+
+Compile Nstrophy with
+```bash
+make
+```
+which will place a binary at `build/nstrophy`.
+
+The syntax for the execution of Nstrophy is
+```bash
+./build/nstrophy [-p parameters] [-s savefile] <command>
+```
+
+Nstrophy is written in C. The Makefile uses the GNU C Compiler.
+
+Nstrophy depends on `fftw`: [https://fftw.org]
+
+
+# Commands
+
+The available commands are
+
+* `enstrophy`: to compute the enstrophy, the parameter alpha and
+  alpha times the enstrophy. This command prints
+  `step_index time average_alpha average_enstrophy average_alphaxenstrophy alpha enstrophy alphaxenstrophy`
+  where the averages are running averages over `print_freq` steps.
+
+* `uk`: to compute the Fourier transform of the solution.
+
+* `quiet`: does not print anything, useful for debugging.
+
+
+# Parameters
+
+The parameters can be specified using the `-p` flag. The parameter string
+should be a `;` sperated list of `key=value` pairs. The possible keys are
+
+* `equation`: either `irreverisible` (default) or `reversible`.
+
+* `K` (int, default 16): cutoff in momentum space: -K<=k_i<=K
+
+* `K1` (int, default `K`): cutoff in momentum space for the x component:
+  -K<=k_x<=K
+
+* `K2` (int, default `K`): cutoff in momentum space for the y component:
+  -K<=k_y<=K
+
+* `N` (int, default smallest power of 2 that is larger than 3`K`): size of fft
+  vectors: must be at least 3 times `K` to avoid aliasing.
+
+* `N1` (int, default `N`): same as `N` but only for x component.
+
+* `N2` (int, default `N`): same as `N` but only for y component.
+
+* `nsteps` (long int, default 10000000): number of steps in the computation.
+  Set to 0 to keep on going forever.
+
+* `nu` (double, default 0.00048828125): viscosity.
+
+* `delta` (double, default 0.0001220703125): step size.
+
+* `L` (double, default 2pi): size of box.
+
+* `print_freq` (long int, default 1000): only print every `print_freq` steps.
+
+* `starting_time` (long int, default 0): start the computation at this step.
+
+* `driving`: either `zero` for no driving, `test` (default) for a testing
+  driving force or `file:<filename>` or `file_txt:<filename>` to read the
+  driving force from a file. When using `file:<filename>` the file should be
+  binary, whereas with `file_txt:<filename>` it should be plaintext. The binary
+  file format is `(double)(double)` for each entry of the driving force,
+  excluding kx<0 and kx=0&&ky<=0. The plaintext file format is
+  `kx ky real_part imag_part`.
+
+* `init`: either `random` for a random initialization, `gaussian` (default) for
+  a Gaussian initial condition or `file:<filename>` or `file_txt:<filename>` to
+  read the driving force from a file. When using `file:<filename>` the file
+  should be binary, whereas with `file_txt:<filename>` it should be plaintext.
+  The binary file format is `(double)(double)` for each entry of the driving
+  force, excluding kx<0 and kx=0&&ky<=0. The plaintext file format is
+  `kx ky real_part imag_part`.
+
+* `init_en` (double, default 1.54511597324389e+02): initial value of the energy if
+  `equation=irreversible` or of the enstrophy if `equation=reversible`.
+
+* `random_seed` (int, default ): seed for random initialization.
+
+* `algorithm`: either `RK4` for Runge-Kutta 4, or `RK2` for Runge-Kutta 2.
+
+
+# Interrupting/resuming the computation
+
+The computation can be interrupted by sending Nstrophy the `SIGINT` signal
+(e.g. by pressing `Ctrl-C`.) When Nstrophy receives the `SIGINT` signal, it
+finishes its current step and writes the value of uk, either to `savefile` if
+such a file was specified on the command line (using the `-s` flag), or to
+`stderr`. In addition, when a `savefile` is specified it writes the command
+that needs to be used to resume the computation (which essentially just sets
+the appropriate `starting_time` and `init:file:<savefile>` parameters. The data
+written to the `savefile` is binary.
+
+
+# License
+Nstrophy is released under the Apache 2.0 license.
+
+Copyright 2017-2023 Ian Jauslin

docs/nstrophy_doc.tex

@@ -1,3 +1,17 @@
+% Copyright 2017-2023 Ian Jauslin
+% 
+% Licensed under the Apache License, Version 2.0 (the "License");
+% you may not use this file except in compliance with the License.
+% You may obtain a copy of the License at
+% 
+%     http://www.apache.org/licenses/LICENSE-2.0
+% 
+% Unless required by applicable law or agreed to in writing, software
+% distributed under the License is distributed on an "AS IS" BASIS,
+% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+% See the License for the specific language governing permissions and
+% limitations under the License.
+
 \documentclass{ian}
 
 \usepackage{largearray}

src/constants.cpp

@@ -1,5 +1,22 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+
 #define COMMAND_UK 1
-#define COMMAND_EEA 2
+#define COMMAND_ENSTROPHY 2
 #define COMMAND_QUIET 3
 
 #define DRIVING_ZERO 1

src/driving.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include "driving.h"
 #include "navier-stokes.h"
 #include "io.h"

src/driving.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef DRIVING_H
 #define DRIVING_H
 

src/init.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include "init.h"
 #include "navier-stokes.h"
 #include "io.h"

src/init.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef INIT_H
 #define INIT_H
 

src/int_tools.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include <math.h>
 #include "int_tools.h"
 

src/int_tools.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef INTTOOLS_H
 #define INTTOOLS_H
 

src/io.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include <stdbool.h>
 #include <stdlib.h>
 #include <string.h>

src/io.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef IO_H
 #define IO_H
 

src/main.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #define VERSION "0.1"
 
 #include <math.h>
@@ -155,10 +171,10 @@ int main (
   if (command==COMMAND_UK){
     uk(parameters.K1, parameters.K2, parameters.N1, parameters.N2, parameters.nsteps, parameters.nu, parameters.delta, parameters.L, u0, g, parameters.irreversible, parameters.algorithm, parameters.print_freq, parameters.starting_time, nthreads, savefile);
   }
-  else if(command==COMMAND_EEA){
+  else if(command==COMMAND_ENSTROPHY){
     // register signal handler to handle aborts
     signal(SIGINT, sig_handler);
-    eea(parameters.K1, parameters.K2, parameters.N1, parameters.N2, parameters.nsteps, parameters.nu, parameters.delta, parameters.L, u0, g, parameters.irreversible, parameters.algorithm, parameters.print_freq, parameters.starting_time, nthreads, savefile, (char*)argv[0], param_str, savefile_str);
+    enstrophy(parameters.K1, parameters.K2, parameters.N1, parameters.N2, parameters.nsteps, parameters.nu, parameters.delta, parameters.L, u0, g, parameters.irreversible, parameters.algorithm, parameters.print_freq, parameters.starting_time, nthreads, savefile, (char*)argv[0], param_str, savefile_str);
   }
   else if(command==COMMAND_QUIET){
     quiet(parameters.K1, parameters.K2, parameters.N1, parameters.N2, parameters.nsteps, parameters.nu, parameters.delta, parameters.L, parameters.starting_time, u0, g, parameters.irreversible, parameters.algorithm, nthreads, savefile);
@@ -322,8 +338,8 @@ int read_args(
       if(strcmp(argv[i], "uk")==0){
 	*command=COMMAND_UK;
       }
-      else if(strcmp(argv[i], "energy")==0){
+      else if(strcmp(argv[i], "enstrophy")==0){
-	*command=COMMAND_EEA;
+	*command=COMMAND_ENSTROPHY;
       }
       else if(strcmp(argv[i], "quiet")==0){
 	*command=COMMAND_QUIET;

src/navier-stokes.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include "constants.cpp"
 #include "io.h"
 #include "navier-stokes.h"
@@ -84,8 +100,8 @@ int uk(
   return(0);
 }
 
-// compute energy, enstrophy, alpha as a function of time in the I-NS equation
+// compute enstrophy, alpha as a function of time
-int eea(
+int enstrophy(
   int K1,
   int K2,
   int N1,
@@ -111,8 +127,8 @@ int eea(
   _Complex double* tmp1;
   _Complex double* tmp2;
   _Complex double* tmp3;
-  double alpha, energy, enstrophy;
+  double alpha, enstrophy;
-  double avg_e,avg_a,avg_en;
+  double avg_a,avg_en,avg_en_x_a;
   // index
   uint64_t t;
   fft_vect fft1;
@@ -125,9 +141,9 @@ int eea(
 
 
   // init running average
-  avg_e=0;
   avg_a=0;
   avg_en=0;
+  avg_en_x_a=0;
 
   // special first case when starting_time is not a multiple of print_freq
   uint64_t first_box = print_freq - (starting_time % print_freq);
@@ -140,17 +156,16 @@ int eea(
       ns_step_rk4(u, K1, K2, N1, N2, nu, delta, L, g, fft1, fft2, ifft, tmp1, tmp2, tmp3, irreversible);
     }
 
-    energy=compute_energy(u, K1, K2);
     alpha=compute_alpha(u, K1, K2, g, L);
     enstrophy=compute_enstrophy(u, K1, K2, L);
 
-    avg_e=average_step(energy, avg_e, t, starting_time, print_freq, first_box);
     avg_a=average_step(alpha, avg_a, t, starting_time, print_freq, first_box);
     avg_en=average_step(enstrophy, avg_en, t, starting_time, print_freq, first_box);
+    avg_en_x_a=average_step(enstrophy*alpha, avg_en_x_a, t, starting_time, print_freq, first_box);
 
     if(t>starting_time && t%print_freq==0){
-      fprintf(stderr,"%lu % .8e % .8e % .8e % .8e % .8e % .8e % .8e\n",t,t*delta, avg_a, avg_e, avg_en, alpha, energy, enstrophy);
+      fprintf(stderr,"%lu % .8e % .8e % .8e % .8e % .8e % .8e % .8e\n",t,t*delta, avg_a, avg_en_x_a, avg_en, alpha, alpha*enstrophy, enstrophy);
-      printf("%8lu % .15e % .15e % .15e % .15e % .15e % .15e % .15e\n",t,t*delta, avg_a, avg_e, avg_en, alpha, energy, enstrophy);
+      printf("%8lu % .15e % .15e % .15e % .15e % .15e % .15e % .15e\n",t,t*delta, avg_a, avg_en_x_a, avg_en, alpha, alpha*enstrophy, enstrophy);
     }
 
     // catch abort signal
@@ -180,7 +195,7 @@ int eea(
       fprintf(savefile," -p \"%s;starting_time=%lu;nsteps=%lu;init=file:%s\"", params, t+1, (nsteps+starting_time < t+1 ? 0 : nsteps+starting_time-t-1), savefile_string);
       free(params);
     }
-    fprintf(savefile," energy\n");
+    fprintf(savefile," enstrophy\n");
 
     // save final u to savefile
     if(savefile==stderr || savefile==stdout){

src/navier-stokes.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef NAVIERSTOKES_H
 #define NAVIERSTOKES_H
 
@@ -20,8 +36,8 @@ typedef struct fft_vects {
 // compute u_k
 int uk( int K1, int K2, int N1, int N2, uint64_t nsteps, double nu, double delta, double L, _Complex double* u0, _Complex double* g, bool irreversible, unsigned int algorithm, uint64_t print_freq, uint64_t starting_time, unsigned int nthreadsl, FILE* savefile);
 
-// compute energy, enstrophy and alpha
+// compute enstrophy and alpha
-int eea( int K1, int K2, int N1, int N2, uint64_t nsteps, double nu, double delta, double L, _Complex double* u0, _Complex double* g, bool irreversible, unsigned int algorithm, uint64_t print_freq, uint64_t starting_time, unsigned int nthreads, FILE* savefile, char* cmd_string, char* params_string, char* savefile_string);
+int enstrophy( int K1, int K2, int N1, int N2, uint64_t nsteps, double nu, double delta, double L, _Complex double* u0, _Complex double* g, bool irreversible, unsigned int algorithm, uint64_t print_freq, uint64_t starting_time, unsigned int nthreads, FILE* savefile, char* cmd_string, char* params_string, char* savefile_string);
 
 // compute solution as a function of time, but do not print anything (useful for debugging)
 int quiet( int K1, int K2, int N1, int N2, uint64_t nsteps, double nu, double delta, double L, uint64_t starting_time, _Complex double* u0, _Complex double* g, bool irreversible, unsigned int algorithm, unsigned int nthreads, FILE* savefile);

src/statistics.c

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #include "statistics.h"
 
 // run this at each step to compute the running average

src/statistics.h

@@ -1,3 +1,19 @@
+/*
+Copyright 2017-2023 Ian Jauslin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 #ifndef STATISTICS_H
 #define STATISTICS_H