Aerodynamic Objects Core 2.0.0
Loading...
Searching...
No Matches
AerodynamicObjects.Flow.UniformFlow Class Reference

Provides a prevailing wind which does not vary with position. More...

Inheritance diagram for AerodynamicObjects.Flow.UniformFlow:
AerodynamicObjects.FlowPrimitive

Public Member Functions

override Vector3 VelocityFunction (Vector3 position)
 Override this function to change the way the velocity of the fluid is calculated. More...
 
- Public Member Functions inherited from AerodynamicObjects.FlowPrimitive
void GetInteractionID ()
 Obtains a unique interaction ID for the object. More...
 
virtual void Awake ()
 
virtual void OnEnable ()
 
virtual void OnDestroy ()
 
virtual void OnDisable ()
 
void AddSelfToScene ()
 
void AcquireFluidVolume (FluidVolume fluidVolume)
 
void RemoveFromScene ()
 
Vector3 VelocityFunction (Vector3 position, int flowAffectedID)
 Wrapper function which first checks if the interaction should happen. More...
 
virtual Vector3 VelocityFunction (Vector3 position)
 Override this function to change the way the velocity of the fluid is calculated. More...
 
bool IsInteractionIgnored (int flowAffectedID)
 
void IgnoreInteraction (int flowAffectedID)
 
void IgnoreInteraction (FlowAffected flowAffected)
 
void AddSelfToGlobalFluid ()
 
void RemoveSelfFromGlobalFluid ()
 

Public Attributes

DirectionalVelocity windVelocity
 
bool enableTurbulence = false
 
float turbulenceMagnitude = 1f
 Magnitude of turblent velocity in m/s More...
 
float turbulenceLengthScale = 1f
 Controls how quickly turbulence changes with distance. More...
 
float turbulenceTimeScale = 1f
 Controls how quickly turbulence changes with time. More...
 
bool xyTurbulenceOnly
 Restricts turbulence to be in the xy plane only. More...
 
- Public Attributes inherited from AerodynamicObjects.FlowPrimitive
float strengthScale = 1f
 This value is used to scale the flow primitive behaviour. More...
 
int interactionID = 0
 The unique ID number for this flow primitive, used for identifying pairs of ignored interactions by the FlowInteractionManager. More...
 

Detailed Description

Provides a prevailing wind which does not vary with position.

Includes an optional perlin noise turbulence model which varies the wind with position and time.

Member Function Documentation

◆ VelocityFunction()

override Vector3 AerodynamicObjects.Flow.UniformFlow.VelocityFunction ( Vector3  position)
virtual

Override this function to change the way the velocity of the fluid is calculated.

Parameters
positionPosition of the object in the global (earth) frame of reference.
Returns
The velocity of the fluid at the given position in the global (earth) frame.

Reimplemented from AerodynamicObjects.FlowPrimitive.

Member Data Documentation

◆ enableTurbulence

bool AerodynamicObjects.Flow.UniformFlow.enableTurbulence = false

◆ turbulenceLengthScale

float AerodynamicObjects.Flow.UniformFlow.turbulenceLengthScale = 1f

Controls how quickly turbulence changes with distance.

Use a larger value for higher spatial frequency. Scaled with respect to the size of the fluid zone.

◆ turbulenceMagnitude

float AerodynamicObjects.Flow.UniformFlow.turbulenceMagnitude = 1f

Magnitude of turblent velocity in m/s

◆ turbulenceTimeScale

float AerodynamicObjects.Flow.UniformFlow.turbulenceTimeScale = 1f

Controls how quickly turbulence changes with time.

Use a larger value for higher temporal frequency. Unscaled.

◆ windVelocity

DirectionalVelocity AerodynamicObjects.Flow.UniformFlow.windVelocity

◆ xyTurbulenceOnly

bool AerodynamicObjects.Flow.UniformFlow.xyTurbulenceOnly

Restricts turbulence to be in the xy plane only.


The documentation for this class was generated from the following file: