WindLabAPI::IrpsWLModulation Class Reference

An abstract class representing a modulation function. More...

#include <IrpsWLModulation.h>

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

This is a pure virtual class (interface) that defines the interface for all modulation function. Unlike stationary processes, where statistical properties (such as mean and variance) remain constant over time, non-stationary random phenomenon varies in its statistical behavior. A modulation function is a mathematical tool or algorithm used to adjust the statistical properties of a random process in a time-dependent manner. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLModulation()

virtual WindLabAPI::IrpsWLModulation::~IrpsWLModulation ( )

virtual

Virtual destructor for IrpsWLModulation class.

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

Member Function Documentation

ComputeModulationValue()

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

pure virtual

Compute the modulation 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 modulation value will be computed.
dValue	a value to be updated. This is the computed modulation value.

Returns

return true if the computation is successful and false in case of failure.

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

ComputeModulationVectorP()

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

pure virtual

Compute the modulation 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 modulation 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::ComputeModulationVectorP().

ComputeModulationVectorT()

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

pure virtual

Compute the modulation 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::ComputeModulationVectorT().

OnInitialSetting()

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