DynamicDeepSeaGravityWaves Class Reference

Inheritance diagram for DynamicDeepSeaGravityWaves:

Collaboration diagram for DynamicDeepSeaGravityWaves:

Public Member Functions
	DynamicDeepSeaGravityWaves (string simObjectName, ISimObjectCreator *creator)
void	PreOdeFcn (const double T, const double *const X, IStateUpdater *updater)
Public Member Functions inherited from DeepSeaGravityWaves
	DeepSeaGravityWaves (string simObjectName, ISimObjectCreator *creator)
	Reads parameters, registers states, input/output ports and shared resources. More...
virtual void	FinalSetup (const double T, const double *const X, ISimObjectCreator *const creator)
double	GetSurfaceElevation (const double dT, const double *const dX, const double adPos[2])
	PC For initiation of shared resource NetCDFField. More...
void	GetSurfaceUnitNormal (const double dT, const double *const dX, const double adPos[2], double *adUnitNormalOut)
	Returns the unit normal vector of the surface at a specific position. More...
void	GetParticleVelocity (const double dT, const double *const dX, const double adPos[3], double *adVelOut)
	Returns the particle velocity at a specific position. More...
void	GetParticleAcceleration (const double dT, const double *const dX, const double adPos[3], double *adAccOut)
	Returns the particle acceleration at a specific position. More...
double	GetPressure (const double dT, const double *const dX, const double adPos[3])
	Returns the dynamic pressure at a specific position. More...
double	GetTotalPressure (const double dT, const double *const dX, const double adPos[3])
	Returns the total pressure at a specific position. More...
double	GetSeadepth (const double adPos[2])
	Returns the sea depth at a specific position. More...
double	GetSeabedSigma (const double adPos[3])
	Returns the sea depth sigma at a specific position. More...
double	GetSeabedTau (const double adPos[3])
	Returns the sea depth tau at a specific position. More...
double	GetSeabedRho (const double adPos[3])
	Returns the density of the seabed at a specific position. More...
void	RegisterCurrentField (ICurrentField *currentField)
	Registers an input current field in the environmental representation. More...
void	GetWaveFrequencies (std::vector< double > &vec)
	Returns a vector of all wave frequencies. More...
void	GetWaveAmplitudes (std::vector< double > &vec)
	Returns a vector of all wave amplitudes. More...
void	GetWavePhaseAngles (std::vector< double > &vec)
	Returns a vector of all wave phase angles. More...
void	GetWaveDirections (std::vector< double > &vec)
	Returns a vector of all wave directions. More...
void	GetWaveNumbers (std::vector< double > &vec)
	Returns a vector of all wave numbers. More...
void	GetCurrentVelocity (const double dT, const double *const dX, const double adPos[3], double *adVelOut)
	Returns the water current velocity at a specific position. More...
void	GetCurrentProducerVelocity (const double dT, const double *const dX, const double adPos[3], double *adVelOut)
	Returns the water current velocity producer at a specific position. More...
double	GetDensity (const double T, const double *const X, const double pos[3])
	Returns the water density at a specific position. More...
EnvironmentQuery	PointEnvironmentQuery (const double T, const double *const X, const double Position[3])
void	PointEnvironmentQuery2 (const double T, const double *const X, const double Position[3], EnvironmentQuery &q)
Public Member Functions inherited from CEnvironment
	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

Additional Inherited Members
Protected Member Functions inherited from DeepSeaGravityWaves
double	GetWakeRatio (const double T, const double *const X, const double adPos[3])
	Returns the wake effect ratio at a specific position. The horizontal velocity will be multiplied with this number. More...
Protected Attributes inherited from DeepSeaGravityWaves
LinearWaveTheory *	m_WaveTheory
string	m_waveTheoryName
	Enumerator holding the wave theory used.
string	m_spectrum
int	m_MaxNumWaves
int	m_NumWaves
int	m_NumWaves4Multiplier
vector< double >	m_adWaveFrequency
	For simulation without visualization. Is multiplied with 4 to get the total number of waves in a sea state.
vector< double >	m_adWaveAmplitude
	Array holding wave frequencies for all waves.
vector< double >	m_adWaveDirection
	Array holding wave amplitudes for all waves.
vector< double >	m_adPhaseAngle
	Array holding wave propagation directions for all waves.
vector< double >	m_adWaveNumber
	Array holding phase angles for all waves.
NetCDFsinmod::Grid *	m_grid
	Array holding wave number for all waves.
double *	m_depthMap
ICurrentField *	m_globalCurrentField
vector< ICurrentField * >	m_registeredCurrentFields
double	m_length_x
double	m_length_y
bool	m_useNetCDFField
CNCField *	m_ncField
	Parameter that decides whether NetCDFField (true) should be used.
bool	m_useArtificialTankVelField
	Pointer to CNCField.
double	m_UxyArtField
	Boolean variable. True means that an artificial field is set.
double	m_UzArtField
	Maximum velocity at tank walls (assuming circular tank)
double	m_tankRadius
	Vertical (constant) velocity in tank. Assuming constant vertical velocity with drain in the entire width of the circular tank.
bool	m_wakeEffect
	Tank radius for artificial velocity field.
int	m_wakeObjNum
ISignalPort **	m_wakeObjPort
ISignalPort *	m_wakeDirPort
ISignalPort *	m_wakeRatioPort
double	m_wakeObjRadius [3]
double	m_wakeObjDepth [3]
double	m_wakeObjPower
double	m_RampT

---

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

• reloadrepos/fhsim_environment/src/environment/DynamicDeepSeaGravityWaves.h