Marine systems simulation
Classes | Public Member Functions | List of all members
CEnvironment Class Referenceabstract
+ Inheritance diagram for CEnvironment:
+ Collaboration diagram for CEnvironment:

Classes

struct  EnvironmentQuery
 

Public Member Functions

 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
 
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)
 
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
 

Member Function Documentation

◆ GetCurrentVelocity()

virtual void CEnvironment::GetCurrentVelocity ( const double  dT,
const double *const  dX,
const double  adPos[3],
double *  adVelOut 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetDensity()

virtual double CEnvironment::GetDensity ( const double  dT,
const double *const  dX,
const double  adPos[3] 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetParticleAcceleration()

virtual void CEnvironment::GetParticleAcceleration ( const double  dT,
const double *const  dX,
const double  adPos[3],
double *  adAccOut 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetParticleVelocity()

virtual void CEnvironment::GetParticleVelocity ( const double  dT,
const double *const  dX,
const double  adPos[3],
double *  adVelOut 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetPressure()

virtual double CEnvironment::GetPressure ( const double  dT,
const double *const  dX,
const double  adPos[3] 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSeabedRho()

virtual double CEnvironment::GetSeabedRho ( const double  adPos[3])
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSeabedSigma()

virtual double CEnvironment::GetSeabedSigma ( const double  adPos[3])
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSeabedTau()

virtual double CEnvironment::GetSeabedTau ( const double  adPos[3])
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSeadepth()

virtual double CEnvironment::GetSeadepth ( const double  adPos[2])
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSurfaceElevation()

virtual double CEnvironment::GetSurfaceElevation ( const double  dT,
const double *const  dX,
const double  adPos[2] 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetSurfaceUnitNormal()

virtual void CEnvironment::GetSurfaceUnitNormal ( const double  dT,
const double *const  dX,
const double  adPos[2],
double *  adUnitNormalOut 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetTotalPressure()

virtual double CEnvironment::GetTotalPressure ( const double  dT,
const double *const  dX,
const double  adPos[3] 
)
pure virtual

Implemented in DeepSeaGravityWaves.

◆ GetWaveAmplitudes()

virtual void CEnvironment::GetWaveAmplitudes ( std::vector< double > &  vec)
virtual

Reimplemented in DeepSeaGravityWaves.

◆ GetWaveDirections()

virtual void CEnvironment::GetWaveDirections ( std::vector< double > &  vec)
virtual

Reimplemented in DeepSeaGravityWaves.

◆ GetWaveFrequencies()

virtual void CEnvironment::GetWaveFrequencies ( std::vector< double > &  vec)
virtual

Reimplemented in DeepSeaGravityWaves.

◆ GetWaveNumbers()

virtual void CEnvironment::GetWaveNumbers ( std::vector< double > &  vec)
virtual

Reimplemented in DeepSeaGravityWaves.

◆ GetWavePhaseAngles()

virtual void CEnvironment::GetWavePhaseAngles ( std::vector< double > &  vec)
virtual

Reimplemented in DeepSeaGravityWaves.

◆ RegisterCurrentField()

virtual void CEnvironment::RegisterCurrentField ( ICurrentField *  currentField)
pure virtual

Implemented in DeepSeaGravityWaves.

The documentation for this class was generated from the following file: