File: ConstantSetWrapper.hh

package info (click to toggle)
xtide 2.6.4-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,996 kB
  • ctags: 2,617
  • sloc: cpp: 26,266; ansic: 8,105; makefile: 152; yacc: 113; sh: 54; lex: 54
file content (95 lines) | stat: -rw-r--r-- 3,761 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// $Id: ConstantSetWrapper.hh,v 1.2 2002/10/04 13:44:00 flaterco Exp $
/*  ConstantSetWrapper

    Copyright (C) 1998  David Flater.

    This program 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 2 of the License, or
    (at your option) any later version.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

class ConstantSetWrapper {
public:
  ConstantSetWrapper (ConstituentSet *in_constituents,
                      ConstantSet *in_constants);
  ~ConstantSetWrapper();

  // This will never have a value of type KnotsSquared.
  // This changes if offsets change.
  Amplitude maxAmplitude;

  void setSimpleOffsets (SimpleOffsets in_offsets);
  void setUnits (PredictionValue::Unit in_units);

  // This is the back end to the tide prediction functions that will be
  // finished out in class Station.  predictHeight does not have the
  // datum added in and will not be converted from KnotsSquared.
  // predictHeight wraps time2dt_tide.
  // movingMean is like predictHeight but it only does long-term constituents.
  PredictionValue predictHeight (Timestamp in_timestamp, unsigned deriv);
  PredictionValue movingMean (Timestamp in_timestamp);
  PredictionValue datum() const;
 /* dt_tide_max (int n)
  *   Returns the maximum that the absolute value of the nth derivative
  * of the tide can ever attain.
  */
  Amplitude dt_tide_max (unsigned deriv);

  // Tell me what units predictHeight will return.
  PredictionValue::Unit predictUnits ();

protected:

#define TIDE_MAX_DERIV (2)      /* Maximum derivative supported by
                                 * time2dt_tide() and family. */

  ConstituentSet *constituents;  // Node facs, eq. args.
  ConstantSet *origConstants;    // Already adjusted for meridian.
  ConstantSet adjConstants;      // origConstants with offsets and unit
                                 // conversions applied.
  ConstantSet yearConstants;     // adjConstants with node factors and
                                 // eq. args. applied

  // Updates adjConstants, maxAmplitude, and maxdt, then calls
  // refresh_yearConstants().
  void refresh_adjConstants_yearConstants ();
  // Updates yearConstants, amplitudes, phases, epoch, and next_epoch.
  void refresh_yearConstants ();

  Amplitude origMaxAmplitude;

  // Behold, shameless hand-optimization of the innermost loop.  These
  // vectors are "pre-fetched" from yearConstants and constituents and
  // are updated as needed in refresh_yearConstants.
  unsigned length;
  double *speeds;        // in radians per second.
  double *amplitudes;    // in myUnits.
  double *phases;        // in radians.

  // G. Dairiki code, slightly revised.
  double _time2dt_tide (long t, unsigned deriv);
  double blend_weight (double x, unsigned deriv);
  double blend_tide (Timestamp in_timestamp, unsigned deriv, Year first_year,
    double blend);
  double time2dt_tide (Timestamp in_timestamp, unsigned deriv);
  double time2mean (Timestamp in_timestamp);
  // This is now initialized in the constructor.
  Amplitude orig_maxdt[TIDE_MAX_DERIV+2];
  Amplitude maxdt[TIDE_MAX_DERIV+2];

  Year currentYear;
  Timestamp epoch;
  Timestamp next_epoch;
  SimpleOffsets mySimpleOffsets;
  PredictionValue::Unit myUnits;  // Never KnotsSquared
};