View source for WindLab CreateSimulation

{{Docnav
|
|[[WindLab_CreateFeature|Create Features]]
|[[WindLab_Workbench|WindLab]]
|IconL=
|IconR=WindLab_CreateFeature.svg
|IconC=Workbench_WindLab.svg
}}

{{GuiCommand
|Name=New Simulation
|MenuLocation=WindLab → New Simulation
|Phenomena=[[WindLab_Workbench|WindLab]]
|SeeAlso=[[WindLab_tutorial|WindLab tutorial]]
}}

==Description== 

The WindLab Simulation could be seen as a container that holds all objects of random wind velocity simulation. It is mandatory to have a simulation container that holds all the needed objects. 

==Usage== 

# There are several ways to invoke the command:
#* Press the {{Button|[[Image:WindLab_CreateSimulation.svg|16px]] [[WindLab_CreateSimulation|New Simulation]]}} button.
#* Select the {{MenuCommand|WindLab → [[Image:WindLab_CreateSimulation.svg|16px]] New Simulation}} option from the menu.
# A new Simulation is created and set to active.
# Any WindLab Features (objects) could be added or removed from the simulation from [[Image:WindLab_CreateFeature.svg|32px]] [[WindLab_CreateFeature|Create Feature]].
# To add new WindLab Features (objects) to the document the simulation has to be active. Double-clicking on the simulation container activates the simulation.

==Properties== 

* {{PropertyData|NumberOfSample}}: This is the number of wind field sample in a simulation.
* {{PropertyData|NumberOfTimeLags}}: Number of time lags need for temporal correlation.
* {{PropertyData|Stationarity}}: This specifies whether the simulated wind velocity is stationary or non-stationary.
* {{PropertyData|Gaussianity}}: This specifies whether the simulated wind is gaussian or non-gaussian.
* {{PropertyData|ComparisonMode}}: This specifies whether we are in comparison mode or not.
* {{PropertyData|LargeScaleSimulationMode}}: This specifies whether we are in large scale simulation mode or not.
* {{PropertyData|IsSimulationSuccessful}}: This specifies whether the simulation was successful or not.
* {{PropertyData|IsInterruptionRequested}}: This specifies whether the simulation needs to be interrupted or not.
* {{PropertyData|UniformModulation}}: This specifies whether a non stataionary wind is uniformly modulated or not.
* {{PropertyData|NumberOfProcess}}: The number of simulation point which is the number of wind processes in a sample.
* {{PropertyData|LocationIndexJ}}: The index of the a given wind process in a wind field at a location J. 
* {{PropertyData|LocationIndexK}}: The index of the a given wind process in a wind field at a location K.
* {{PropertyData|NumberOfFrequency}}: The number of discrete frequency increments.
* {{PropertyData|FrequencyIncrement}}: This is the frequency increment value.
* {{PropertyData|MinFrequency}}: This is the minimum frequency value.
* {{PropertyData|MaxFrequency}}: This is the maximum frequency value or the cutoff frequency.
* {{PropertyData|FrequencyIndex}}: Index correponding to Kth discrete frequency increment.
* {{PropertyData|NumberOfTimeIncrements}}: This is the number of time increments.
* {{PropertyData|TimeIncrement}}: This is the time increment value.
* {{PropertyData|MinTime}}: This is the minimum time value.
* {{PropertyData|MaxTime}}: This is the maximum time value.
* {{PropertyData|TimeIndex}}: Index correponding to Kth time increment.
* {{PropertyData|NumberOfDirectionIncrements}}: The number of direction increments.
* {{PropertyData|DirectionIncrement}}: This is the direction increment value.
* {{PropertyData|MinDirection}}: This is the minimum direction value.
* {{PropertyData|MaxDirection}}: This is the maximum direction value.
* {{PropertyData|DirectionIndex}}: Index correponding to Kth direction increment.
* {{PropertyData|NumberOfWaveLengthIncrements}}: The number of discrete wave length increment.
* {{PropertyData|WaveLengthIncrement}}: This is the wave length value.
* {{PropertyData|MinWaveLength}}: This is the minimum wave length.
* {{PropertyData|MaxWaveLength}}: This is the maximum wave length.
* {{PropertyData|WaveLengthIndex}}: Index correponding to Kth wave length increment.
* {{PropertyData|SpatialDistribution}}: Active location distribution (simulation points distribution) name.
* {{PropertyData|MeanFunction}}: Active mean wind profile name.
* {{PropertyData|AlongWindSpectrumModel}}: Active along wind spectrum model name.
* {{PropertyData|VerticalWindSpectrumModel}}: Active vertical wind spectrum model name.
* {{PropertyData|AcrossWindSpectrumModel}}: Active across wind spectrum model name.
* {{PropertyData|CoherenceFunction}}: Active coherence function name.
* {{PropertyData|SimulationMethod}}: Active simulation method name.
* {{PropertyData|FrequencyDistribution}}: Active frequency distribution name.
* {{PropertyData|SpectrumDecompositionMethod}}: Active PSD decomposition method name.
* {{PropertyData|RandomnessProvider}}: Active randomness provider name.
* {{PropertyData|ModulationFunction}}: Active modulation function name.
* {{PropertyData|CorrelationFunction}}: Active correlation function name.
* {{PropertyData|TableTool}}: The active table tool name.
* {{PropertyData|MatrixTool}}: The active matrix name.
* {{PropertyData|UserDefinedRPSObject}}: user defined RPS object name.
* {{PropertyData|CumulativeProbabilityDistribution}}: Active CPD name.
* {{PropertyData|GustFactor}}: Active gust factor name.
* {{PropertyData|Kurtosis}}: Active kurtosis name.
* {{PropertyData|PeakFactor}}: Active peak factor name.
* {{PropertyData|ProbabilityDensityFunction}}: Active PDF name.
* {{PropertyData|Roughness}}: Active roughness name.
* {{PropertyData|ShearVelocityOfFlow}}: Active shear velocity name.
* {{PropertyData|Skewness}}: Active skewness name.
* {{PropertyData|StandardDeviation}}: Active standard deviation name.
* {{PropertyData|TurbulenceIntensity}}: Active turbulence intensity name.
* {{PropertyData|TurbulenceScale}}: Active turbulence scale name.
* {{PropertyData|Variance}}: Active variance name.
* {{PropertyData|WavePassageEffect}}: Active wave passage name.
* {{PropertyData|NumberOfIncrementOfVariableX}}: The number of increments for the variable x.
* {{PropertyData|IndexOfVariableX}}: This current index of the variable x.
* {{PropertyData|IncrementOfVariableX}}: This is the variable x increment value.
* {{PropertyData|MinVariableX}}: This is the minimum x variable value
* {{PropertyData|Phenomenon}}: The random phenonenon name. It is going to be Random Wind Velocity here.
* {{PropertyData|WorkingDirectoryPath}}: The working directory path.
* {{PropertyData|WindDirection}}: The wind direction.

==Scripting==

* Create new document and add new simulation to it.

{{Code|code=
import WindLabObjects
import LabRPS
doc = LabRPS.newDocument()
sim = WindLabObjects.makeSimulation(doc, "MySimulation")
if not sim:
    LabRPS.Console.PrintError("The simulation does not exist.\n")
}}


{{Docnav
|
|[[WindLab_CreateFeature|Create Features]]
|[[WindLab_Workbench|WindLab]]
|IconL=
|IconR=WindLab_CreateFeature.svg
|IconC=Workbench_WindLab.svg
}}

{{WindLab Tools navi}}
{{Userdocnavi}}