Loading...
Searching...
No Matches
WindLabAPI::IrpsWLRoughness Class Referenceabstract
An abstract class representing a terrain rounghness. More...
#include <IrpsWLRoughness.h>
Public Member Functions | |
| virtual bool | ComputeRoughnessValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const double &dTime, double &dValue)=0 |
| Compute the roughness value for given time and location. | |
| virtual bool | ComputeRoughnessVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0 |
| Compute the roughness values at a given time instant and for all locations (simulation points). | |
| virtual bool | ComputeRoughnessVectorT (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dVarVector, vec &dValVector)=0 |
| Compute the roughness value 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 | ~IrpsWLRoughness () |
| Virtual destructor for IrpsWLRoughness class. | |
 Public Member Functions inherited from WindLabAPI::WindLabFeatureRoughness | |
| virtual const char * | getViewProviderName () const |
| WindLabFeatureRoughness (void) | |
| Constructor. | |
| virtual | ~WindLabFeatureRoughness () |
| 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::WindLabFeatureRoughness | |
| 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 terrain rounghness.
This is a pure virtual class (interface) that defines the interface for all terrain roughnesses. Terrain roughness influences wind velocity by altering wind speed, direction, and turbulence as it interacts with obstacles such as buildings, vegetation, hills, and other surface features. Understanding and incorporating the effects of terrain roughness in wind velocity simulations is crucial for ensuring realistic and reliable results in these applications. Terrain roughness is a measure of the heterogeneity of the Earth's surface that disrupts the smooth flow of wind. Rougher terrain typically includes obstacles such as forests, mountains, urban areas, or rugged landscapes, which cause more significant turbulence and frictional forces on the wind. Derived classes must implement all its methods.
Constructor & Destructor Documentation
◆ ~IrpsWLRoughness()
|
virtual |
Virtual destructor for IrpsWLRoughness class.
Provides proper cleanup in case a derived class object is destroyed.
Member Function Documentation
◆ ComputeRoughnessValue()
|
pure virtual |
Compute the roughness 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 roughness value will be computed. dValue a value to be updated. This is the computed roughness value.
- Returns
- return true if the computation is successful and false in case of failure.
Referenced by WindLabAPI::CRPSWindLabFramework::ComputeRoughnessValue().
◆ ComputeRoughnessVectorP()
|
pure virtual |
Compute the roughness 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 roughness 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::ComputeRoughnessVectorP().
◆ ComputeRoughnessVectorT()
|
pure virtual |
Compute the roughness value 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::ComputeRoughnessVectorT().
◆ 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/IrpsWLRoughness.h
Generated by
1.12.0