WindLabAPI::IrpsWLCorrelation Class Reference

An abstract class representing a correlation function. More...

#include <IrpsWLCorrelation.h>

Public Member Functions
virtual bool	ComputeCrossCorrelationMatrixPP (const WindLabSimulationData &Data, const double &dTime, mat &dCorrelationMatrix)=0
	Compute the cross correlation matrix for given time and frequency.
virtual bool	ComputeCrossCorrelationValue (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, const double &dTime, double &dValue)=0
	Compute the cross correlation value for given time and locations.
virtual bool	ComputeCrossCorrelationVectorT (const WindLabSimulationData &Data, const Base::Vector3d &locationJ, const Base::Vector3d &locationK, vec &dVarVector, vec &dValVector)=0
	Compute the cross correlation between two simulation points for all time increments.
virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.
virtual	~IrpsWLCorrelation ()
	Virtual destructor for IrpsWLCorrelation class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureCorrelation
virtual const char *	getViewProviderName () const
	WindLabFeatureCorrelation (void)
	Constructor.
virtual	~WindLabFeatureCorrelation ()
virtual short	mustExecute () const override
Public Member Functions inherited from WindLabAPI::WindLabFeature
	WindLabFeature (void)
	Constructor.
virtual	~WindLabFeature ()
	destructor

Additional Inherited Members
Protected Member Functions inherited from WindLabAPI::WindLabFeatureCorrelation
virtual App::DocumentObjectExecReturn *	recompute () override
	recompute only this object
virtual App::DocumentObjectExecReturn *	execute () override
	recalculate the feature
virtual void	onChanged (const App::Property *prop) override
Protected Member Functions inherited from WindLabAPI::WindLabFeature
virtual PyObject *	getPyObject () override
Protected Attributes inherited from WindLabAPI::WindLabFeature
Py::SmartPtr	PythonObject

Detailed Description

An abstract class representing a correlation function.

This is a pure virtual class (interface) that defines the interface for all correlation functions. A correlation function is a fundamental tool in the simulation of random phenomenon, playing a key role in modeling the statistical dependencies between fluctuations at different points in space and time. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLCorrelation()

virtual WindLabAPI::IrpsWLCorrelation::~IrpsWLCorrelation ( )

virtual

Virtual destructor for IrpsWLCorrelation class.

Provides proper cleanup in case a derived class object is destroyed.

Member Function Documentation

ComputeCrossCorrelationMatrixPP()

virtual bool WindLabAPI::IrpsWLCorrelation::ComputeCrossCorrelationMatrixPP ( const WindLabSimulationData & Data, const double & dTime, mat & dCorrelationMatrix )

pure virtual

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.

Referenced by WindLabAPI::CRPSWindLabFramework::ComputeCrossCorrelationMatrixPP().

ComputeCrossCorrelationValue()

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

pure virtual

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.

Referenced by WindLabAPI::CRPSWindLabFramework::ComputeCrossCorrelationValue().

ComputeCrossCorrelationVectorT()

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

pure virtual

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.

Referenced by WindLabAPI::CRPSWindLabFramework::ComputeCrossCorrelationVectorT().

OnInitialSetting()

virtual bool WindLabAPI::IrpsWLCorrelation::OnInitialSetting ( const WindLabSimulationData & Data )

pure virtual

Allows to do any initial taks before any of the other methods is called.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.

Returns

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

---

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

• RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/IrpsWLCorrelation.h