Loading...
Searching...
No Matches
WindLabAPI::IrpsWLStandardDeviation Class Referenceabstract
An abstract class representing a standard deviation. More...
#include <IrpsWLStandardDeviation.h>
Public Member Functions | |
| virtual bool | ComputeStandardDeviationValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)=0 |
| Compute the standard deviation value for given time and location. | |
| virtual bool | ComputeStandardDeviationVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0 |
| Compute the standard deviation values at a given time instant and for all locations (simulation points). | |
| virtual bool | ComputeStandardDeviationVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)=0 |
| Compute the standard deviation values 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 | ~IrpsWLStandardDeviation () |
| Virtual destructor for IrpsWLStandardDeviation class. | |
 Public Member Functions inherited from WindLabAPI::WindLabFeatureStandardDeviation | |
| virtual const char * | getViewProviderName () const |
| WindLabFeatureStandardDeviation (void) | |
| Constructor. | |
| virtual | ~WindLabFeatureStandardDeviation () |
| 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::WindLabFeatureStandardDeviation | |
| 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 standard deviation.
This is a pure virtual class (interface) that defines the interface for standard deviations. In the context of random phenomenon simulation, standard deviation is a statistical measure that quantifies the amount of variation or spread in a set of random values. It is an important concept because it provides insight into how much individual values of a random variable deviate from the mean (or expected value) of the distribution. Derived classes must implement all its methods.
Constructor & Destructor Documentation
◆ ~IrpsWLStandardDeviation()
|
virtual |
Virtual destructor for IrpsWLStandardDeviation class.
Provides proper cleanup in case a derived class object is destroyed.
Member Function Documentation
◆ ComputeStandardDeviationValue()
|
pure virtual |
Compute the standard deviation 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 standard deviation value will be computed. dValue a value to be updated. This is the computed standard deviation value.
- Returns
- return true if the computation is successful and false in case of failure.
Referenced by WindLabAPI::CRPSWindLabFramework::ComputeStandardDeviationValue().
◆ ComputeStandardDeviationVectorP()
|
pure virtual |
Compute the standard deviation values 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 standard deviation 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::ComputeStandardDeviationVectorP().
◆ ComputeStandardDeviationVectorT()
|
pure virtual |
Compute the standard deviation values 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::ComputeStandardDeviationVectorT().
◆ OnInitialSetting()
|
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/IrpsWLStandardDeviation.h
Generated by
1.12.0