timcumsum: added docu.

OPERATORS

@@ -231,6 +231,7 @@ Operator catalog:
 -------------------------------------------------------------
    Statistical values
 -------------------------------------------------------------
+   Timcumsum     timcumsum       Cumulative sum over all timesteps
    Consecstat    consecsum       Consecutive Sum
    Consecstat    consects        Consecutive Timesteps
    Ensstat       ensmin          Ensemble minimum

doc/tex/Modules

@@ -48,6 +48,7 @@ Ydayarith     Arithmetic
 Ymonarith     Arithmetic
 Yseasarith    Arithmetic
 Arithdays     Arithmetic
+Timcumsum     Statistical values
 Consecstat    Statistical values
 Ensstat       Statistical values
 Ensstat2      Statistical values

doc/tex/mod/Consecstat

 @BeginModule
-@NewPage
 @Name      = Consecstat
 @Title     = Consecute timestep periods
 @Section   = Statistical values

doc/tex/mod/Timcumsum

-BeginModule
+@BeginModule
 @NewPage
 @Name      = Timcumsum
 @Title     = Cumulative sum over all timesteps
@@ -19,9 +19,11 @@ Missing values are treated as numeric zero when summing.
 
 @BeginDescription
 @IfMan
+
 o(t,x) = sum{i(t',x), 0<t'<=t}
 @EndifMan
 @IfDoc
+ \ \newline
 @BeginMath
 o(t,x) = \mbox{\textbf{sum}}\{i(t',x), 0 < t' \leq t\}
 @EndMath

src/modules.c

@@ -734,7 +734,7 @@ static modules_t Modules[] =
   { Timcount,       NULL,              MoncountOperators,      1,   CDI_BOTH,  1,  1 },
   { Timcount,       NULL,              DaycountOperators,      1,   CDI_BOTH,  1,  1 },
   { Timcount,       NULL,              HourcountOperators,     1,   CDI_BOTH,  1,  1 },
-  { Timcumsum,      NULL,              TimcumsumOperators,     1,   CDI_BOTH,  1,  1 },
+  { Timcumsum,      TimcumsumHelp,     TimcumsumOperators,     1,   CDI_BOTH,  1,  1 },
   { Timpctl,        TimpctlHelp,       TimpctlOperators,       1,   CDI_REAL,  3,  1 },
   { Timpctl,        YearpctlHelp,      YearpctlOperators,      1,   CDI_REAL,  3,  1 },
   { Timpctl,        MonpctlHelp,       MonpctlOperators,       1,   CDI_REAL,  3,  1 },

src/operator_help.h

@@ -1708,6 +1708,21 @@ static const char *ArithdaysHelp[] = {
     NULL
 };
 
+static const char *TimcumsumHelp[] = {
+    "NAME",
+    "    timcumsum - Cumulative sum over all timesteps",
+    "",
+    "SYNOPSIS",
+    "    timcumsum  ifile ofile",
+    "",
+    "DESCRIPTION",
+    "    The timcumsum operator calculates the cumulative sum over all timesteps.",
+    "    Missing values are treated as numeric zero when summing.",
+    "    ",
+    "    o(t,x) = sum{i(t',x), 0<t'<=t}",
+    NULL
+};
+
 static const char *ConsecstatHelp[] = {
     "NAME",
     "    consecsum, consects - Consecute timestep periods",