Loading...
Searching...
No Matches
WindLabAPI::IrpsWLMean Class Referenceabstract
An abstract class representing a mean wind profile. More...
#include <IrpsWLMean.h>
Public Member Functions | |
| virtual bool | ComputeMeanWindSpeedValue (const WindLabSimulationData &Data, Base::Vector3d location, const double &dTime, double &dValue)=0 |
| Compute the mean wind speed value for given time and location. | |
| virtual bool | ComputeMeanWindSpeedVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0 |
| Compute the mean wind speed at a given time instant and for all locations (simulation points). | |
| virtual bool | ComputeMeanWindSpeedVectorT (const WindLabSimulationData &Data, Base::Vector3d location, vec &dVarVector, vec &dValVector)=0 |
| Compute the mean wind speed 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 | ~IrpsWLMean () |
| Virtual destructor for IrpsWLMean class. | |
 Public Member Functions inherited from WindLabAPI::WindLabFeatureMeanWind | |
| virtual const char * | getViewProviderName () const |
| WindLabFeatureMeanWind (void) | |
| Constructor. | |
| virtual | ~WindLabFeatureMeanWind () |
| 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::WindLabFeatureMeanWind | |
| 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 mean wind profile.
This is a pure virtual class (interface) that defines the interface for all mean wind profiles. The mean wind profile represents the average wind speed at various heights above the Earth's surface and is essential for understanding the larger-scale dynamics of wind in the atmospheric boundary layer.
Derived classes must implement all its methods. During the implementation of this interface you have to consider stationarity depending on how your feature varies in time to capture these three situation that may come from the user's inputs (requirements):
1-The user is willing to simulate stationary wind velocity. f = f(w)
2-The user is willing to simulate non-stationary wind velocity and has also created a modulation function in the simulation. f = f(w,t) = G(w) * M(t)
3-The user is willing to simulate non-stationary wind velocity without creating any modulation function in the simulation. f = f(w,t)
Constructor & Destructor Documentation
◆ ~IrpsWLMean()
|
virtual |
Virtual destructor for IrpsWLMean class.
Provides proper cleanup in case a derived class object is destroyed.
Member Function Documentation
◆ ComputeMeanWindSpeedValue()
|
pure virtual |
Compute the mean wind speed 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 mean wind speed value will be computed. dValue a value to be updated. This is the computed mean wind speed value.
- Returns
- return true if the computation is successful and false in case of failure.
Referenced by WindLabAPI::CRPSWindLabFramework::ComputeMeanWindSpeedValue().
◆ ComputeMeanWindSpeedVectorP()
|
pure virtual |
Compute the mean wind speed 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 mean wind speed 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::ComputeMeanWindSpeedVectorP().
◆ ComputeMeanWindSpeedVectorT()
|
pure virtual |
Compute the mean wind speed 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::ComputeMeanWindSpeedVectorT().
◆ 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/IrpsWLMean.h
Generated by
1.12.0