A helper class to call methods from any active WindLab Features. More...

#include <RPSWindLabFramework.h>

Public Member Functions
	CRPSWindLabFramework ()
	construction

	~CRPSWindLabFramework ()
	destruction

Static Public Member Functions
static bool	ComputeAutoSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, const double &dTime, double &dValue)
	Compute the auto spectrum value for given time, frequency and locations according to the selected wind direction.

static bool	ComputeAutoSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the auto spectrum between two simulation points for all frequency increments according to the selected wind direction.

static bool	ComputeAutoSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, vec &dVarVector, vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments according to the selected wind direction.

static bool	ComputeCPDValue (const WindLabSimulationData &Data, const double &x, double &dValue)
	Compute the cumulative probability distribution value for x.

static bool	ComputeCPDVectorX (const WindLabSimulationData &Data, vec &dVarVector, vec &dValVector)
	Compute the cumulative probability distribution for all increments of variable x.

static bool	ComputeCrossCoherenceMatrixPP (const WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &dCoherenceMatrix)
	Compute the cross coherence matrix for given time and frequency.

static bool	ComputeCrossCoherenceValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the cross coherence value for given time, frequency and locations.

static bool	ComputeCrossCoherenceVectorF (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the cross coherence between two simulation points for all frequency increments.

static bool	ComputeCrossCoherenceVectorT (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the cross coherence between two simulation points for all time increments.

static bool	ComputeCrossCorrelationMatrixPP (const WindLabSimulationData &Data, const double &dTime, mat &dCorrelationMatrix)
	Compute the cross correlation matrix for given time and frequency.

static bool	ComputeCrossCorrelationValue (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, double &dValue)
	Compute the cross correlation value for given time and locations.

static bool	ComputeCrossCorrelationVectorT (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, vec &dVarVector, vec &dValVector)
	Compute the cross correlation between two simulation points for all time increments.

static bool	ComputeCrossSpectrumMatrixPP (const WindLabAPI::WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &psdMatrix)
	Compute the cross spectrum matrix for given time and frequency according to the selected wind direction.

static bool	ComputeCrossSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the spectrum value for given time, frequency and locations according to the selected wind direction.

static bool	ComputeCrossSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all frequency increments according to the selected wind direction.

static bool	ComputeCrossSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments according to the selected wind direction.

static bool	ComputeDecomposedCrossSpectrumMatrixPP (const WindLabAPI::WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &dPSDMatrix)
	Compute the decomposed spectrum matrix for given time and frequency.

static bool	ComputeDecomposedCrossSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the decomposed spectrum between two simulation points for all frequency increments.

static bool	ComputeDecomposedCrossSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the decomposed spectrum between two simulation points for all time increments.

static bool	ComputeFrequenciesMatrixFP (const WindLabSimulationData &Data, mat &dMatrix)
	Compute the frequency matrix for all frequency indexes and locations.

static bool	ComputeFrequenciesVectorF (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dValVector)
	Compute the frequency increments for all frequency indexes.

static bool	ComputeFrequencyValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const int &frequencyIndex, double &dValue)
	Compute the frequency increment value by frequency index for given location (simulation point).

static bool	ComputeGustFactorValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the gust factor value for given time and location.

static bool	ComputeGustFactorVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the gust factors at a given time and for all locations (simulation points).

static bool	ComputeGustFactorVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the gust factors at a given location (simulation point) and for all time increments.

static bool	ComputeKurtosisValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the kurtosis value for given time and location.

static bool	ComputeKurtosisVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the kurtosis at a given time instant and for all locations (simulation points).

static bool	ComputeKurtosisVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the kurtosis at a given location (simulation point) and for all time increments.

static bool	ComputeLocationCoordinateMatrixP3 (const WindLabSimulationData &Data, mat &dLocCoord)
	Compute the location coordinates according to their distribution in space.

static bool	ComputeMeanWindSpeedValue (const WindLabSimulationData &Data, Base::Vector3d location, const double &dTime, double &dValue)
	Compute the mean wind speed value for given time and location.

static bool	ComputeMeanWindSpeedVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the mean wind speed at a given time instant and for all locations (simulation points).

static bool	ComputeMeanWindSpeedVectorT (const WindLabSimulationData &Data, Base::Vector3d location, vec &dVarVector, vec &dValVector)
	Compute the mean wind speed at a given location (simulation point) and for all time increments.

static bool	ComputeModulationValue (const WindLabSimulationData &Data, Base::Vector3d location, const double &dTime, double &dValue)
	Compute the modulation value for given time and location.

static bool	ComputeModulationVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the modulation at a given time instant and for all locations (simulation points).

static bool	ComputeModulationVectorT (const WindLabSimulationData &Data, Base::Vector3d location, vec &dVarVector, vec &dValVector)
	Compute the modulation at a given location (simulation point) and for all time increments.

static bool	ComputePDFValue (const WindLabSimulationData &Data, const double &x, double &dValue)
	Compute the probability dendity value for x.

static bool	ComputePDFVectorX (const WindLabSimulationData &Data, vec &dVarVector, vec &dValVector)
	Compute the probability dendity for all increments of variable x.

static bool	ComputePeakFactorValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the peak factor value for given time and location.

static bool	ComputePeakFactorVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the peak factor at a given time instant and for all locations (simulation points).

static bool	ComputePeakFactorVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the peak factor at a given location (simulation point) and for all time increments.

static bool	ComputeRandomValue (const WindLabSimulationData &Data, double &dValue)
	Generate a random value.

static bool	ComputeRoughnessValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the roughness value for given time and location.

static bool	ComputeRoughnessVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the roughness values at a given time instant and for all locations (simulation points).

static bool	ComputeRoughnessVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the roughness value at a given location (simulation point) and for all time increments.

static bool	ComputeShearVelocityOfFlowValue (const WindLabSimulationData &Data, Base::Vector3d location, const double &dTime, double &dValue)
	Compute the shear velocity value for given time and location.

static bool	ComputeShearVelocityOfFlowVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the shear velocity at a given time instant and for all locations (simulation points).

static bool	ComputeShearVelocityOfFlowVectorT (const WindLabSimulationData &Data, Base::Vector3d location, vec &dVarVector, vec &dValVector)
	Compute the shear velocity at a given location (simulation point) and for all time increments.

static bool	ComputeSkewnessValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the skewness value for given time and location.

static bool	ComputeSkewnessVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the skewness values at a given time instant and for all locations (simulation points).

static bool	ComputeSkewnessVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the skewness values at a given location (simulation point) and for all time increments.

static bool	ComputeStandardDeviationValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the standard deviation value for given time and location.

static bool	ComputeStandardDeviationVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the standard deviation values at a given time instant and for all locations (simulation points).

static bool	ComputeStandardDeviationVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the standard deviation values at a given location (simulation point) and for all time increments.

static bool	ComputeTurbulenceIntensityValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the turbulence intensity value for given time and location.

static bool	ComputeTurbulenceIntensityVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the turbulence intensity at a given time instant and for all locations (simulation points).

static bool	ComputeTurbulenceIntensityVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the turbulence intensity at a given location (simulation point) and for all time increments.

static bool	ComputeTurbulenceScaleValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the turbulence scale value for given time and location.

static bool	ComputeTurbulenceScaleVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the turbulence scale at a given time instant and for all locations (simulation points).

static bool	ComputeTurbulenceScaleVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the turbulence scale at a given location (simulation point) and for all time increments.

static bool	ComputeVarianceValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)
	Compute the variance value for given time and location.

static bool	ComputeVarianceVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the variance at a given time instant and for all locations (simulation points).

static bool	ComputeVarianceVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)
	Compute the variance at a given location (simulation point) and for all time increments.

static bool	ComputeWavePassageEffectMatrixPP (const WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &dCoherenceMatrix)
	Compute the wave passage effect matrix for given time and frequency.

static bool	ComputeWavePassageEffectValue (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the wave passage effect value for given time, frequency and locations.

static bool	ComputeWavePassageEffectVectorF (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the wave passage effect between two simulation points for all frequency increments.

static bool	ComputeWavePassageEffectVectorT (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the wave passage effect between two simulation points for all time increments.

static bool	ComputeXAutoSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, const double &dTime, double &dValue)
	Compute the auto spectrum value for given time, frequency and locations.

static bool	ComputeXAutoSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the auto spectrum between two simulation points for all frequency increments.

static bool	ComputeXAutoSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, vec &dVarVector, vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	ComputeXCrossSpectrumMatrixPP (const WindLabAPI::WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &psdMatrix)
	Compute the cross spectrum matrix for given time and frequency.

static bool	ComputeXCrossSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the cross spectrum value for given time, frequency and locations.

static bool	ComputeXCrossSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all frequency increments.

static bool	ComputeXCrossSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	ComputeYAutoSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, const double &dTime, double &dValue)
	Compute the auto spectrum value for given time, frequency and locations.

static bool	ComputeYAutoSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the auto spectrum between two simulation points for all frequency increments.

static bool	ComputeYAutoSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, vec &dVarVector, vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	ComputeYCrossSpectrumMatrixPP (const WindLabAPI::WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &psdMatrix)
	Compute the cross spectrum matrix for given time and frequency.

static bool	ComputeYCrossSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the cross spectrum value for given time, frequency and locations.

static bool	ComputeYCrossSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all frequency increments.

static bool	ComputeYCrossSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	ComputeZAutoSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, const double &dTime, double &dValue)
	Compute the auto spectrum value for given time, frequency and locations.

static bool	ComputeZAutoSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, vec &dVarVector, vec &dValVector)
	Compute the auto spectrum between two simulation points for all frequency increments.

static bool	ComputeZAutoSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &location, const double &dFrequency, vec &dVarVector, vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	ComputeZCrossSpectrumMatrixPP (const WindLabAPI::WindLabSimulationData &Data, const double &dFrequency, const double &dTime, cx_mat &psdMatrix)
	Compute the cross spectrum matrix for given time and frequency.

static bool	ComputeZCrossSpectrumValue (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, const double &dTime, std::complex< double > &dValue)
	Compute the cross spectrum value for given time, frequency and locations.

static bool	ComputeZCrossSpectrumVectorF (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all frequency increments.

static bool	ComputeZCrossSpectrumVectorT (const WindLabAPI::WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dFrequency, vec &dVarVector, cx_vec &dValVector)
	Compute the cross spectrum between two simulation points for all time increments.

static bool	GenerateRandomMatrixFP (const WindLabSimulationData &Data, mat &dRandomValueArray)
	Generate the random value matrix for all frequency increments and locations.

static int	getLocationIndex (const WindLabAPI::WindLabSimulationData &Data, Base::Vector3d locationTobeFound)
	Given a location coordinates, this function identify the index (numbering) of the location (simulation point) among all the simulation points (locations).

static WindLabAPI::WindLabFeatureDescription *	getWindLabFeatureDescription (const std::string &name)
	Get the description of a feature by its name.

static bool	MatrixToolCompute (const WindLabSimulationData &Data, const mat &inputMatrix, mat &outputMatrix)
	Compute the kurtosis at a given location (simulation point) and for all time increments.

static bool	Simulate (const WindLabSimulationData &Data, mat &dVelocityArray)
	Generate random wind velocity.

static bool	SimulateInLargeScaleMode (const WindLabSimulationData &Data, QString &strFileName)
	Generate random wind velocity in large scale simulation mode.

static bool	TableToolCompute (const WindLabSimulationData &Data, const mat &inputTable, mat &outputTable)
	Compute the kurtosis at a given location (simulation point) and for all time increments.

static bool	UserDefinedRPSObjectCompute (const WindLabSimulationData &Data, mat &dresult)
	Run the user defined computation tool.

Detailed Description

A helper class to call methods from any active WindLab Features.

This class allow the developer to call methods from any active feature in just a single line.

Constructor & Destructor Documentation

◆ CRPSWindLabFramework()

CRPSWindLabFramework::CRPSWindLabFramework ( )

construction

◆ ~CRPSWindLabFramework()

CRPSWindLabFramework::~CRPSWindLabFramework ( )

destruction

Member Function Documentation

◆ ComputeAutoSpectrumValue()

bool CRPSWindLabFramework::ComputeAutoSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		const double &	dTime,
		double &	dValue )

static

Compute the auto spectrum value for given time, frequency and locations according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXAutoSpectrumValue(), ComputeYAutoSpectrumValue(), ComputeZAutoSpectrumValue(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeAutoSpectrumVectorF()

bool CRPSWindLabFramework::ComputeAutoSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the auto spectrum between two simulation points for all frequency increments according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXAutoSpectrumVectorF(), ComputeYAutoSpectrumVectorF(), ComputeZAutoSpectrumVectorF(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeAutoSpectrumVectorT()

bool CRPSWindLabFramework::ComputeAutoSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXAutoSpectrumVectorT(), ComputeYAutoSpectrumVectorT(), ComputeZAutoSpectrumVectorT(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeCPDValue()

bool CRPSWindLabFramework::ComputeCPDValue	(	const WindLabSimulationData &	Data,
		const double &	x,
		double &	dValue )

static

Compute the cumulative probability distribution value for x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
x	a value for with the cumulative probability distribution is computed
dValue	a value to be updated. This is the computed value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLCumulativeProbabilityDistribution::ComputeCPDValue(), and WindLabAPI::WindLabSimulationData::cumulativeProbabilityDistribution.

◆ ComputeCPDVectorX()

bool CRPSWindLabFramework::ComputeCPDVectorX	(	const WindLabSimulationData &	Data,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cumulative probability distribution for all increments of variable x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dVarVector	a vector to be updated. It should contains all the variable x increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each variable x increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLCumulativeProbabilityDistribution::ComputeCPDVectorX(), and WindLabAPI::WindLabSimulationData::cumulativeProbabilityDistribution.

◆ ComputeCrossCoherenceMatrixPP()

bool CRPSWindLabFramework::ComputeCrossCoherenceMatrixPP	(	const WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	dCoherenceMatrix )

static

Compute the cross coherence matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the coherence matrix will be computed.
dTime	the time instant at which the coherence matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed coherence matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::coherenceFunction, and WindLabAPI::IrpsWLCoherence::ComputeCrossCoherenceMatrixPP().

◆ ComputeCrossCoherenceValue()

bool CRPSWindLabFramework::ComputeCrossCoherenceValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the cross coherence value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the coherence value will be computed.
dTime	the time instant at which the coherence value will be computed.
dValue	a value to be updated. This is the computed coherence value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::coherenceFunction, and WindLabAPI::IrpsWLCoherence::ComputeCrossCoherenceValue().

◆ ComputeCrossCoherenceVectorF()

bool CRPSWindLabFramework::ComputeCrossCoherenceVectorF	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross coherence between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the coherence vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::coherenceFunction, and WindLabAPI::IrpsWLCoherence::ComputeCrossCoherenceVectorF().

◆ ComputeCrossCoherenceVectorT()

bool CRPSWindLabFramework::ComputeCrossCoherenceVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross coherence between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the coherence vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::coherenceFunction, and WindLabAPI::IrpsWLCoherence::ComputeCrossCoherenceVectorT().

◆ ComputeCrossCorrelationMatrixPP()

bool CRPSWindLabFramework::ComputeCrossCorrelationMatrixPP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		mat &	dCorrelationMatrix )

static

Compute the cross correlation matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the correlation matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed correlation matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLCorrelation::ComputeCrossCorrelationMatrixPP(), and WindLabAPI::WindLabSimulationData::correlationFunction.

◆ ComputeCrossCorrelationValue()

bool CRPSWindLabFramework::ComputeCrossCorrelationValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		double &	dValue )

static

Compute the cross correlation value for given time and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the correlation value will be computed.
dValue	a value to be updated. This is the computed correlation value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLCorrelation::ComputeCrossCorrelationValue(), and WindLabAPI::WindLabSimulationData::correlationFunction.

◆ ComputeCrossCorrelationVectorT()

bool CRPSWindLabFramework::ComputeCrossCorrelationVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cross correlation between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLCorrelation::ComputeCrossCorrelationVectorT(), and WindLabAPI::WindLabSimulationData::correlationFunction.

◆ ComputeCrossSpectrumMatrixPP()

bool CRPSWindLabFramework::ComputeCrossSpectrumMatrixPP	(	const WindLabAPI::WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	psdMatrix )

static

Compute the cross spectrum matrix for given time and frequency according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the spectrum matrix will be computed.
dTime	the time instant at which the spectrum matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed spectrum matrix.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXCrossSpectrumMatrixPP(), ComputeYCrossSpectrumMatrixPP(), ComputeZCrossSpectrumMatrixPP(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeCrossSpectrumValue()

bool CRPSWindLabFramework::ComputeCrossSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the spectrum value for given time, frequency and locations according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXCrossSpectrumValue(), ComputeYCrossSpectrumValue(), ComputeZCrossSpectrumValue(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeCrossSpectrumVectorF()

bool CRPSWindLabFramework::ComputeCrossSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all frequency increments according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXCrossSpectrumVectorF(), ComputeYCrossSpectrumVectorF(), ComputeZCrossSpectrumVectorF(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeCrossSpectrumVectorT()

bool CRPSWindLabFramework::ComputeCrossSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments according to the selected wind direction.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References ComputeXCrossSpectrumVectorT(), ComputeYCrossSpectrumVectorT(), ComputeZCrossSpectrumVectorT(), and WindLabAPI::WindLabSimulationData::WindDirection.

◆ ComputeDecomposedCrossSpectrumMatrixPP()

bool CRPSWindLabFramework::ComputeDecomposedCrossSpectrumMatrixPP	(	const WindLabAPI::WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	dPSDMatrix )

static

Compute the decomposed spectrum matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the decomposed spectrum matrix will be computed.
dTime	the time instant at which the decomposed spectrum matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed decomposed spectrum matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPSDdecompositionMethod::ComputeDecomposedCrossSpectrumMatrixPP(), and WindLabAPI::WindLabSimulationData::cpsdDecompositionMethod.

◆ ComputeDecomposedCrossSpectrumVectorF()

bool CRPSWindLabFramework::ComputeDecomposedCrossSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the decomposed spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the decomposed spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPSDdecompositionMethod::ComputeDecomposedCrossSpectrumVectorF(), and WindLabAPI::WindLabSimulationData::cpsdDecompositionMethod.

◆ ComputeDecomposedCrossSpectrumVectorT()

bool CRPSWindLabFramework::ComputeDecomposedCrossSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the decomposed spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the decomposed spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPSDdecompositionMethod::ComputeDecomposedCrossSpectrumVectorT(), and WindLabAPI::WindLabSimulationData::cpsdDecompositionMethod.

◆ ComputeFrequenciesMatrixFP()

bool CRPSWindLabFramework::ComputeFrequenciesMatrixFP	(	const WindLabSimulationData &	Data,
		mat &	dMatrix )

static

Compute the frequency matrix for all frequency indexes and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user..
dMatrix	a matrix to be updated. It should contain the computed frequency matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequenciesMatrixFP(), and WindLabAPI::WindLabSimulationData::frequencyDistribution.

◆ ComputeFrequenciesVectorF()

bool CRPSWindLabFramework::ComputeFrequenciesVectorF	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dValVector )

static

Compute the frequency increments for all frequency indexes.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dValVector	a vector to be updated. It should contain all the values computed for each frequency index.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequenciesVectorF(), and WindLabAPI::WindLabSimulationData::frequencyDistribution.

◆ ComputeFrequencyValue()

bool CRPSWindLabFramework::ComputeFrequencyValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const int &	frequencyIndex,
		double &	dValue )

static

Compute the frequency increment value by frequency index for given location (simulation point).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
frequencyIndex	an integer representing the frequency index where the value will be computed.
dValue	a value to be updated. This is the computed frequency value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequencyValue(), and WindLabAPI::WindLabSimulationData::frequencyDistribution.

◆ ComputeGustFactorValue()

bool CRPSWindLabFramework::ComputeGustFactorValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the gust factor value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the gust factor value will be computed.
dValue	a value to be updated. This is the computed gust factor value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLGustFactor::ComputeGustFactorValue(), and WindLabAPI::WindLabSimulationData::gustFactor.

◆ ComputeGustFactorVectorP()

bool CRPSWindLabFramework::ComputeGustFactorVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the gust factors at a given time and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the gust factor value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLGustFactor::ComputeGustFactorVectorP(), and WindLabAPI::WindLabSimulationData::gustFactor.

◆ ComputeGustFactorVectorT()

bool CRPSWindLabFramework::ComputeGustFactorVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the gust factors at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLGustFactor::ComputeGustFactorVectorT(), and WindLabAPI::WindLabSimulationData::gustFactor.

◆ ComputeKurtosisValue()

bool CRPSWindLabFramework::ComputeKurtosisValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the kurtosis value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the kurtosis value will be computed.
dValue	a value to be updated. This is the computed kurtosis value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLKurtosis::ComputeKurtosisValue(), and WindLabAPI::WindLabSimulationData::kurtosis.

◆ ComputeKurtosisVectorP()

bool CRPSWindLabFramework::ComputeKurtosisVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the kurtosis at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the kurtosis value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLKurtosis::ComputeKurtosisVectorP(), and WindLabAPI::WindLabSimulationData::kurtosis.

◆ ComputeKurtosisVectorT()

bool CRPSWindLabFramework::ComputeKurtosisVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the kurtosis at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLKurtosis::ComputeKurtosisVectorT(), and WindLabAPI::WindLabSimulationData::kurtosis.

◆ ComputeLocationCoordinateMatrixP3()

bool CRPSWindLabFramework::ComputeLocationCoordinateMatrixP3	(	const WindLabSimulationData &	Data,
		mat &	dLocCoord )

static

Compute the location coordinates according to their distribution in space.

Parameters

Data	the simulation data containing all the simulation parameters input by the user..
dLocCoord	a matrix to be updated. It should contain the computed location coordinates.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLLocationDistribution::ComputeLocationCoordinateMatrixP3(), and WindLabAPI::WindLabSimulationData::spatialDistribution.

Referenced by getLocationIndex().

◆ ComputeMeanWindSpeedValue()

bool CRPSWindLabFramework::ComputeMeanWindSpeedValue	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		const double &	dTime,
		double &	dValue )

static

Compute the mean wind speed value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the mean wind speed value will be computed.
dValue	a value to be updated. This is the computed mean wind speed value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLMean::ComputeMeanWindSpeedValue(), and WindLabAPI::WindLabSimulationData::meanFunction.

◆ ComputeMeanWindSpeedVectorP()

bool CRPSWindLabFramework::ComputeMeanWindSpeedVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the mean wind speed at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the mean wind speed value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLMean::ComputeMeanWindSpeedVectorP(), and WindLabAPI::WindLabSimulationData::meanFunction.

◆ ComputeMeanWindSpeedVectorT()

bool CRPSWindLabFramework::ComputeMeanWindSpeedVectorT	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the mean wind speed at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLMean::ComputeMeanWindSpeedVectorT(), and WindLabAPI::WindLabSimulationData::meanFunction.

◆ ComputeModulationValue()

bool CRPSWindLabFramework::ComputeModulationValue	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		const double &	dTime,
		double &	dValue )

static

Compute the modulation value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the modulation value will be computed.
dValue	a value to be updated. This is the computed modulation value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLModulation::ComputeModulationValue(), and WindLabAPI::WindLabSimulationData::modulationFunction.

◆ ComputeModulationVectorP()

bool CRPSWindLabFramework::ComputeModulationVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the modulation at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the modulation value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLModulation::ComputeModulationVectorP(), and WindLabAPI::WindLabSimulationData::modulationFunction.

◆ ComputeModulationVectorT()

bool CRPSWindLabFramework::ComputeModulationVectorT	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the modulation at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLModulation::ComputeModulationVectorT(), and WindLabAPI::WindLabSimulationData::modulationFunction.

◆ ComputePDFValue()

bool CRPSWindLabFramework::ComputePDFValue	(	const WindLabSimulationData &	Data,
		const double &	x,
		double &	dValue )

static

Compute the probability dendity value for x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
x	a value for with the probability dendity is computed
dValue	a value to be updated. This is the computed value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLProbabilityDensityFunction::ComputePDFValue(), and WindLabAPI::WindLabSimulationData::probabilityDensityFunction.

◆ ComputePDFVectorX()

bool CRPSWindLabFramework::ComputePDFVectorX	(	const WindLabSimulationData &	Data,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the probability dendity for all increments of variable x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dVarVector	a vector to be updated. It should contains all the variable x increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each variable x increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLProbabilityDensityFunction::ComputePDFVectorX(), and WindLabAPI::WindLabSimulationData::probabilityDensityFunction.

◆ ComputePeakFactorValue()

bool CRPSWindLabFramework::ComputePeakFactorValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the peak factor value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the peak factor value will be computed.
dValue	a value to be updated. This is the computed peak factor value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPeakFactor::ComputePeakFactorValue(), and WindLabAPI::WindLabSimulationData::peakFactor.

◆ ComputePeakFactorVectorP()

bool CRPSWindLabFramework::ComputePeakFactorVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the peak factor at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the peak factor value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPeakFactor::ComputePeakFactorVectorP(), and WindLabAPI::WindLabSimulationData::peakFactor.

◆ ComputePeakFactorVectorT()

bool CRPSWindLabFramework::ComputePeakFactorVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the peak factor at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLPeakFactor::ComputePeakFactorVectorT(), and WindLabAPI::WindLabSimulationData::peakFactor.

◆ ComputeRandomValue()

bool CRPSWindLabFramework::ComputeRandomValue	(	const WindLabSimulationData &	Data,
		double &	dValue )

static

Generate a random value.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dValue	a value to be updated. This is the generated random value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::comparisonMode, WindLabAPI::IrpsWLRandomness::ComputeRandomValue(), and WindLabAPI::WindLabSimulationData::randomnessProvider.

◆ ComputeRoughnessValue()

bool CRPSWindLabFramework::ComputeRoughnessValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the roughness value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the roughness value will be computed.
dValue	a value to be updated. This is the computed roughness value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLRoughness::ComputeRoughnessValue(), and WindLabAPI::WindLabSimulationData::roughness.

◆ ComputeRoughnessVectorP()

bool CRPSWindLabFramework::ComputeRoughnessVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the roughness values at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the roughness value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLRoughness::ComputeRoughnessVectorP(), and WindLabAPI::WindLabSimulationData::roughness.

◆ ComputeRoughnessVectorT()

bool CRPSWindLabFramework::ComputeRoughnessVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the roughness value at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLRoughness::ComputeRoughnessVectorT(), and WindLabAPI::WindLabSimulationData::roughness.

◆ ComputeShearVelocityOfFlowValue()

bool CRPSWindLabFramework::ComputeShearVelocityOfFlowValue	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		const double &	dTime,
		double &	dValue )

static

Compute the shear velocity value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the shear velocity value will be computed.
dValue	a value to be updated. This is the computed shear velocity value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLShearVelocityOfFlow::ComputeShearVelocityOfFlowValue(), and WindLabAPI::WindLabSimulationData::shearVelocityOfFlow.

◆ ComputeShearVelocityOfFlowVectorP()

bool CRPSWindLabFramework::ComputeShearVelocityOfFlowVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the shear velocity at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the shear velocity value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLShearVelocityOfFlow::ComputeShearVelocityOfFlowVectorP(), and WindLabAPI::WindLabSimulationData::shearVelocityOfFlow.

◆ ComputeShearVelocityOfFlowVectorT()

bool CRPSWindLabFramework::ComputeShearVelocityOfFlowVectorT	(	const WindLabSimulationData &	Data,
		Base::Vector3d	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the shear velocity at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLShearVelocityOfFlow::ComputeShearVelocityOfFlowVectorT(), and WindLabAPI::WindLabSimulationData::shearVelocityOfFlow.

◆ ComputeSkewnessValue()

bool CRPSWindLabFramework::ComputeSkewnessValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the skewness value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the skewness value will be computed.
dValue	a value to be updated. This is the computed skewness value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLSkewness::ComputeSkewnessValue(), and WindLabAPI::WindLabSimulationData::skewness.

◆ ComputeSkewnessVectorP()

bool CRPSWindLabFramework::ComputeSkewnessVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the skewness values at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the skewness value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLSkewness::ComputeSkewnessVectorP(), and WindLabAPI::WindLabSimulationData::skewness.

◆ ComputeSkewnessVectorT()

bool CRPSWindLabFramework::ComputeSkewnessVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the skewness values at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLSkewness::ComputeSkewnessVectorT(), and WindLabAPI::WindLabSimulationData::skewness.

◆ ComputeStandardDeviationValue()

bool CRPSWindLabFramework::ComputeStandardDeviationValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the standard deviation value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the standard deviation value will be computed.
dValue	a value to be updated. This is the computed standard deviation value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLStandardDeviation::ComputeStandardDeviationValue(), and WindLabAPI::WindLabSimulationData::standardDeviation.

◆ ComputeStandardDeviationVectorP()

bool CRPSWindLabFramework::ComputeStandardDeviationVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the standard deviation values at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the standard deviation value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLStandardDeviation::ComputeStandardDeviationVectorP(), and WindLabAPI::WindLabSimulationData::standardDeviation.

◆ ComputeStandardDeviationVectorT()

bool CRPSWindLabFramework::ComputeStandardDeviationVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the standard deviation values at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLStandardDeviation::ComputeStandardDeviationVectorT(), and WindLabAPI::WindLabSimulationData::standardDeviation.

◆ ComputeTurbulenceIntensityValue()

bool CRPSWindLabFramework::ComputeTurbulenceIntensityValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the turbulence intensity value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the turbulence intensity value will be computed.
dValue	a value to be updated. This is the computed turbulence intensity value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceIntensity::ComputeTurbulenceIntensityValue(), and WindLabAPI::WindLabSimulationData::turbulenceIntensity.

◆ ComputeTurbulenceIntensityVectorP()

bool CRPSWindLabFramework::ComputeTurbulenceIntensityVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the turbulence intensity at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the turbulence intensity value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceIntensity::ComputeTurbulenceIntensityVectorP(), and WindLabAPI::WindLabSimulationData::turbulenceIntensity.

◆ ComputeTurbulenceIntensityVectorT()

bool CRPSWindLabFramework::ComputeTurbulenceIntensityVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the turbulence intensity at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceIntensity::ComputeTurbulenceIntensityVectorT(), and WindLabAPI::WindLabSimulationData::turbulenceIntensity.

◆ ComputeTurbulenceScaleValue()

bool CRPSWindLabFramework::ComputeTurbulenceScaleValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the turbulence scale value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the turbulence scale value will be computed.
dValue	a value to be updated. This is the computed turbulence scale value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceScale::ComputeTurbulenceScaleValue(), and WindLabAPI::WindLabSimulationData::turbulenceScale.

◆ ComputeTurbulenceScaleVectorP()

bool CRPSWindLabFramework::ComputeTurbulenceScaleVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the turbulence scale at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the turbulence scale value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceScale::ComputeTurbulenceScaleVectorP(), and WindLabAPI::WindLabSimulationData::turbulenceScale.

◆ ComputeTurbulenceScaleVectorT()

bool CRPSWindLabFramework::ComputeTurbulenceScaleVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the turbulence scale at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLTurbulenceScale::ComputeTurbulenceScaleVectorT(), and WindLabAPI::WindLabSimulationData::turbulenceScale.

◆ ComputeVarianceValue()

bool CRPSWindLabFramework::ComputeVarianceValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		double &	dValue )

static

Compute the variance value for given time and location.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the variance value will be computed.
dValue	a value to be updated. This is the computed variance value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLVariance::ComputeVarianceValue(), and WindLabAPI::WindLabSimulationData::variance.

◆ ComputeVarianceVectorP()

bool CRPSWindLabFramework::ComputeVarianceVectorP	(	const WindLabSimulationData &	Data,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the variance at a given time instant and for all locations (simulation points).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dTime	the time instant at which the variance value will be computed.
dVarVector	a vector to be updated. It should contains all the location numbers used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each location stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLVariance::ComputeVarianceVectorP(), and WindLabAPI::WindLabSimulationData::variance.

◆ ComputeVarianceVectorT()

bool CRPSWindLabFramework::ComputeVarianceVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the variance at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLVariance::ComputeVarianceVectorT(), and WindLabAPI::WindLabSimulationData::variance.

◆ ComputeWavePassageEffectMatrixPP()

bool CRPSWindLabFramework::ComputeWavePassageEffectMatrixPP	(	const WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	dCoherenceMatrix )

static

Compute the wave passage effect matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the wave passage effect matrix will be computed.
dTime	the time instant at which the wave passage effect matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed wave passage effect matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLWavePassageEffect::ComputeWavePassageEffectMatrixPP(), and WindLabAPI::WindLabSimulationData::wavePassageEffect.

◆ ComputeWavePassageEffectValue()

bool CRPSWindLabFramework::ComputeWavePassageEffectValue	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the wave passage effect value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the wave passage effect value will be computed.
dTime	the time instant at which the wave passage effect value will be computed.
dValue	a value to be updated. This is the computed wave passage effect value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLWavePassageEffect::ComputeWavePassageEffectValue(), and WindLabAPI::WindLabSimulationData::wavePassageEffect.

◆ ComputeWavePassageEffectVectorF()

bool CRPSWindLabFramework::ComputeWavePassageEffectVectorF	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the wave passage effect between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the wave passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLWavePassageEffect::ComputeWavePassageEffectVectorF(), and WindLabAPI::WindLabSimulationData::wavePassageEffect.

◆ ComputeWavePassageEffectVectorT()

bool CRPSWindLabFramework::ComputeWavePassageEffectVectorT	(	const WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the wave passage effect between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the wave passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLWavePassageEffect::ComputeWavePassageEffectVectorT(), and WindLabAPI::WindLabSimulationData::wavePassageEffect.

◆ ComputeXAutoSpectrumValue()

bool CRPSWindLabFramework::ComputeXAutoSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		const double &	dTime,
		double &	dValue )

static

Compute the auto spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXAutoSpectrumValue().

Referenced by ComputeAutoSpectrumValue().

◆ ComputeXAutoSpectrumVectorF()

bool CRPSWindLabFramework::ComputeXAutoSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the auto spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXAutoSpectrumVectorF().

Referenced by ComputeAutoSpectrumVectorF().

◆ ComputeXAutoSpectrumVectorT()

bool CRPSWindLabFramework::ComputeXAutoSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXAutoSpectrumVectorT().

Referenced by ComputeAutoSpectrumVectorT().

◆ ComputeXCrossSpectrumMatrixPP()

bool CRPSWindLabFramework::ComputeXCrossSpectrumMatrixPP	(	const WindLabAPI::WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	psdMatrix )

static

Compute the cross spectrum matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the spectrum matrix will be computed.
dTime	the time instant at which the spectrum matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed spectrum matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXCrossSpectrumMatrixPP().

Referenced by ComputeCrossSpectrumMatrixPP().

◆ ComputeXCrossSpectrumValue()

bool CRPSWindLabFramework::ComputeXCrossSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the cross spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXCrossSpectrumValue().

Referenced by ComputeCrossSpectrumValue().

◆ ComputeXCrossSpectrumVectorF()

bool CRPSWindLabFramework::ComputeXCrossSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXCrossSpectrumVectorF().

Referenced by ComputeCrossSpectrumVectorF().

◆ ComputeXCrossSpectrumVectorT()

bool CRPSWindLabFramework::ComputeXCrossSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::alongWindSpectrumModel, and WindLabAPI::IrpsWLXSpectrum::ComputeXCrossSpectrumVectorT().

Referenced by ComputeCrossSpectrumVectorT().

◆ ComputeYAutoSpectrumValue()

bool CRPSWindLabFramework::ComputeYAutoSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		const double &	dTime,
		double &	dValue )

static

Compute the auto spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYAutoSpectrumValue().

Referenced by ComputeAutoSpectrumValue().

◆ ComputeYAutoSpectrumVectorF()

bool CRPSWindLabFramework::ComputeYAutoSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the auto spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYAutoSpectrumVectorF().

Referenced by ComputeAutoSpectrumVectorF().

◆ ComputeYAutoSpectrumVectorT()

bool CRPSWindLabFramework::ComputeYAutoSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYAutoSpectrumVectorT().

Referenced by ComputeAutoSpectrumVectorT().

◆ ComputeYCrossSpectrumMatrixPP()

bool CRPSWindLabFramework::ComputeYCrossSpectrumMatrixPP	(	const WindLabAPI::WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	psdMatrix )

static

Compute the cross spectrum matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the spectrum matrix will be computed.
dTime	the time instant at which the spectrum matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed spectrum matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYCrossSpectrumMatrixPP().

Referenced by ComputeCrossSpectrumMatrixPP().

◆ ComputeYCrossSpectrumValue()

bool CRPSWindLabFramework::ComputeYCrossSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the cross spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYCrossSpectrumValue().

Referenced by ComputeCrossSpectrumValue().

◆ ComputeYCrossSpectrumVectorF()

bool CRPSWindLabFramework::ComputeYCrossSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYCrossSpectrumVectorF().

Referenced by ComputeCrossSpectrumVectorF().

◆ ComputeYCrossSpectrumVectorT()

bool CRPSWindLabFramework::ComputeYCrossSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::acrossWindSpectrumModel, and WindLabAPI::IrpsWLYSpectrum::ComputeYCrossSpectrumVectorT().

Referenced by ComputeCrossSpectrumVectorT().

◆ ComputeZAutoSpectrumValue()

bool CRPSWindLabFramework::ComputeZAutoSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		const double &	dTime,
		double &	dValue )

static

Compute the auto spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZAutoSpectrumValue(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeAutoSpectrumValue().

◆ ComputeZAutoSpectrumVectorF()

bool CRPSWindLabFramework::ComputeZAutoSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dTime,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the auto spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZAutoSpectrumVectorF(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeAutoSpectrumVectorF().

◆ ComputeZAutoSpectrumVectorT()

bool CRPSWindLabFramework::ComputeZAutoSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	location,
		const double &	dFrequency,
		vec &	dVarVector,
		vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
location	a location (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZAutoSpectrumVectorT(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeAutoSpectrumVectorT().

◆ ComputeZCrossSpectrumMatrixPP()

bool CRPSWindLabFramework::ComputeZCrossSpectrumMatrixPP	(	const WindLabAPI::WindLabSimulationData &	Data,
		const double &	dFrequency,
		const double &	dTime,
		cx_mat &	psdMatrix )

static

Compute the cross spectrum matrix for given time and frequency.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dFrequency	the frequency value for which the spectrum matrix will be computed.
dTime	the time instant at which the spectrum matrix will be computed.
dCoherenceMatrix	a matrix to be updated. It should contain the computed spectrum matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZCrossSpectrumMatrixPP(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeCrossSpectrumMatrixPP().

◆ ComputeZCrossSpectrumValue()

bool CRPSWindLabFramework::ComputeZCrossSpectrumValue	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		const double &	dTime,
		std::complex< double > &	dValue )

static

Compute the cross spectrum value for given time, frequency and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum value will be computed.
dTime	the time instant at which the spectrum value will be computed.
dValue	a value to be updated. This is the computed spectrum value.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZCrossSpectrumValue(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeCrossSpectrumValue().

◆ ComputeZCrossSpectrumVectorF()

bool CRPSWindLabFramework::ComputeZCrossSpectrumVectorF	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dTime,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all frequency increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dTime	the time instant at which the spectrum passage effect vector will be computed.
dVarVector	a vector to be updated. It should contains all the frequency increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each frequency increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZCrossSpectrumVectorF(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeCrossSpectrumVectorF().

◆ ComputeZCrossSpectrumVectorT()

bool CRPSWindLabFramework::ComputeZCrossSpectrumVectorT	(	const WindLabAPI::WindLabSimulationData &	Data,
		const Base::Vector3d &	locationJ,
		const Base::Vector3d &	locationK,
		const double &	dFrequency,
		vec &	dVarVector,
		cx_vec &	dValVector )

static

Compute the cross spectrum between two simulation points for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationJ	a location J (simulation point represented by 3D position vector) where wind velocity time series is desired.
locationK	a location K (simulation point represented by 3D position vector) where wind velocity time series is desired.
dFrequency	the frequency value for which the spectrum vector will be computed.
dVarVector	a vector to be updated. It should contains all the time increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each time increment stored in dVarVector.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLZSpectrum::ComputeZCrossSpectrumVectorT(), and WindLabAPI::WindLabSimulationData::verticalWindSpectrumModel.

Referenced by ComputeCrossSpectrumVectorT().

◆ GenerateRandomMatrixFP()

bool CRPSWindLabFramework::GenerateRandomMatrixFP	(	const WindLabSimulationData &	Data,
		mat &	dRandomValueArray )

static

Generate the random value matrix for all frequency increments and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user..
dMatrix	a matrix to be updated. It should contain the generated random values matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::IrpsWLRandomness::GenerateRandomMatrixFP(), and WindLabAPI::WindLabSimulationData::randomnessProvider.

◆ getLocationIndex()

int CRPSWindLabFramework::getLocationIndex	(	const WindLabAPI::WindLabSimulationData &	Data,
		Base::Vector3d	locationTobeFound )

static

Given a location coordinates, this function identify the index (numbering) of the location (simulation point) among all the simulation points (locations).

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
locationTobeFound	a location (simulation point represented by 3D position vector) whose index is needed.

Returns: return the successfuly found index. In case of failure, it returns negative integer.

References ComputeLocationCoordinateMatrixP3(), and WindLabAPI::WindLabSimulationData::numberOfSpatialPosition.

◆ getWindLabFeatureDescription()

WindLabAPI::WindLabFeatureDescription * CRPSWindLabFramework::getWindLabFeatureDescription ( const std::string & name )

static

Get the description of a feature by its name.

Parameters

name	the feature's name.

Returns: return the feature description.

◆ MatrixToolCompute()

bool CRPSWindLabFramework::MatrixToolCompute	(	const WindLabSimulationData &	Data,
		const mat &	inputMatrix,
		mat &	outputMatrix )

static

Compute the kurtosis at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
inputMatrix	a matrix to be updated. This the matrix to be manipulated, analyzed and processed.
outputMatrix	a matrix to be updated. This is the result matrix.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::matrixTool, and WindLabAPI::IrpsWLMatrixTool::MatrixToolCompute().

◆ Simulate()

static bool WindLabAPI::CRPSWindLabFramework::Simulate	(	const WindLabSimulationData &	Data,
		mat &	dVelocityArray )

static

Generate random wind velocity.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dVelocityArray	a matrix to be updated. This is generated random wind velocity matrix. Its first column contains the time increments.

Returns: return true if the computation is successful and false in case of failure.

◆ SimulateInLargeScaleMode()

static bool WindLabAPI::CRPSWindLabFramework::SimulateInLargeScaleMode	(	const WindLabSimulationData &	Data,
		QString &	strFileName )

static

Generate random wind velocity in large scale simulation mode.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
strFileName	In large scale mode, the generated wind velocity is not save in memory. It should be written to computer disc to avoid memory usage overflow. This is the name of the file in which the generated wind speed values will be written. You can get the working directory that from the simulation Data in order to create the full path of the file.

Returns: return true if the computation is successful and false in case of failure.

◆ TableToolCompute()

bool CRPSWindLabFramework::TableToolCompute	(	const WindLabSimulationData &	Data,
		const mat &	inputTable,
		mat &	outputTable )

static

Compute the kurtosis at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
inputMatrix	a matrix to be updated. This the table to be manipulated, analyzed and processed.
outputMatrix	a matrix to be updated. This is the result table.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::tableTool, and WindLabAPI::IrpsWLTableTool::TableToolCompute().

◆ UserDefinedRPSObjectCompute()

bool CRPSWindLabFramework::UserDefinedRPSObjectCompute	(	const WindLabSimulationData &	Data,
		mat &	dresult )

static

Run the user defined computation tool.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dresult	a matrix to be updated. This is the computation result.

Returns: return true if the computation is successful and false in case of failure.

References WindLabAPI::WindLabSimulationData::userDefinedRPSObject, and WindLabAPI::IrpsWLUserDefinedRPSObject::UserDefinedRPSObjectCompute().

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

RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/RPSWindLabFramework.h
RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/RPSWindLabFramework.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CRPSWindLabFramework()

◆ ~CRPSWindLabFramework()

Member Function Documentation

◆ ComputeAutoSpectrumValue()

◆ ComputeAutoSpectrumVectorF()

◆ ComputeAutoSpectrumVectorT()

◆ ComputeCPDValue()

◆ ComputeCPDVectorX()

◆ ComputeCrossCoherenceMatrixPP()

◆ ComputeCrossCoherenceValue()

◆ ComputeCrossCoherenceVectorF()

◆ ComputeCrossCoherenceVectorT()

◆ ComputeCrossCorrelationMatrixPP()

◆ ComputeCrossCorrelationValue()

◆ ComputeCrossCorrelationVectorT()

◆ ComputeCrossSpectrumMatrixPP()

◆ ComputeCrossSpectrumValue()

◆ ComputeCrossSpectrumVectorF()

◆ ComputeCrossSpectrumVectorT()

◆ ComputeDecomposedCrossSpectrumMatrixPP()

◆ ComputeDecomposedCrossSpectrumVectorF()

◆ ComputeDecomposedCrossSpectrumVectorT()

◆ ComputeFrequenciesMatrixFP()

◆ ComputeFrequenciesVectorF()

◆ ComputeFrequencyValue()

◆ ComputeGustFactorValue()

◆ ComputeGustFactorVectorP()

◆ ComputeGustFactorVectorT()

◆ ComputeKurtosisValue()

◆ ComputeKurtosisVectorP()

◆ ComputeKurtosisVectorT()

◆ ComputeLocationCoordinateMatrixP3()

◆ ComputeMeanWindSpeedValue()

◆ ComputeMeanWindSpeedVectorP()

◆ ComputeMeanWindSpeedVectorT()

◆ ComputeModulationValue()

◆ ComputeModulationVectorP()

◆ ComputeModulationVectorT()

◆ ComputePDFValue()

◆ ComputePDFVectorX()

◆ ComputePeakFactorValue()

◆ ComputePeakFactorVectorP()

◆ ComputePeakFactorVectorT()

◆ ComputeRandomValue()

◆ ComputeRoughnessValue()

◆ ComputeRoughnessVectorP()

◆ ComputeRoughnessVectorT()

◆ ComputeShearVelocityOfFlowValue()

◆ ComputeShearVelocityOfFlowVectorP()

◆ ComputeShearVelocityOfFlowVectorT()

◆ ComputeSkewnessValue()

◆ ComputeSkewnessVectorP()

◆ ComputeSkewnessVectorT()

◆ ComputeStandardDeviationValue()

◆ ComputeStandardDeviationVectorP()

◆ ComputeStandardDeviationVectorT()

◆ ComputeTurbulenceIntensityValue()

◆ ComputeTurbulenceIntensityVectorP()

◆ ComputeTurbulenceIntensityVectorT()

◆ ComputeTurbulenceScaleValue()

◆ ComputeTurbulenceScaleVectorP()

◆ ComputeTurbulenceScaleVectorT()

◆ ComputeVarianceValue()

◆ ComputeVarianceVectorP()

◆ ComputeVarianceVectorT()

◆ ComputeWavePassageEffectMatrixPP()

◆ ComputeWavePassageEffectValue()

◆ ComputeWavePassageEffectVectorF()

◆ ComputeWavePassageEffectVectorT()

◆ ComputeXAutoSpectrumValue()

◆ ComputeXAutoSpectrumVectorF()

◆ ComputeXAutoSpectrumVectorT()

◆ ComputeXCrossSpectrumMatrixPP()

◆ ComputeXCrossSpectrumValue()

◆ ComputeXCrossSpectrumVectorF()

◆ ComputeXCrossSpectrumVectorT()