Loading...
Searching...
No Matches
WindLabAPI::WindLabSimulationData Class Reference

The WindLab simulation data for random wind velocity. More...

#include <WindLabSimulationData.h>

Public Member Functions

 WindLabSimulationData ()
 Construction.
 
 ~WindLabSimulationData ()
 Destruction.
 
- Public Member Functions inherited from WindLabAPI::WindLabFeature
 WindLabFeature (void)
 Constructor.
 
virtual ~WindLabFeature ()
 destructor
 

Public Attributes

Properties
App::PropertyInteger numberOfSpatialPosition
 The number of process (number of simulation)
 
App::PropertyInteger numberOfFrequency
 The number of frequency increments.
 
App::PropertyInteger numberOfSample
 The Number of sample.
 
App::PropertyEnumeration WindDirection
 Wind Direction.
 
App::PropertyInteger numberOfTimeIncrements
 Nunber of time instant.
 
App::PropertyInteger locationJ
 A given location J among all the locations (simulation points)
 
App::PropertyInteger locationK
 A given location K among all the locations (simulation points)
 
App::PropertyInteger frequencyIndex
 A given frequency increment index among all the frequency increments.
 
App::PropertyInteger directionIndex
 A given direction increment index among all the direction increments.
 
App::PropertyInteger timeIndex
 A given time increment index among all the time increments.
 
App::PropertyInteger numberOfTimeLags
 Nunber of time lags for the computation of correlation.
 
App::PropertyInteger comparisonType
 The comparison type: 1 for accuracy, 2 for compuation time and 3 for memory usage.
 
App::PropertyInteger numberOfWaveLengthIncrements
 Number of wave lengh increments.
 
App::PropertyInteger numberOfDirectionIncrements
 Number of direction increments.
 
App::PropertyInteger waveLengthIndex
 A given wave length increment index among all the wave length increments.
 
App::PropertyInteger numberOfIncrementOfVariableX
 Number of increment for variable x.
 
App::PropertyInteger indexOfVariableX
 A given variable x increment index among all the variable x increments.
 
App::PropertyBool stationarity
 Specifies whether the stationary or non-stationary wind velocity is desired.
 
App::PropertyBool gaussianity
 Specifies whether the gaussian or non-gaussian wind velocity is desired.
 
App::PropertyBool comparisonMode
 Specifies whether we are in comparison mode or not.
 
App::PropertyBool largeScaleSimulationMode
 Specifies whether we are doing large scale simulation or not.
 
App::PropertyBool isSimulationSuccessful
 The flag specfies simulation successfull or not.
 
App::PropertyBool isInterruptionRequested
 This flag tells whether simulation or computation should be interrupted.
 
App::PropertyBool uniformModulation
 It tells whether non-stationarity should be acheived by time modulation.
 
App::PropertyTime minTime
 Minimum time from which incrementation should start.
 
App::PropertyTime maxTime
 Maximum time allowed after all incrementation.
 
App::PropertyTime timeIncrement
 the time increment value
 
App::PropertyFrequency minFrequency
 Minimum frequency from which incrementation should start.
 
App::PropertyFrequency frequencyIncrement
 The frequency increment value.
 
App::PropertyFrequency maxFrequency
 Maximum freqency allowed after all incrementation. The cutoff frequency.
 
App::PropertyLength minWaveLength
 Minimum wave length from which incrementation should start.
 
App::PropertyLength maxWaveLength
 Maximum wave length allowed after all incrementation.
 
App::PropertyLength waveLengthIncrement
 The wave length increment value.
 
App::PropertyAngle minDirection
 Initial direction from which incrementation should start.
 
App::PropertyAngle maxDirection
 Maximum direction allowed after all incrementation.
 
App::PropertyAngle directionIncrement
 The direction increment value.
 
App::PropertyFloat incrementOfVariableX
 The variable x increment value.
 
App::PropertyFloat minVariableX
 Minimum value from which incrementation should start.
 
App::PropertyString spatialDistribution
 The active spatial distribution name.
 
App::PropertyString shearVelocity
 The active shear velocity name.
 
App::PropertyString meanFunction
 The active mean wind profile name.
 
App::PropertyString alongWindSpectrumModel
 The active along wind spectrum model name.
 
App::PropertyString verticalWindSpectrumModel
 The active vertical wind spectrum model name.
 
App::PropertyString acrossWindSpectrumModel
 The active across wind spectrum model name.
 
App::PropertyString coherenceFunction
 
App::PropertyString simulationMethod
 The active simulation method name.
 
App::PropertyString frequencyDistribution
 The active frequency distribution name.
 
App::PropertyString cpsdDecompositionMethod
 The active CPSD Decomposition Method name.
 
App::PropertyString randomnessProvider
 The active randomness provider name.
 
App::PropertyString modulationFunction
 The active Modulation function name.
 
App::PropertyString correlationFunction
 The active correlation function name.
 
App::PropertyString varianceFunction
 The active variance model name.
 
App::PropertyString workingDirPath
 The working directory path.
 
App::PropertyString tableTool
 The active table tool name.
 
App::PropertyString matrixTool
 The active matrix tool name.
 
App::PropertyString userDefinedRPSObject
 The active user defined feature name.
 
App::PropertyString comparisonCategory
 The current comparison category.
 
App::PropertyString cumulativeProbabilityDistribution
 The active cumulative probability distribution.
 
App::PropertyString gustFactor
 The active gust factor.
 
App::PropertyString kurtosis
 The active kurtosis.
 
App::PropertyString peakFactor
 The active peak factor.
 
App::PropertyString probabilityDensityFunction
 The active probability density function.
 
App::PropertyString roughness
 The active terrain roughness.
 
App::PropertyString shearVelocityOfFlow
 The active flow shear velocity.
 
App::PropertyString skewness
 The active skewness.
 
App::PropertyString standardDeviation
 The active standard deviation.
 
App::PropertyString turbulenceIntensity
 The active turbulence intensity.
 
App::PropertyString turbulenceScale
 The active turbulence scale.
 
App::PropertyString variance
 The active variance.
 
App::PropertyString wavePassageEffect
 The active wave passage effect.
 

methods override feature

Py::SmartPtr PythonObject
 python object of this class
 
virtual short mustExecute () const override
 
virtual PyObject * getPyObject () override
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from WindLabAPI::WindLabFeature
- Protected Attributes inherited from WindLabAPI::WindLabFeature
Py::SmartPtr PythonObject
 

Detailed Description

The WindLab simulation data for random wind velocity.

Constructor & Destructor Documentation

◆ WindLabSimulationData()

WindLabSimulationData::WindLabSimulationData ( )

Construction.

◆ ~WindLabSimulationData()

WindLabSimulationData::~WindLabSimulationData ( )

Destruction.

Member Function Documentation

◆ execute()

App::DocumentObjectExecReturn * WindLabSimulationData::execute ( void )
overrideprotectedvirtual

recalculate the feature

Reimplemented from WindLabAPI::WindLabFeature.

References WindLabAPI::WindLabFeature::execute().

◆ getPyObject()

PyObject * WindLabSimulationData::getPyObject ( void )
overridevirtual

Reimplemented from WindLabAPI::WindLabFeature.

References PythonObject.

◆ mustExecute()

short WindLabSimulationData::mustExecute ( void ) const
overridevirtual

◆ onChanged()

void WindLabSimulationData::onChanged ( const App::Property * prop)
overrideprotectedvirtual

◆ recompute()

App::DocumentObjectExecReturn * WindLabSimulationData::recompute ( void )
overrideprotectedvirtual

recompute only this object

Reimplemented from WindLabAPI::WindLabFeature.

References WindLabAPI::WindLabFeature::recompute().

Member Data Documentation

◆ acrossWindSpectrumModel

◆ alongWindSpectrumModel

◆ coherenceFunction

◆ comparisonCategory

App::PropertyString WindLabAPI::WindLabSimulationData::comparisonCategory

The current comparison category.

◆ comparisonMode

App::PropertyBool WindLabAPI::WindLabSimulationData::comparisonMode

Specifies whether we are in comparison mode or not.

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

◆ comparisonType

App::PropertyInteger WindLabAPI::WindLabSimulationData::comparisonType

The comparison type: 1 for accuracy, 2 for compuation time and 3 for memory usage.

◆ correlationFunction

App::PropertyString WindLabAPI::WindLabSimulationData::correlationFunction

◆ cpsdDecompositionMethod

App::PropertyString WindLabAPI::WindLabSimulationData::cpsdDecompositionMethod

◆ cumulativeProbabilityDistribution

App::PropertyString WindLabAPI::WindLabSimulationData::cumulativeProbabilityDistribution

The active cumulative probability distribution.

Referenced by WindLabAPI::CRPSWindLabFramework::ComputeCPDValue(), and WindLabAPI::CRPSWindLabFramework::ComputeCPDVectorX().

◆ directionIncrement

App::PropertyAngle WindLabAPI::WindLabSimulationData::directionIncrement

The direction increment value.

◆ directionIndex

App::PropertyInteger WindLabAPI::WindLabSimulationData::directionIndex

A given direction increment index among all the direction increments.

◆ frequencyDistribution

App::PropertyString WindLabAPI::WindLabSimulationData::frequencyDistribution

◆ frequencyIncrement

App::PropertyFrequency WindLabAPI::WindLabSimulationData::frequencyIncrement

The frequency increment value.

◆ frequencyIndex

App::PropertyInteger WindLabAPI::WindLabSimulationData::frequencyIndex

A given frequency increment index among all the frequency increments.

◆ gaussianity

App::PropertyBool WindLabAPI::WindLabSimulationData::gaussianity

Specifies whether the gaussian or non-gaussian wind velocity is desired.

◆ gustFactor

◆ incrementOfVariableX

App::PropertyFloat WindLabAPI::WindLabSimulationData::incrementOfVariableX

The variable x increment value.

◆ indexOfVariableX

App::PropertyInteger WindLabAPI::WindLabSimulationData::indexOfVariableX

A given variable x increment index among all the variable x increments.

◆ isInterruptionRequested

App::PropertyBool WindLabAPI::WindLabSimulationData::isInterruptionRequested

This flag tells whether simulation or computation should be interrupted.

◆ isSimulationSuccessful

App::PropertyBool WindLabAPI::WindLabSimulationData::isSimulationSuccessful

The flag specfies simulation successfull or not.

◆ kurtosis

◆ largeScaleSimulationMode

App::PropertyBool WindLabAPI::WindLabSimulationData::largeScaleSimulationMode

Specifies whether we are doing large scale simulation or not.

◆ locationJ

App::PropertyInteger WindLabAPI::WindLabSimulationData::locationJ

A given location J among all the locations (simulation points)

◆ locationK

App::PropertyInteger WindLabAPI::WindLabSimulationData::locationK

A given location K among all the locations (simulation points)

◆ matrixTool

App::PropertyString WindLabAPI::WindLabSimulationData::matrixTool

The active matrix tool name.

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

◆ maxDirection

App::PropertyAngle WindLabAPI::WindLabSimulationData::maxDirection

Maximum direction allowed after all incrementation.

◆ maxFrequency

App::PropertyFrequency WindLabAPI::WindLabSimulationData::maxFrequency

Maximum freqency allowed after all incrementation. The cutoff frequency.

◆ maxTime

App::PropertyTime WindLabAPI::WindLabSimulationData::maxTime

Maximum time allowed after all incrementation.

◆ maxWaveLength

App::PropertyLength WindLabAPI::WindLabSimulationData::maxWaveLength

Maximum wave length allowed after all incrementation.

◆ meanFunction

App::PropertyString WindLabAPI::WindLabSimulationData::meanFunction

◆ minDirection

App::PropertyAngle WindLabAPI::WindLabSimulationData::minDirection

Initial direction from which incrementation should start.

◆ minFrequency

App::PropertyFrequency WindLabAPI::WindLabSimulationData::minFrequency

Minimum frequency from which incrementation should start.

◆ minTime

App::PropertyTime WindLabAPI::WindLabSimulationData::minTime

Minimum time from which incrementation should start.

◆ minVariableX

App::PropertyFloat WindLabAPI::WindLabSimulationData::minVariableX

Minimum value from which incrementation should start.

◆ minWaveLength

App::PropertyLength WindLabAPI::WindLabSimulationData::minWaveLength

Minimum wave length from which incrementation should start.

◆ modulationFunction

App::PropertyString WindLabAPI::WindLabSimulationData::modulationFunction

◆ numberOfDirectionIncrements

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfDirectionIncrements

Number of direction increments.

◆ numberOfFrequency

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfFrequency

The number of frequency increments.

◆ numberOfIncrementOfVariableX

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfIncrementOfVariableX

Number of increment for variable x.

◆ numberOfSample

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfSample

The Number of sample.

◆ numberOfSpatialPosition

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfSpatialPosition

The number of process (number of simulation)

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

◆ numberOfTimeIncrements

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfTimeIncrements

Nunber of time instant.

◆ numberOfTimeLags

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfTimeLags

Nunber of time lags for the computation of correlation.

◆ numberOfWaveLengthIncrements

App::PropertyInteger WindLabAPI::WindLabSimulationData::numberOfWaveLengthIncrements

Number of wave lengh increments.

◆ peakFactor

◆ probabilityDensityFunction

App::PropertyString WindLabAPI::WindLabSimulationData::probabilityDensityFunction

◆ PythonObject

Py::SmartPtr WindLabAPI::WindLabSimulationData::PythonObject
protected

python object of this class

Referenced by getPyObject().

◆ randomnessProvider

App::PropertyString WindLabAPI::WindLabSimulationData::randomnessProvider

◆ roughness

App::PropertyString WindLabAPI::WindLabSimulationData::roughness

◆ shearVelocity

App::PropertyString WindLabAPI::WindLabSimulationData::shearVelocity

The active shear velocity name.

◆ shearVelocityOfFlow

◆ simulationMethod

App::PropertyString WindLabAPI::WindLabSimulationData::simulationMethod

The active simulation method name.

◆ skewness

◆ spatialDistribution

App::PropertyString WindLabAPI::WindLabSimulationData::spatialDistribution

The active spatial distribution name.

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

◆ standardDeviation

◆ stationarity

App::PropertyBool WindLabAPI::WindLabSimulationData::stationarity

Specifies whether the stationary or non-stationary wind velocity is desired.

◆ tableTool

App::PropertyString WindLabAPI::WindLabSimulationData::tableTool

The active table tool name.

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

◆ timeIncrement

App::PropertyTime WindLabAPI::WindLabSimulationData::timeIncrement

the time increment value

◆ timeIndex

App::PropertyInteger WindLabAPI::WindLabSimulationData::timeIndex

A given time increment index among all the time increments.

◆ turbulenceIntensity

◆ turbulenceScale

◆ uniformModulation

App::PropertyBool WindLabAPI::WindLabSimulationData::uniformModulation

It tells whether non-stationarity should be acheived by time modulation.

◆ userDefinedRPSObject

App::PropertyString WindLabAPI::WindLabSimulationData::userDefinedRPSObject

The active user defined feature name.

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

◆ variance

◆ varianceFunction

App::PropertyString WindLabAPI::WindLabSimulationData::varianceFunction

The active variance model name.

◆ verticalWindSpectrumModel

◆ waveLengthIncrement

App::PropertyLength WindLabAPI::WindLabSimulationData::waveLengthIncrement

The wave length increment value.

◆ waveLengthIndex

App::PropertyInteger WindLabAPI::WindLabSimulationData::waveLengthIndex

A given wave length increment index among all the wave length increments.

◆ wavePassageEffect

◆ WindDirection

◆ workingDirPath

App::PropertyString WindLabAPI::WindLabSimulationData::workingDirPath

The working directory path.


The documentation for this class was generated from the following files:
  • RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/WindLabSimulationData.h
  • RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/WindLabSimulationData.cpp