Commit 8404378f authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

remove module docu from source code

parent f090c00e
......@@ -5,9 +5,10 @@
* New operator: abs (Math) [request: Reiner Schnur]
* enlarge: update for zonal and meridional data [request: Wolfgang Mueller]
* gradsdes: bug fix for unsorted GRIB data [report: Stefan Bauer]
* change help info format
* Change help info format
* extent macro UNCHANGED_RECORD to cdoDefaultDataType and cdoDefaultByteorder
* Version 0.9.12 released
* remove module docu from source code
* Version 0.9.13 released
2006-03-08 Uwe Schulzweida <schulzweida@dkrz.de>
......
......@@ -15,6 +15,18 @@
GNU General Public License for more details.
*/
/*
This module contains the following operators:
Arith add Add two fields
Arith sub Subtract two fields
Arith mul Multiply two fields
Arith div Divide two fields
Arith min Minimum of two fields
Arith max Maximum of two fields
*/
#include <string.h>
#include "cdi.h"
......@@ -22,101 +34,6 @@
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Arith
@Title = Arithmetic on two files
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile1 ifile2 ofile
@Operators = add sub mul div min max
@EndModule
@BeginOperator_add
@Title = Add two fields
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) + i_2(t,x)
@EndMath
@EndDescription
@EndOperator
@BeginOperator_sub
@Title = Subtract two fields
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) - i_2(t,x)
@EndMath
@EndDescription
@EndOperator
@BeginOperator_mul
@Title = Multiply two fields
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) * i_2(t,x)
@EndMath
@EndDescription
@EndOperator
@BeginOperator_div
@Title = Divide two fields
@BeginDescription
@BeginMath
o(t,x) = i_1(t,x) / i_2(t,x)
@EndMath
@EndDescription
@EndOperator
@BeginOperator_min
@Title = Minimum of two fields
@BeginDescription
@BeginMath
o(t,x) = MIN(i_1(t,x), i_2(t,x))
@EndMath
@EndDescription
@EndOperator
@BeginOperator_max
@Title = Maximum of two fields
@BeginDescription
@BeginMath
o(t,x) = MAX(i_1(t,x), i_2(t,x))
@EndMath
@EndDescription
@EndOperator
@EndDoc
*/
void *Arith(void *argument)
{
......
......@@ -15,103 +15,20 @@
GNU General Public License for more details.
*/
#include "cdi.h"
#include "cdo.h"
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Arithc
@Title = Arithmetic with a constant
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile ofile
@Operators = addc subc mulc divc
@EndModule
@BeginOperator_addc
@Title = Add by constant
@Parameter = c
@BeginDescription
@BeginMath
o(t,x) = i(t,x) + c
@EndMath
@EndDescription
@BeginParameter
@Item = c
FLOAT Constant
@EndParameter
@EndOperator
@BeginOperator_subc
@Title = Subtract by constant
@Parameter = c
@BeginDescription
@BeginMath
o(t,x) = i(t,x) - c
@EndMath
@EndDescription
This module contains the following operators:
@BeginParameter
@Item = c
FLOAT Constant
@EndParameter
@EndOperator
@BeginOperator_mulc
@Title = Multiply by constant
@Parameter = c
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * c
@EndMath
@EndDescription
@BeginParameter
@Item = c
FLOAT Constant
@EndParameter
@EndOperator
@BeginOperator_divc
@Title = Divide by constant
@Parameter = c
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / c
@EndMath
@EndDescription
@BeginParameter
@Item = c
FLOAT Constant
@EndParameter
Arithc addc Add by constant
Arithc subc Subtract by constant
Arithc mulc Multiply by constant
Arithc divc Divide by constant
*/
@EndOperator
@EndDoc
*/
#include "cdi.h"
#include "cdo.h"
#include "cdo_int.h"
#include "pstream.h"
void *Arithc(void *argument)
......
......@@ -15,79 +15,20 @@
GNU General Public License for more details.
*/
#include "cdi.h"
#include "cdo.h"
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Arithdays
@Title = Arithmetic with days
@Section = Arithmetic
@Class = Arithmetic
@Arguments = ifile ofile
@Operators = muldpm divdpm muldpy divdpy
@EndModule
@BeginOperator_muldpm
@Title = Multiply with days per month
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * days\_per\_month
@EndMath
@EndDescription
@EndOperator
@BeginOperator_divdpm
@Title = Divide by days per month
This module contains the following operators:
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / days\_per\_month
@EndMath
@EndDescription
@EndOperator
@BeginOperator_muldpy
@Title = Multiply with days per year
@BeginDescription
@BeginMath
o(t,x) = i(t,x) * days\_per\_year
@EndMath
@EndDescription
@EndOperator
@BeginOperator_divdpy
@Title = Divide by days per year
@BeginDescription
@BeginMath
o(t,x) = i(t,x) / days\_per\_year
@EndMath
@EndDescription
Arithdays muldpm Multiply with days per month
Arithdays divdpm Divide by days per month
Arithdays muldpy Multiply with days per year
Arithdays divdpy Divide by days per year
*/
@EndOperator
@EndDoc
*/
#include "cdi.h"
#include "cdo.h"
#include "cdo_int.h"
#include "pstream.h"
void *Arithdays(void *argument)
......
......@@ -15,6 +15,13 @@
GNU General Public License for more details.
*/
/*
This module contains the following operators:
Copy cat Concatenate datasets
*/
#include <string.h>
#include "cdi.h"
......@@ -22,34 +29,6 @@
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Cat
@Title = Concatenate
@Section = File operations
@Class = File operation
@Arguments = ifiles ofile
@Operators = cat
@EndModule
@BeginOperator_cat
@Title = Concatenate files
@BeginDescription
Concatenate ifiles and add the result at the end of ofile.
Each input file must have the same variables with complete timesteps.
@EndDescription
@EndOperator
@EndDoc
*/
void *Cat(void *argument)
{
......
......@@ -15,6 +15,17 @@
GNU General Public License for more details.
*/
/*
This module contains the following operators:
Change chcode Change code
Change chvar Change variable name
Change chlevel Change level
Change chlevelc Change level of one code
Change chlevelv Change level of one variable
*/
#include <string.h>
#include <math.h> /* fabs */
......@@ -23,115 +34,6 @@
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Change
@Title = Change
@Section = Manipulating the header/field
@Class = Manipulation
@Arguments = ifile ofile
@Operators = chcode chvar chlevel chlevelc chlevelv
@EndModule
@BeginOperator_chcode
@Title = Change code
@Parameter = ocode ncode ...
@BeginDescription
Changes some user given codes to new user given values.
@EndDescription
@BeginParameter
@Item = ocode,ncode,...
INTEGER Pairs of old and new code
@EndParameter
@EndOperator
@BeginOperator_chvar
@Title = Change variable name
@Parameter = ovar nvar ...
@BeginDescription
Changes some user given variable names to new user given names.
@EndDescription
@BeginParameter
@Item = ovar,nvar,...
STRING Pairs of old and new variable name
@EndParameter
@EndOperator
@BeginOperator_chlevel
@Title = Change level
@Parameter = olevel nlevel ...
@BeginDescription
Changes some user given levels to new user given values.
@EndDescription
@BeginParameter
@Item = olevel,nlevel,...
FLOAT Pairs of old and new level
@EndParameter
@EndOperator
@BeginOperator_chlevelc
@Title = Change level of one code
@Parameter = code olevel nlevel
@BeginDescription
Changes one level of a user given code number.
@EndDescription
@BeginParameter olevel
@Item = code
INTEGER Code number
@Item = olevel
FLOAT Old level
@Item = nlevel
FLOAT New level
@EndParameter
@EndOperator
@BeginOperator_chlevelv
@Title = Change level of one variable
@Parameter = var olevel nlevel
@BeginDescription
Changes one level of a user given variable.
@EndDescription
@BeginParameter olevel
@Item = var
STRING Variable name
@Item = olevel
FLOAT Old level
@Item = nlevel
FLOAT New level
@EndParameter
@EndOperator
@EndDoc
*/
#define MAXARG 16384
......
......@@ -15,6 +15,18 @@
GNU General Public License for more details.
*/
/*
This module contains the following operators:
Comp eq Equal
Comp ne Not equal
Comp le Less equal
Comp lt Less than
Comp ge Greater equal
Comp gt Greater than
*/
#include <string.h>
#include "cdi.h"
......@@ -22,173 +34,6 @@
#include "cdo_int.h"
#include "pstream.h"
/*
@BeginDoc
@BeginModule
@Name = Comp
@Title = Comparison of two fields
@Section = Comparisons
@Class = Comparison
@Arguments = ifile1 ifile2 ofile
@Operators = eq ne le lt ge gt
@EndModule
@BeginOperator_eq
@Title = Equal
@BeginDescription
@IfMan
/ 1 if i_1(t,x) EQ i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) NE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
\ miss if i_1(t,x) EQ miss OR i_2(t,x) EQ miss
@EndifMan
@IfDoc
@BeginMath
o(t,x) = \left\{
\begin{array}{cll}
1 & \mbox{if} \;\; i_1(t,x) = i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
0 & \mbox{if} \;\; i_1(t,x) \neq i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
\mbox{miss} & \mbox{if} \;\; i_1(t,x) = \mbox{miss} & \vee \;\; i_2(t,x) = \mbox{miss} \\
\end{array} \right.
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginOperator_ne
@Title = Not equal
@BeginDescription
@IfMan
/ 1 if i_1(t,x) NE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) EQ i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
\ miss if i_1(t,x) EQ miss OR i_2(t,x) EQ miss
@EndifMan
@IfDoc
@BeginMath
o(t,x) = \left\{
\begin{array}{cll}
1 & \mbox{if} \;\; i_1(t,x) \neq i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
0 & \mbox{if} \;\; i_1(t,x) = i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
\mbox{miss} & \mbox{if} \;\; i_1(t,x) = \mbox{miss} & \vee \;\; i_2(t,x) = \mbox{miss} \\
\end{array} \right.
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginOperator_le
@Title = Less equal
@BeginDescription
@IfMan
/ 1 if i_1(t,x) LE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) GT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
\ miss if i_1(t,x) EQ miss OR i_2(t,x) EQ miss
@EndifMan
@IfDoc
@BeginMath
o(t,x) = \left\{
\begin{array}{cll}
1 & \mbox{if} \;\; i_1(t,x) \leq i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
0 & \mbox{if} \;\; i_1(t,x) > i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
\mbox{miss} & \mbox{if} \;\; i_1(t,x) = \mbox{miss} & \vee \;\; i_2(t,x) = \mbox{miss} \\
\end{array} \right.
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginOperator_lt
@Title = Less then
@BeginDescription
@IfMan
/ 1 if i_1(t,x) LT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) GE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
\ miss if i_1(t,x) EQ miss OR i_2(t,x) EQ miss
@EndifMan
@IfDoc
@BeginMath
o(t,x) = \left\{
\begin{array}{cll}
1 & \mbox{if} \;\; i_1(t,x) < i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
0 & \mbox{if} \;\; i_1(t,x) \geq i_2(t,x) & \wedge \;\; i_1(t,x), i_2(t,x) \neq \mbox{miss} \\
\mbox{miss} & \mbox{if} \;\; i_1(t,x) = \mbox{miss} & \vee \;\; i_2(t,x) = \mbox{miss} \\
\end{array} \right.
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginOperator_ge
@Title = Greater equal
@BeginDescription
@IfMan
/ 1 if i_1(t,x) GE i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
o(t,x) = < 0 if i_1(t,x) LT i_2(t,x) AND i_1(t,x),i_2(t,x) NE miss
\ miss if i_1(t,x) EQ miss OR i_2(t,x) EQ miss