WindLabAPI::IrpsWLGustFactor Class Reference

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

#include <IrpsWLGustFactor.h>

Public Member Functions
virtual bool	ComputeGustFactorValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)=0
	Compute the gust factor value for given time and location.
virtual bool	ComputeGustFactorVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0
	Compute the gust factors at a given time and for all locations (simulation points).
virtual bool	ComputeGustFactorVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)=0
	Compute the gust factors 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	~IrpsWLGustFactor ()
	Virtual destructor for IrpsWLGustFactor class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureGustFactor
virtual const char *	getViewProviderName () const
	WindLabFeatureGustFactor (void)
	Constructor.
virtual	~WindLabFeatureGustFactor ()
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::WindLabFeatureGustFactor
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 gust factor.

This is a pure virtual class (interface) that defines the interface for all gust factors. The gust factor quantifies the ratio of the peak wind speed (or maximum instantaneous wind velocity) to the mean wind speed over a specified time period. It is particularly important for applications where short-term wind extremes need to be modeled, such as in the design of wind-sensitive structures (e.g., buildings, bridges, wind turbines) and in the wind energy industry, where understanding peak gusts is crucial for turbine load analysis and fatigue modeling.
Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLGustFactor()

virtual WindLabAPI::IrpsWLGustFactor::~IrpsWLGustFactor ( )

virtual

Virtual destructor for IrpsWLGustFactor class.

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

Member Function Documentation

ComputeGustFactorValue()

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

pure virtual

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.

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

ComputeGustFactorVectorP()

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

pure virtual

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.

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

ComputeGustFactorVectorT()

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

pure virtual

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.

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

OnInitialSetting()

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