FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
SeineOperation.h
1#pragma once
2
121#include "AttractorNetBin.h"
122
123#include "sfh/timers/StopWatch.h"
124
125#include <fhsim/simobject/SimObject.h>
126#include <fstream>
127#include <iostream>
128#include <limits>
129#include <stdio.h>
130#include <string>
131
132#ifdef FH_VISUALIZATION
133# include <fhsim/visual/renderer/Hud.h>
134#endif
135
136class SeineOperation : public SimObject
137{
138public:
140 SeineOperation(std::string simObjectName, ISimObjectCreator* creator);
141
144
146 void CalcOutput(const double dT, const double* const adX);
147 void CalcOutput2(const double dT, const double* const adX);
148 void CalcOutputCommon(const double dT, const double* const adX) const;
149 void CalcOutput2Common(const double dT, const double* const adX) const;
150
152 virtual void OdeFcn(const double dT, const double* const adX, double* const adXDot) const { }
153 virtual void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator);
154
156 void PreOdeFcn(double T, const double* X) override;
157 void AcceptedStep(const double dT, const double* const adX) override;
158
159#ifdef FH_VISUALIZATION
161 virtual void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator);
162
164 virtual void RenderUpdate(const double dT, const double* const adX);
165#endif
166 const virtual double* WarpConnected(const double dT, const double* const adX);
167 const virtual double* BuoyPos(const double dT, const double* const adX);
168 const virtual double* VesselHeading(const double dT, const double* const adX);
169 const virtual double* VesselSpeed(const double dT, const double* const adX);
170 const virtual double* PWarpLength(const double dT, const double* const adX);
171 const virtual double* SWarpLength(const double dT, const double* const adX);
172
173protected:
175 static double NetAttractorStrengthAt(const double dT);
176
179 {
180 Phase_NotSet = 0,
181 Phase_SetFirstLeg,
182 Phase_SetNet,
183 Phase_SetSecondLeg,
184 Phase_Towing,
185 Phase_Hauling,
186 Phase_Finished
187 };
188
191
193 void ReadTensionFilter(ISimObjectCreator* const creator);
195 double TensionFilterWeight(const double dT) const;
197 static constexpr double kDefaultTensionFilterTimeConstant = 10.0;
199 void ReadWarpAttractorName(ISimObjectCreator* const creator);
201 void CheckSchedule(ISimObjectCreator* const creator) const;
202
203 EPhase_t PhaseAt(const double dT) const;
204
205 ISignalPort* m_inVesselPos;
206 ISignalPort* m_inPBridleTension;
207 ISignalPort* m_inSBridleTension;
208 ISignalPort* m_inNetSWingPos;
209 ISignalPort* m_inNetPWingPos;
210 ISignalPort* m_inNetVel;
211 ISignalPort* m_inPBridlePos;
212 ISignalPort* m_inSBridlePos;
213
214 ICommonComputation* m_commonCalc;
215 ICommonComputation* m_commonCalc2;
216 // Configuration
217 double m_vesselHeading[7];
218 double m_vesselSpeed[7];
219 double m_phaseStartTime[7];
222 double m_buoyPos[3];
223 double m_initialSpeed;
224 double m_setSpeed;
225 double m_towSpeed;
226 double m_haulSpeed;
227 double m_finishedSpeed;
228 double m_winchHaulSpeed;
229 double m_initialHeading;
230 double m_towHeading;
231 double m_spreadAngle;
232 double m_setWarpLength;
233
234 double m_outPWarpLength;
235 double m_outSWarpLength;
236
237
238 double m_addedTrackLength;
239 double m_towTime;
240 double m_minWarpLength;
241 std::string m_attractorNameNet;
242 std::string m_attractorNameWarp;
243 std::string m_phase[7];
244 std::string m_speed[7];
245 std::string m_heading[7];
246 AttractorNetBin* m_attractorNet;
247
248 // Output
249 static constexpr double kWarpConnectedValues[2] = {0.0, 1.0};
250 double m_wingSpread;
251 double m_netTangentialSpeed;
252 double m_netNormalSpeed;
253 double m_fileWritePeriod;
254 double m_bridleTension[2];
255 double m_bridleSpread;
256 bool m_outputToFile;
257 sfh::timers::StopWatch m_StopWatchFileWrite;
258 std::ofstream m_Outfile;
259 std::string m_fileName;
260 // The bridle tension filter: v += w * (m - v) once per accepted step, the first measurement taken as it is.
261 double m_tensionFilterValue[2];
268#ifdef FH_VISUALIZATION
269 Ogre::Entity* m_RenderMass;
270 Ogre::SceneNode* m_RenderNode;
271 sfh::timers::StopWatch m_StopWatchRenderUpdate;
272 // The status lines on the HUD, top to bottom; all empty without ShowStatus or without a HUD.
273 fhsim::HudLine m_hudTime;
274 fhsim::HudLine m_hudPhase;
275 fhsim::HudLine m_hudSpeed;
276 fhsim::HudLine m_hudHeading;
277 fhsim::HudLine m_hudWingSpread;
278 fhsim::HudLine m_hudBridleSpread;
279 fhsim::HudLine m_hudSbBridleTension;
280 fhsim::HudLine m_hudPrtBridleTension;
281 fhsim::HudLine m_hudNetNormalSpeed;
282 fhsim::HudLine m_hudNetTangentialSpeed;
283#endif
284};
The net bin of Seine/Vessel: a sphere that pulls the net and warp nodes inside it.
Definition AttractorNetBin.h:16
Definition SeineOperation.h:137
bool m_showStatus
ShowStatus: the status lines are shown on the HUD.
Definition SeineOperation.h:267
virtual void OdeFcn(const double dT, const double *const adX, double *const adXDot) const
Calculates the state derivatives.
Definition SeineOperation.h:152
void ReadTensionFilter(ISimObjectCreator *const creator)
Reads TensionFilterTimeConstant, or the old per-step TensionFilterConstant, and reports a bad or doub...
EPhase_t
Enumerator to define which operational phase the vessel is in.
Definition SeineOperation.h:179
~SeineOperation()
The destructor cleans up.
static constexpr double kDefaultTensionFilterTimeConstant
The time constant when neither TensionFilterTimeConstant nor TensionFilterConstant is given [s].
Definition SeineOperation.h:197
bool m_hasTensionSample
A measurement has been filtered.
Definition SeineOperation.h:265
void CheckSchedule(ISimObjectCreator *const creator) const
Refuses a schedule that cannot run: a speed that is zero or not a number, MinWarpLength above WarpLen...
static double NetAttractorStrengthAt(const double dT)
The relative strength of the net attractor at time dT: 101 at t = 0, falling linearly to 1 at 5 s....
double m_buoyPos[3]
Definition SeineOperation.h:222
bool m_tensionFilterPerStep
Only the old TensionFilterConstant was given: a weight per accepted step.
Definition SeineOperation.h:264
ICommonComputation * m_commonCalc
Calculations necessary for more than one output port.
Definition SeineOperation.h:214
double m_tensionFilterTimeConstant
TensionFilterTimeConstant [s].
Definition SeineOperation.h:262
void ReadWarpAttractorName(ISimObjectCreator *const creator)
Reads the warp attractor name from AttractorNameWarp, or from its old name AttractorNameWarps.
double m_tensionFilterStepWeight
TensionFilterConstant, used when m_tensionFilterPerStep.
Definition SeineOperation.h:263
double TensionFilterWeight(const double dT) const
The weight of the measurement taken at the accepted step dT.
void CalcOutput(const double dT, const double *const adX)
Performs calculations common to several output ports.
static constexpr double kWarpConnectedValues[2]
The values of the WarpConnected port: not connected, connected.
Definition SeineOperation.h:249
void PreOdeFcn(double T, const double *X) override
Latches the buoy at the vessel position of a step that starts in Phase_NotSet.
SeineOperation(std::string simObjectName, ISimObjectCreator *creator)
The constructor sets the pointer to the output object and the parser object.
double m_lastTensionTime
The time of the last accepted step [s].
Definition SeineOperation.h:266