CEnvironment.h

#ifndef ENVIRONMENT_H
#define ENVIRONMENT_H
 
#include "ICurrentField.h"
#include "SimObject.h"
 
#include <vector>
 
class CEnvironment : public SimObject
{
   public:
   CEnvironment(const string& sSimObjectName, ISimObjectCreator* const pCreator);
   void OdeFcn(const double dT, const double* const adX, double* const adXDot, const bool bIsMajorTimeStep);
 
   virtual double GetSurfaceElevation(const double dT, const double* const dX, const double adPos[2])                         = 0;
   virtual void GetSurfaceUnitNormal(const double dT, const double* const dX, const double adPos[2], double* adUnitNormalOut) = 0;
   virtual void GetParticleVelocity(const double dT, const double* const dX, const double adPos[3], double* adVelOut)         = 0;
   virtual void GetCurrentVelocity(const double dT, const double* const dX, const double adPos[3], double* adVelOut)          = 0;
   virtual void GetParticleAcceleration(const double dT, const double* const dX, const double adPos[3], double* adAccOut)     = 0;
   virtual double GetPressure(const double dT, const double* const dX, const double adPos[3])                                 = 0;
   virtual double GetTotalPressure(const double dT, const double* const dX, const double adPos[3])                            = 0;
   virtual double GetDensity(const double dT, const double* const dX, const double adPos[3])                                  = 0;
   virtual double GetSeadepth(const double adPos[2])                                                                          = 0;
   virtual double GetSeabedSigma(const double adPos[3])                                                                       = 0;
   virtual double GetSeabedTau(const double adPos[3])                                                                         = 0;
   virtual double GetSeabedRho(const double adPos[3])                                                                         = 0;
   virtual void RegisterCurrentField(ICurrentField* currentField)                                                             = 0;
 
   // Access to DeepSeaGravityWaves ==================================
   virtual void GetWaveFrequencies(std::vector<double>& vec);
   virtual void GetWaveAmplitudes(std::vector<double>& vec);
   virtual void GetWavePhaseAngles(std::vector<double>& vec);
   virtual void GetWaveDirections(std::vector<double>& vec);
   virtual void GetWaveNumbers(std::vector<double>& vec);
   // Access to DeepSeaGravityWaves ==================================
 
   struct EnvironmentQuery
   {
      double surface_elevation;
      double surface_unit_normal[3];
      double particle_velocity[3];
      double particle_acceleration[3];
      double current_velocity[3];
      double pressure;
      double density;
 
      void SetZero()
      {
         surface_elevation = 0;
         for (int i = 0; i < 3; ++i) {
            surface_unit_normal[i]   = 0;
            particle_velocity[i]     = 0;
            particle_acceleration[i] = 0;
            current_velocity[i]      = 0;
         }
         pressure = 0;
         density  = 0;
      }
   };
   virtual EnvironmentQuery PointEnvironmentQuery(const double T, const double* const X, const double Position[3])           = 0;
   virtual void PointEnvironmentQuery2(const double T, const double* const X, const double Position[3], EnvironmentQuery& q) = 0;
 
#ifdef FH_VISUALIZATION
   virtual void RenderInit(Ogre::Root* const pOgreRoot, ISimObjectCreator* const pCreator) = 0;
   virtual void RenderUpdate(const double dT, const double* const adX)                     = 0;
#endif
};
#endif