Skip to content

Maintenance/ballast_and_trim.tl

  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
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
mission ballast_and_trim {
  arguments {
    MissionTimeout = 90 minute
      """
      Maximum duration of mission
      """

    SkipComms = false
      """
      Skip communications at start of mission.
      """

    Depth1 = 35 meter

    Depth2 = NaN meter

    DepthDeadband = 0.1 meter
      """
      How much vertical drift from the specified depth is allowed durnig the
      mission.
      """

    ApproachSpeed = 1 meter_per_second
      """
      Enables vehicle thruster at the commanded speed to reach target depth
      (set to 0 m/s to drift).
      """

    ApproachDepthTimeout = 20 minute
      """
      Maximum wait time for the vehicle to reach the targeted depth.
      """

    ApproachDepthRate = 0.4 meter_per_second
      """
      Descent depth rate (Positive depth rate means going down).
      """

    ApproachPitchLimit = 20 degree
      """
      Max vehicle pitch (+/-) when decending from the surface.
      """

    ApproachSettleTimePreDive = 0 minute
      """
      Time duration for the vehicle to pump down the VBS *BEFORE* leaving the
      surface.
      """

    SettleTime = 10 minute
      """
      How long to wait after reaching target depth before starting ballast and
      trim.
      """

    EstimationTimeout = 45 minute
      """
      Timeout for ballast and trim estimation.
      """

    MinEstimationTime = 10 minute
      """
      Minimum time to run ballast and trim estimation before determining
      convergence (must be shorter than timeout).
      """

    MassEstimationErrorBound = 0.5 millimeter
      """
      Desired range of the estimated sample mean from the true mean statistic
      (smaller values take longer to converge).
      """

    BuoyEstimationErrorBound = 25 cubic_centimeter
      """
      Desired range of the estimated sample mean from the true mean statistic
      (smaller values take longer to converge).
      """

    EstimationConfidence = 98.0 percent
      """
      Confidence level that the estimator has reached the desired error range
      (larger values take longer to converge).
      """

    massDeadband = 0.25 millimeter
      """
      Degree of rounding in mass-shifter command output values.
      """

    MinAltitude = 5 meter

    MaxDepth = 52 meter

    MinOffshore = 2 kilometer

    CheckDepths = 1 bool
  }

  timeout duration=MissionTimeout

  insert Insert/Science.tl

  insert id="NeedComms" Insert/NeedComms.tl
  assign in sequence NeedComms:DiveInterval = MissionTimeout

  insert Insert/StandardEnvelopes.tl

  assign in sequence StandardEnvelopes:MinAltitude = MinAltitude
  assign in sequence StandardEnvelopes:MaxDepth = MaxDepth
  assign in sequence StandardEnvelopes:MinOffshore = MinOffshore

  insert Insert/BackseatDriver.tl

  aggregate CheckTargetDepths {
    run in sequence

    break if ( not ( CheckDepths ) )

    aggregate CheckDepth1 {
      run in sequence

      break if ( not ( Depth1 > MaxDepth ) )

      syslog important "Aborting ballast and trim mission. Target depth Depth1 exceeds the mission's MaxDepth setting (review mission parameters)."

      behavior Guidance:Execute {
        run in sequence

        set command = "stop"
      }
    }

    aggregate CheckDepth2 {
      run in sequence

      break if ( not ( Depth2 > MaxDepth ) )

      syslog important "Aborting ballast and trim mission. Target depth Depth2 exceeds the mission's MaxDepth setting (review mission parameters)."

      behavior Guidance:Execute {
        run in sequence

        set command = "stop"
      }
    }

    assign in sequence CheckDepths = 0 bool
  }

  aggregate StartingMission {
    run in sequence

    break if ( SkipComms )

    # DO NOT REMOVE the syslog entry below. The MissionManager seems to ignore the value of SkipComms, does not evaluate the Break statement properly, and always calls NeedComms. Adding the syslog call somehow fixes it.

    syslog info "Checking for additional instructions before submerging."
    call id="StartingMission" refId="NeedComms"
  }

  aggregate RunBallastAndTrim {
    run in sequence

    insert Insert/BallastAndTrim.tl {
      redefineArg InsertDepthDeadband = DepthDeadband
      redefineArg InsertApproachSpeed = ApproachSpeed
      redefineArg InsertApproachDepthRate = ApproachDepthRate
      redefineArg InsertApproachPitchLimit = ApproachPitchLimit
      redefineArg InsertApproachSettleTimePreDive = ApproachSettleTimePreDive
      redefineArg InsertApproachDepthTimeout = ApproachDepthTimeout
      redefineArg InsertSettleTime = SettleTime
      redefineArg EstTimeout = EstimationTimeout
      redefineArg MinEstTime = MinEstimationTime
      redefineArg MassEstErrorBound = MassEstimationErrorBound
      redefineArg BuoyEstErrorBound = BuoyEstimationErrorBound
      redefineArg EstConfidence = EstimationConfidence
      redefineArg InsertMassDeadband = massDeadband
    }

    aggregate RunDepth1 {
      run in sequence

      break if ( isNaN ( Depth1 ) )

      assign in sequence BallastAndTrim:InsertDepth = Depth1
      call refId="BallastAndTrim"
    }

    aggregate RunDepth2 {
      run in sequence

      break if ( isNaN ( Depth2 ) )

      assign in sequence BallastAndTrim:InsertDepth = Depth2
      call refId="BallastAndTrim"
    }
  }

  call id="EndingMission" refId="NeedComms"
}