WindLabAPI::IrpsWLVariance Class Reference

An abstract class representing a variance. More...

#include <IrpsWLVariance.h>

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

This is a pure virtual class (interface) that defines the interface for all variances. variance is a statistical measure that quantifies the degree of variability or spread in the wind speed over time or space. Specifically, variance measures how much the wind velocity deviates from its mean (average) value.
Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLVariance()

virtual WindLabAPI::IrpsWLVariance::~IrpsWLVariance ( )

virtual

Virtual destructor for IrpsWLVariance class.

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

Member Function Documentation

ComputeVarianceValue()

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

pure virtual

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.

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

ComputeVarianceVectorP()

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

pure virtual

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.

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

ComputeVarianceVectorT()

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

pure virtual

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.

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

OnInitialSetting()

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