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

#include <IrpsWLLocationDistribution.h>

Public Member Functions
virtual bool	ComputeLocationCoordinateMatrixP3 (const WindLabSimulationData &Data, mat &dLocCoord)=0
	Compute the location coordinates according to their distribution in space.

virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.

virtual	~IrpsWLLocationDistribution ()
	Virtual destructor for IrpsWLLocationDistribution class.

Public Member Functions inherited from WindLabAPI::WindLabFeatureLocationDistribution
virtual const char *	getViewProviderName () const

	WindLabFeatureLocationDistribution (void)
	Constructor.

virtual	~WindLabFeatureLocationDistribution ()

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::WindLabFeatureLocationDistribution
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 location distribution.

This is a pure virtual class (interface) that defines the interface for all location distributions. Wind velocity is sampled at multiple points in space to generate a spatial wind field that reflects both the horizontal variability (such as wind direction changes over a region) and the vertical profile (wind speed changes with height). The spatial distribution of simulation points is typically achieved by discretizing the terrain into a grid or set of measurement locations, ensuring that spatial correlation between nearby points is accounted for.
Derived classes must implement all its methods.

Constructor & Destructor Documentation

◆ ~IrpsWLLocationDistribution()

virtual WindLabAPI::IrpsWLLocationDistribution::~IrpsWLLocationDistribution ( )

virtual

Virtual destructor for IrpsWLLocationDistribution class.

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

Member Function Documentation

◆ ComputeLocationCoordinateMatrixP3()

virtual bool WindLabAPI::IrpsWLLocationDistribution::ComputeLocationCoordinateMatrixP3	(	const WindLabSimulationData &	Data,
		mat &	dLocCoord )

pure virtual

Compute the location coordinates according to their distribution in space.

Parameters

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

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

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

◆ OnInitialSetting()

virtual bool WindLabAPI::IrpsWLLocationDistribution::OnInitialSetting ( const WindLabSimulationData & Data )

pure virtual

Allows to do any initial taks before any of the other methods is called.