WindLabAPI::IrpsWLProbabilityDensityFunction Class Reference

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

#include <IrpsWLProbabilityDensityFunction.h>

Public Member Functions
virtual bool ComputePDFValue (const WindLabSimulationData &Data, const double &x, double &dValue)=0
	Compute the probability dendity value for x.
virtual bool ComputePDFVectorX (const WindLabSimulationData &Data, vec &dVarVector, vec &dValVector)=0
	Compute the probability dendity for all increments of variable x.
virtual bool OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.
virtual ~IrpsWLProbabilityDensityFunction ()
	Virtual destructor for IrpsWLProbabilityDensityFunction class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureProbabilityDensityFunction
virtual const char * getViewProviderName () const
WindLabFeatureProbabilityDensityFunction (void)
	Constructor.
virtual ~WindLabFeatureProbabilityDensityFunction ()
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::WindLabFeatureProbabilityDensityFunction
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 probability dendity function. The PDF is central to modeling the inherent randomness of the phenomenon, ensuring that simulations reflect both the expected and extreme behaviors of the phenomenon. A Probability Density Function describes the likelihood of a random variable (in this case, wind velocity) assuming a particular value within a given range. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLProbabilityDensityFunction()

virtual WindLabAPI::IrpsWLProbabilityDensityFunction::~IrpsWLProbabilityDensityFunction ( )

virtual

Virtual destructor for IrpsWLProbabilityDensityFunction class.

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

Member Function Documentation

ComputePDFValue()

virtual bool WindLabAPI::IrpsWLProbabilityDensityFunction::ComputePDFValue ( const WindLabSimulationData & Data, const double & x, double & dValue )

pure virtual

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.

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

ComputePDFVectorX()

virtual bool WindLabAPI::IrpsWLProbabilityDensityFunction::ComputePDFVectorX ( const WindLabSimulationData & Data, vec & dVarVector, vec & dValVector )

pure virtual

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.

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

OnInitialSetting()

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