Loading...
Searching...
No Matches
WindLabAPI::IrpsWLShearVelocityOfFlow Class Referenceabstract
An abstract class representing the shear velocity of a flow. More...
#include <IrpsWLShearVelocityOfFlow.h>
Public Member Functions | |
| virtual bool | ComputeShearVelocityOfFlowValue (const WindLabSimulationData &Data, Base::Vector3d location, const double &dTime, double &dValue)=0 |
| Compute the shear velocity value for given time and location. | |
| virtual bool | ComputeShearVelocityOfFlowVectorP (const WindLabSimulationData &Data, const double &dTime, vec &dVarVector, vec &dValVector)=0 |
| Compute the shear velocity at a given time instant and for all locations (simulation points). | |
| virtual bool | ComputeShearVelocityOfFlowVectorT (const WindLabSimulationData &Data, Base::Vector3d location, vec &dVarVector, vec &dValVector)=0 |
| Compute the shear velocity 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 | ~IrpsWLShearVelocityOfFlow () |
| Virtual destructor for IrpsWLShearVelocityOfFlow class. | |
 Public Member Functions inherited from WindLabAPI::WindLabFeatureShearVelocityOfFlow | |
| virtual const char * | getViewProviderName () const |
| WindLabFeatureShearVelocityOfFlow (void) | |
| Constructor. | |
| virtual | ~WindLabFeatureShearVelocityOfFlow () |
| 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::WindLabFeatureShearVelocityOfFlow | |
| 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 the shear velocity of a flow.
This is a pure virtual class (interface) that defines the interface for all shear velocity of flows. The shear velocity, which is a measure of the frictional force exerted by the surface on the wind flow, is critical for modeling the turbulent characteristics of the wind, especially in regions close to the ground where the wind speed is heavily influenced by surface roughness. Accurate simulation of random wind velocity, which is essential in applications such as wind energy forecasting, structural engineering, and environmental studies, requires an understanding of the shear velocity and its influence on turbulence, wind profiles, and variability. Derived classes must implement all its methods.
Constructor & Destructor Documentation
◆ ~IrpsWLShearVelocityOfFlow()
|
virtual |
Virtual destructor for IrpsWLShearVelocityOfFlow class.
Provides proper cleanup in case a derived class object is destroyed.
Member Function Documentation
◆ ComputeShearVelocityOfFlowValue()
|
pure virtual |
Compute the shear velocity 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 shear velocity value will be computed. dValue a value to be updated. This is the computed shear velocity value.
- Returns
- return true if the computation is successful and false in case of failure.
Referenced by WindLabAPI::CRPSWindLabFramework::ComputeShearVelocityOfFlowValue().
◆ ComputeShearVelocityOfFlowVectorP()
|
pure virtual |
Compute the shear velocity 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 shear velocity 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::ComputeShearVelocityOfFlowVectorP().
◆ ComputeShearVelocityOfFlowVectorT()
|
pure virtual |
Compute the shear velocity 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::ComputeShearVelocityOfFlowVectorT().
◆ 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/IrpsWLShearVelocityOfFlow.h
Generated by
1.12.0