WindLabAPI::IrpsWLPeakFactor Class Reference

An abstract class representing a peak factor. More...

#include <IrpsWLPeakFactor.h>

Public Member Functions
virtual bool	ComputePeakFactorValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)=0
	Compute the peak factor value for given time and location.
virtual bool	ComputePeakFactorVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0
	Compute the peak factor at a given time instant and for all locations (simulation points).
virtual bool	ComputePeakFactorVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)=0
	Compute the peak factor at a given location (simulation point) and 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	~IrpsWLPeakFactor ()
	Virtual destructor for IrpsWLPeakFactor class.
Public Member Functions inherited from WindLabAPI::WindLabFeaturePeakFactor
virtual const char *	getViewProviderName () const
	WindLabFeaturePeakFactor (void)
	Constructor.
virtual	~WindLabFeaturePeakFactor ()
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::WindLabFeaturePeakFactor
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 peak factor.

This is a pure virtual class (interface) that defines the interface for peak factors. The peak factor is defined as the ratio of the maximum wind velocity (or gust) observed over a specific time interval to the root mean square (RMS) value, or sometimes the mean value, of the wind speed over the same period. It provides a measure of how much more intense the peaks in the wind velocity are compared to the typical values. In other words, it quantifies the “spikiness” or extremity of wind gusts in relation to the background wind speed. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLPeakFactor()

virtual WindLabAPI::IrpsWLPeakFactor::~IrpsWLPeakFactor ( )

virtual

Virtual destructor for IrpsWLPeakFactor class.

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

Member Function Documentation

ComputePeakFactorValue()

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

pure virtual

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.

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

ComputePeakFactorVectorP()

virtual bool WindLabAPI::IrpsWLPeakFactor::ComputePeakFactorVectorP ( const WindLabSimulationData & Data, const double & dTime, vec & dVarVector, vec & dValVector )

pure virtual

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.

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

ComputePeakFactorVectorT()

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

pure virtual

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.

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

OnInitialSetting()

virtual bool WindLabAPI::IrpsWLPeakFactor::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/IrpsWLPeakFactor.h