AerodynamicObjects.Flow.VortexFilament Class Reference

Implements the Biot-Savart law to model a vortex filament of finite length. More...

Inheritance diagram for AerodynamicObjects.Flow.VortexFilament:

Public Member Functions
override void	OnEnable ()
override void	OnDestroy ()
void	RemoveConnections ()
void	Initialise ()
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
VortexNode	startNode
VortexNode	endNode
bool	isDynamic
bool	isTemporal
float	initialStrength = 1
float	coreRadius = 0.01f
AnimationCurve	strengthWithTime
float	life
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

Implements the Biot-Savart law to model a vortex filament of finite length.

Requires two vortex nodes to define the end points of the filament.

Member Function Documentation

Initialise()

void AerodynamicObjects.Flow.VortexFilament.Initialise

(

)

OnDestroy()

override void AerodynamicObjects.Flow.VortexFilament.OnDestroy ( )

virtual

Reimplemented from AerodynamicObjects.FlowPrimitive.

OnEnable()

override void AerodynamicObjects.Flow.VortexFilament.OnEnable ( )

virtual

Reimplemented from AerodynamicObjects.FlowPrimitive.

RemoveConnections()

void AerodynamicObjects.Flow.VortexFilament.RemoveConnections

(

)

VelocityFunction()

override Vector3 AerodynamicObjects.Flow.VortexFilament.VelocityFunction ( Vector3  position )

virtual

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

Parameters

position

Position 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.VortexFilament.coreRadius = 0.01f

endNode

VortexNode AerodynamicObjects.Flow.VortexFilament.endNode

initialStrength

float AerodynamicObjects.Flow.VortexFilament.initialStrength = 1

isDynamic

bool AerodynamicObjects.Flow.VortexFilament.isDynamic

isTemporal

bool AerodynamicObjects.Flow.VortexFilament.isTemporal

life

float AerodynamicObjects.Flow.VortexFilament.life

startNode

VortexNode AerodynamicObjects.Flow.VortexFilament.startNode

strengthWithTime

AnimationCurve AerodynamicObjects.Flow.VortexFilament.strengthWithTime

---

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

• C:/Unity/AO 2/Assets/AO/Scripts/Flow/VortexFilament.cs