WindLabAPI::IrpsWLFrequencyDistribution Class Reference

An abstract class representing a frequency distribution. More...

#include <IrpsWLFrequencyDistribution.h>

Public Member Functions
virtual bool	ComputeFrequenciesMatrixFP (const WindLabSimulationData &Data, mat &dMatrix)=0
	Compute the frequency matrix for all frequency indexes and locations.
virtual bool	ComputeFrequenciesVectorF (const WindLabSimulationData &Data, const Base::Vector3d &location, vec &dValVector)=0
	Compute the frequency increments for all frequency indexes.
virtual bool	ComputeFrequencyValue (const WindLabSimulationData &Data, const Base::Vector3d &location, const int &frequencyIndex, double &dValue)=0
	Compute the frequency increment value by frequency index for given location (simulation point).
virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.
virtual	~IrpsWLFrequencyDistribution ()
	Virtual destructor for IrpsWLFrequencyDistribution class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureFrequencyDistribution
virtual const char *	getViewProviderName () const
	WindLabFeatureFrequencyDistribution (void)
	Constructor.
virtual	~WindLabFeatureFrequencyDistribution ()
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::WindLabFeatureFrequencyDistribution
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 frequency distribution.

This is a pure virtual class (interface) that defines the interface for all correlation functions. A frequency discretization involves breaking down the continuous frequency domain, into discrete frequency bins. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLFrequencyDistribution()

virtual WindLabAPI::IrpsWLFrequencyDistribution::~IrpsWLFrequencyDistribution ( )

virtual

Virtual destructor for IrpsWLFrequencyDistribution class.

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

Member Function Documentation

ComputeFrequenciesMatrixFP()

virtual bool WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequenciesMatrixFP ( const WindLabSimulationData & Data, mat & dMatrix )

pure virtual

Compute the frequency matrix for all frequency indexes and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user..
dMatrix	a matrix to be updated. It should contain the computed frequency matrix.

Returns

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

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

ComputeFrequenciesVectorF()

virtual bool WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequenciesVectorF ( const WindLabSimulationData & Data, const Base::Vector3d & location, vec & dValVector )

pure virtual

Compute the frequency increments for all frequency indexes.

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.
dValVector	a vector to be updated. It should contain all the values computed for each frequency index.

Returns

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

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

ComputeFrequencyValue()

virtual bool WindLabAPI::IrpsWLFrequencyDistribution::ComputeFrequencyValue ( const WindLabSimulationData & Data, const Base::Vector3d & location, const int & frequencyIndex, double & dValue )

pure virtual

Compute the frequency increment value by frequency index for given location (simulation point).

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.
frequencyIndex	an integer representing the frequency index where the value will be computed.
dValue	a value to be updated. This is the computed frequency value.

Returns

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

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

OnInitialSetting()

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