FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
Auv.h
1#pragma once
2
350#include "AuvFoil.h"
351#include "AuvHullLaw.h"
352
353#include <fhsim/simobject/SimObject.h>
354#include <fhsim_base/body/HydroBody.h>
355#include <fhsim_environment/BodyFlowInteraction.h>
356#include <fhsim_environment/EnvironmentProvider.h>
357#include <fhsim_environment/WakeSourceSet.h>
358#include <string>
359
360class PrintDuringExec;
361
362class Auv : public SimObject
363{
364public:
365 Auv(std::string simObjectName, ISimObjectCreator* creator);
366
373 ~Auv() override;
374
376 void OdeFcn(const double dT, const double* const adX, double* const adXDot) const override;
377
380
417 bool HasJacobians() const override;
418 void OdeJacobian(double T, const double* X, double* J, int nStates) override;
419 int GetJacobianSparsity(int nStates, int* rowPtr, int* colIdx) override;
420
464 bool HasPortJacobians() const override;
465 void InputPortJacobian(const std::string& portName, double T, const double* X,
466 double* dF_dInput, int portSize, int nStates) override;
467 void OutputPortJacobian(const std::string& portName, double T, const double* X,
468 double* dPort_dX, int portSize, int nStates, int index) override;
470
471 void FinalSetup(const double dT, const double* const adX, ISimObjectCreator* const creator) override;
472
474 void PreOdeFcn(double T, const double* X) override;
475
476#ifdef FH_VISUALIZATION
488 void RenderInit(Ogre::Root* const ogreRoot, ISimObjectCreator* const creator) override;
489
498 void RenderUpdate(const double dT, const double* const adX) override;
499#endif
500
501protected:
508 hydro_body::Wrench SumLoads(double T, const double* X, const hydro_body::FlowFrame& frame, double& propulsionPower) const;
509
511 void AddExternalForces(double T, const double* X, const hydro_body::FlowFrame& frame, hydro_body::Wrench& wrench) const;
512
514 void AddInternalForces(double T, const hydro_body::FlowFrame& frame, hydro_body::Wrench& wrench) const;
515
517 double AddThrustForces(double T, const double* X, const hydro_body::FlowFrame& frame, hydro_body::Wrench& wrench) const;
518
521 {
522 double dive = 0.0;
523 double yaw = 0.0;
524 };
525
527 RudderCommands ReadRudderCommands(double T, const double* X) const;
528
538 void WarnIfTheFinsCannotDive(const std::string& simObjectName, double diveAngle) const;
539
549 virtual double ComputeThrust(double propulsionPower) const;
550
552 double ClampedPropulsionPower(double commandedPower) const;
553
555 virtual void CalcOutput(const double dT, const double* const adX);
556
558 void CalcThrust(const double dT, const double* const adX);
559
561 void CalcOutputCommon(const double dT, const double* const adX) const;
562
565 const double* OutPos(const double dT, const double* const adX);
566 const double* OutVel(const double dT, const double* const adX);
567 const double* OutQuater(const double dT, const double* const adX);
568 const double* OutEuler(const double dT, const double* const adX);
569 const double* OutHeading(const double dT, const double* const adX);
570 const double* OutPitch(const double dT, const double* const adX);
571 const double* OutDepth(const double dT, const double* const adX);
572 const double* OutSpeed(const double dT, const double* const adX);
573 const double* OutAltitude(const double dT, const double* const adX);
574 const double* OutSeaDepth(const double dT, const double* const adX);
575 const double* OutBattery(const double dT, const double* const adX);
576 const double* OutBatteryFraction(const double dT, const double* const adX);
577 const double* OutThrust(const double dT, const double* const adX);
579
580 // Geometry and mass, all derived from Length, Diameter and AverageDensity.
581 double m_length = 0.0;
583 double m_cOG[3];
584 double m_rhoWater;
586
587 // Propulsion, drag and the hotel load.
591 double m_thrusterPos[3];
592
593 // Cross-flow strip theory and the roll damping it cannot supply, with the drag coefficients.
596
597 // The fins. One set of properties serves both planes; they differ only in which
598 // transverse component of the inflow they see.
600
604 class AuvCaster final : public environment::wake::PropelledObject
605 {
606 public:
607 explicit AuvCaster(const Auv& auv)
608 : m_auv(auv)
609 {
610 }
611
613 environment::wake::WakeCastState Reference(double T, const double* X) const override;
615 void CurrentLoad(double T, const double* X, const double freeStream[3], const double flowDir[3], double force[3], double& frontalArea,
616 double rearCentre[3]) const override;
618 environment::wake::PropellerJetInput PropellerJet(double T, const double* X) const override;
619
620 private:
621 const Auv& m_auv;
622 };
623
624 environment::EnvironmentProvider* m_environment = nullptr;
626 environment::wake::BodyFlowInteraction m_flow;
628 double m_propellerDiameter = 0.0;
629 PrintDuringExec* m_print = nullptr;
630
631 // Input ports
632 ISignalPort* m_inThrustPower = nullptr;
633 ISignalPort* m_inRudderYaw = nullptr;
634 ISignalPort* m_inRudderDive = nullptr;
635 ISignalPort* m_inExternalForce = nullptr;
636
637 ICommonComputation* m_commonCalc = nullptr;
638
653 unsigned long m_IStatePos = 0;
654 unsigned long m_IStateQuater = 0;
655 unsigned long m_IStateLocalVel = 0;
656 unsigned long m_IStateOmega = 0;
657 unsigned long m_IStateBattery = 0;
659
660 // Output port storage, written by CalcOutput (and m_outThrust by CalcThrust).
661 double m_outPos[3] = {0, 0, 0};
662 double m_outVel[3] = {0, 0, 0};
663 double m_outQuater[4] = {1, 0, 0, 0};
664 double m_outEuler[3] = {0, 0, 0};
665 double m_outDepth = 0.0;
666 double m_outSpeed = 0.0;
667 double m_outAltitude = 0.0;
668 double m_outSeaDepth = 0.0;
669 double m_outBatteryFraction = 0.0;
670 double m_outThrust = 0.0;
671
672#ifdef FH_VISUALIZATION
673 Ogre::SceneManager* m_sceneMgr = nullptr;
674 Ogre::SceneNode* m_renderNode = nullptr;
675 Ogre::SceneNode* m_diveFinNode = nullptr;
676 Ogre::SceneNode* m_yawFinNode = nullptr;
677 Ogre::ManualObject* m_hullObject = nullptr;
678 Ogre::ManualObject* m_diveFinObject = nullptr;
679 Ogre::ManualObject* m_yawFinObject = nullptr;
680#endif
681};
Definition Auv.h:605
void CurrentLoad(double T, const double *X, const double freeStream[3], const double flowDir[3], double force[3], double &frontalArea, double rearCentre[3]) const override
The hull, lift and fin drag at the free stream, on the frontal area pi D²/4, the rear centre at the s...
environment::wake::WakeCastState Reference(double T, const double *X) const override
The body origin and its velocity in NED.
environment::wake::PropellerJetInput PropellerJet(double T, const double *X) const override
The thruster at ThrusterPos, shaft along body x, T_eff = ComputeThrust() (no thrust deduction),...
Definition Auv.h:363
double m_maxPropulsionPower
The largest propulsion power accepted, W.
Definition Auv.h:589
virtual double ComputeThrust(double propulsionPower) const
double m_length
The hull length, m. Kept because the visualisation draws it.
Definition Auv.h:581
double m_outThrust
Thrust along body x, N.
Definition Auv.h:670
unsigned long m_IStateQuater
Global index of the attitude quaternion state.
Definition Auv.h:654
void AddInternalForces(double T, const hydro_body::FlowFrame &frame, hydro_body::Wrench &wrench) const
Adds the weight at COG and the buoyancy at the origin.
auv_hull::Coefficients m_coefficients
The drag and roll damping coefficients; rho copies m_rhoWater.
Definition Auv.h:595
unsigned long m_IStateLocalVel
Global index of the body-frame velocity state.
Definition Auv.h:655
void CalcOutputCommon(const double dT, const double *const adX) const
Trampoline registered as the common computation of every output port.
double m_cOG[3]
The centre of gravity in the body frame, m.
Definition Auv.h:583
double m_outPos[3]
Position in NED, m.
Definition Auv.h:661
void OdeFcn(const double dT, const double *const adX, double *const adXDot) const override
Calculates the state derivatives.
ICommonComputation * m_commonCalc
Shared recomputation behind every output port.
Definition Auv.h:637
ISignalPort * m_inRudderDive
Commanded dive-plane fin deflection, rad.
Definition Auv.h:634
ISignalPort * m_inExternalForce
An external force in NED, N.
Definition Auv.h:635
double ClampedPropulsionPower(double commandedPower) const
Clamps a commanded power to the range the thruster accepts, [0, MaxPropulsionPower].
double m_initialBattery
The battery energy at the start of the mission, J.
Definition Auv.h:585
ISignalPort * m_inThrustPower
Commanded propulsion power, W.
Definition Auv.h:632
double m_outVel[3]
Velocity in NED, m/s.
Definition Auv.h:662
double m_propellerDiameter
PropellerDiameter [m], read with CastWake only.
Definition Auv.h:628
double AddThrustForces(double T, const double *X, const hydro_body::FlowFrame &frame, hydro_body::Wrench &wrench) const
Adds the thruster wrench; returns the clamped propulsion power the battery pays for,...
double m_outSpeed
Forward speed through the water, m/s.
Definition Auv.h:666
double m_outQuater[4]
Attitude quaternion.
Definition Auv.h:663
environment::EnvironmentProvider * m_environment
m_flow's Environment, from FinalSetup.
Definition Auv.h:624
unsigned long m_IStateBattery
Global index of the battery energy state.
Definition Auv.h:657
void WarnIfTheFinsCannotDive(const std::string &simObjectName, double diveAngle) const
unsigned long m_IStatePos
Global index of the NED position state, the first state of this object.
Definition Auv.h:653
auv_hull::Hull m_hull
The derived radius, volume, mass and inertia.
Definition Auv.h:582
auv_hull::Rudder m_rudder
The fin geometry and coefficients.
Definition Auv.h:599
bool HasJacobians() const override
double m_outBatteryFraction
Remaining battery energy as a fraction of InitialBattery.
Definition Auv.h:669
double m_thrusterPos[3]
The thruster position in the body frame, m.
Definition Auv.h:591
HydroBody m_body
The states Pos, Quater, LocalVel and Omega, the mass matrix (rigid body and AddedMass) and the deriva...
Definition Auv.h:627
double m_outEuler[3]
Roll, pitch and yaw, rad.
Definition Auv.h:664
auv_hull::Sections m_sections
The strip-theory sections of the hull.
Definition Auv.h:594
double m_outSeaDepth
Seafloor depth below the surface, m.
Definition Auv.h:668
PrintDuringExec * m_print
The simulation logger, null under a headless or mock host.
Definition Auv.h:629
void CalcThrust(const double dT, const double *const adX)
Recomputes the Thrust output, the only one that reads an input port (ThrustPower)....
double m_outDepth
Depth below the mean free surface, m.
Definition Auv.h:665
virtual void CalcOutput(const double dT, const double *const adX)
Recomputes every output port but Thrust from the given time and state; none reads an input port.
unsigned long m_IStateOmega
Global index of the body-frame angular velocity state.
Definition Auv.h:656
RudderCommands ReadRudderCommands(double T, const double *X) const
Reads both fin ports and returns the deflections.
double m_hotelPower
The constant payload and computer load, W.
Definition Auv.h:590
hydro_body::Wrench SumLoads(double T, const double *X, const hydro_body::FlowFrame &frame, double &propulsionPower) const
AuvCaster m_caster
The vehicle for its wake and jet; declared before m_flow, which keeps a pointer to it.
Definition Auv.h:625
~Auv() override
double m_outAltitude
Height above the seafloor, m.
Definition Auv.h:667
environment::wake::BodyFlowInteraction m_flow
The wakes the vehicle casts and receives.
Definition Auv.h:626
bool HasPortJacobians() const override
double m_thrustPerPower
Thrust per watt of propulsion power, N/W.
Definition Auv.h:588
void AddExternalForces(double T, const double *X, const hydro_body::FlowFrame &frame, hydro_body::Wrench &wrench) const
Adds the ExternalForce input port, at the body origin.
double m_rhoWater
The density of the surrounding fluid, kg/m³.
Definition Auv.h:584
void PreOdeFcn(double T, const double *X) override
Rebuilds the hull wake and the propeller jet when due (CastWake) and takes the other objects' wakes a...
ISignalPort * m_inRudderYaw
Commanded yaw-plane fin deflection, rad.
Definition Auv.h:633
Definition HydroBody.h:101
The commanded deflections of the two fin planes, rad.
Definition Auv.h:521
double dive
The dive plane.
Definition Auv.h:522
double yaw
The yaw plane.
Definition Auv.h:523
The coefficients of the hull laws. rho is a copy of the water density of the host (as Rudder::rho is)...
Definition AuvHullLaw.h:286
Definition AuvHullLaw.h:178
Everything one fin plane needs beyond its inflow and its commanded deflection.
Definition AuvHullLaw.h:201
The strip-theory sections of the hull, kSectionCount of each array.
Definition AuvHullLaw.h:278
Definition HydroBody.h:42
The sum of the loads on a body: the force [0..2] and the moment about the origin [3....
Definition HydroBody.h:57