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

Provides flow velocity orthogonal to a line with specified length and a direction defined by the transform's forward direction. More...

Inheritance diagram for AerodynamicObjects.Flow.LineSource:
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

float sourceStrength = 1
 The volume flow rate produced by the source in m^3/s. More...
 
float coreRadius = 0.01f
 Used to limit the maximum velocity magnitude. More...
 
float length = 1f
 Length of line source in z direction. More...
 
Fade fade = Fade.DistanceLinear
 How the velocity fades with radius. More...
 
bool velocityIsZeroInCore = false
 Should the velocity inside the core radius be zero or the full strength of the source/sink. 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 flow velocity orthogonal to a line with specified length and a direction defined by the transform's forward direction.

Member Function Documentation

◆ VelocityFunction()

override Vector3 AerodynamicObjects.Flow.LineSource.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

◆ coreRadius

float AerodynamicObjects.Flow.LineSource.coreRadius = 0.01f

Used to limit the maximum velocity magnitude.

Defines a core region in which the velocity magnitude is a constant equal to the velocity magnitude at the core radius. Value must be greater than zero

◆ fade

Fade AerodynamicObjects.Flow.LineSource.fade = Fade.DistanceLinear

How the velocity fades with radius.

For physically conserving flow from a line source use distance linear

◆ length

float AerodynamicObjects.Flow.LineSource.length = 1f

Length of line source in z direction.

Centre is located at the transform origin

◆ sourceStrength

float AerodynamicObjects.Flow.LineSource.sourceStrength = 1

The volume flow rate produced by the source in m^3/s.

A negative value changes the source into a sink

◆ velocityIsZeroInCore

bool AerodynamicObjects.Flow.LineSource.velocityIsZeroInCore = false

Should the velocity inside the core radius be zero or the full strength of the source/sink.


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