1. Epic GamesDeveloper
  3. FVelocityAndPressureField

FVelocityAndPressureField

Velocity field used solely for aerodynamics effects, use Chaos Fields for other types of fields.

API > API/Runtime > API/Runtime/Chaos

Velocity field used solely for aerodynamics effects, use Chaos Fields for other types of fields.

   
Name FVelocityAndPressureField
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/VelocityField.h
Include Path #include "Chaos/VelocityField.h"

Syntax

class FVelocityAndPressureField

Constructors

Name Remarks Include Path Unreal Specifiers

FVelocityAndPressureField ( const FSolverParticlesRange& Particles,
const FTriangleMesh* TriangleMesh,
const FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > >& Weightmaps,
FSolverReal WorldScale
)

   Chaos/VelocityField.h  
  Chaos/VelocityField.h  
Construct an uninitialized field. Mesh, properties, and velocity will have to be set for this field to be valid. Chaos/VelocityField.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FVelocityAndPressureField()

   Chaos/VelocityField.h  

Structs

Name Remarks
FDragIndex  
FFluidDensityIndex  
FLiftIndex  
FOuterDragIndex  
FOuterLiftIndex  
FPressureIndex  
FTurbulenceRatioIndex  
FWindVelocityIndex  
FWindVelocitySpaceIndex  

Constants

Name Type Remarks Include Path
DefaultDragCoefficient FSolverReal   Chaos/VelocityField.h
DefaultFluidDensity FSolverReal   Chaos/VelocityField.h
DefaultLiftCoefficient FSolverReal   Chaos/VelocityField.h
DefaultTurbulenceRatio FSolverReal   Chaos/VelocityField.h
DefaultWindVelocitySpace EChaosSoftsSimulationSpace   Chaos/VelocityField.h
DragName const FName   Chaos/VelocityField.h
FluidDensityName const FName   Chaos/VelocityField.h
LiftName const FName   Chaos/VelocityField.h
MaxCoefficient FSolverReal   Chaos/VelocityField.h
MinCoefficient FSolverReal   Chaos/VelocityField.h
OuterDragName const FName   Chaos/VelocityField.h
OuterLiftName const FName   Chaos/VelocityField.h
PressureName const FName   Chaos/VelocityField.h
TurbulenceRatioName const FName   Chaos/VelocityField.h
WindVelocityName const FName   Chaos/VelocityField.h
WindVelocitySpaceName const FName   Chaos/VelocityField.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ConstraintsPerColorStartIndex TArray< int32 >   Chaos/VelocityField.h  
Drag FPBDFlatWeightMap   Chaos/VelocityField.h  
DragIndex Chaos::Softs::FVelocityAndPressureField::FDragIndex   Chaos/VelocityField.h  
Elements TConstArrayView< TVec3< int32 > >   Chaos/VelocityField.h  
ElementsLocal TArray< TVec3< int32 > >   Chaos/VelocityField.h  
FluidDensityIndex Chaos::Softs::FVelocityAndPressureField::FFluidDensityIndex   Chaos/VelocityField.h  
Forces TArray< FSolverVec3 >   Chaos/VelocityField.h  
Lift FPBDFlatWeightMap   Chaos/VelocityField.h  
LiftIndex Chaos::Softs::FVelocityAndPressureField::FLiftIndex   Chaos/VelocityField.h  
NumParticles int32   Chaos/VelocityField.h  
Offset int32   Chaos/VelocityField.h  
OuterDrag FPBDFlatWeightMap   Chaos/VelocityField.h  
OuterDragIndex Chaos::Softs::FVelocityAndPressureField::FOuterDragIndex   Chaos/VelocityField.h  
OuterLift FPBDFlatWeightMap   Chaos/VelocityField.h  
OuterLiftIndex Chaos::Softs::FVelocityAndPressureField::FOuterLiftIndex   Chaos/VelocityField.h  
PointToTriangleMap TConstArrayView< TArray< int32 > >   Chaos/VelocityField.h  
PointToTriangleMapLocal TArray< TArray< int32 > >   Chaos/VelocityField.h  
Pressure FPBDFlatWeightMap   Chaos/VelocityField.h  
PressureIndex Chaos::Softs::FVelocityAndPressureField::FPressureIndex   Chaos/VelocityField.h  
QuarterRho FSolverReal   Chaos/VelocityField.h  
Rho FSolverReal   Chaos/VelocityField.h  
TurbulenceRatio FSolverReal   Chaos/VelocityField.h  
TurbulenceRatioIndex Chaos::Softs::FVelocityAndPressureField::FTurbulenceRatioIndex   Chaos/VelocityField.h  
Velocity FSolverVec3   Chaos/VelocityField.h  
WindVelocityIndex Chaos::Softs::FVelocityAndPressureField::FWindVelocityIndex   Chaos/VelocityField.h  
WindVelocitySpaceIndex Chaos::Softs::FVelocityAndPressureField::FWindVelocitySpaceIndex   Chaos/VelocityField.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Apply ( FSolverParticlesRange& InParticles,
const FSolverReal Dt
) const

   Chaos/VelocityField.h  

void Apply ( FSolverParticles& InParticles,
const FSolverReal Dt,
const int32 Index
) const

   Chaos/VelocityField.h  

FSolverVec3 CalculateForce ( const TConstArrayView< FSolverVec3 >& Xs,
const TConstArrayView< FSolverVec3 >& Vs,
int32 ElementIndex
) const

 This method is currently used for debug drawing. Chaos/VelocityField.h  

TConstArrayView< TVector< int32, 3 > > GetElements()

   Chaos/VelocityField.h  

TConstArrayView< FSolverVec3 > GetForces()

   Chaos/VelocityField.h  

const FSolverVec3 & GetVelocity()

   Chaos/VelocityField.h  

bool IsActive()

   Chaos/VelocityField.h  

void SetGeometry ( const FTriangleMesh* TriangleMesh,
const TConstArrayView< FRealSingle >& DragMultipliers,
const TConstArrayView< FRealSingle >& LiftMultipliers,
const TConstArrayView< FRealSingle >& PressureMultipliers
)

   Chaos/VelocityField.h  

void SetGeometry ( const FTriangleMesh* TriangleMesh,
const FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > >& Weightmaps,
FSolverReal WorldScale
)

   Chaos/VelocityField.h  

void SetGeometry ( const FTriangleMesh* TriangleMesh,
const TConstArrayView< FRealSingle >& DragMultipliers,
const TConstArrayView< FRealSingle >& OuterDragMultipliers,
const TConstArrayView< FRealSingle >& LiftMultipliers,
const TConstArrayView< FRealSingle >& OuterLiftMultipliers,
const TConstArrayView< FRealSingle >& PressureMultipliers
)

   Chaos/VelocityField.h  

void SetProperties ( const FSolverVec2& Drag,
const FSolverVec2& OuterDrag,
const FSolverVec2& Lift,
const FSolverVec2& OuterLift,
const FSolverReal FluidDensity,
const FSolverVec2& Pressure,
FSolverReal WorldScale
)

   Chaos/VelocityField.h  

void SetProperties ( const FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > >& Weightmaps,
FSolverReal WorldScale,
bool bEnableAerodynamics
)

 This version will not load WindVelocity from the config. Call SetVelocity to set it explicitly. Chaos/VelocityField.h  

void SetPropertiesAndWind ( const FCollectionPropertyConstFacade& PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > >& Weightmaps,
FSolverReal WorldScale,
bool bEnableAerodynamics,
const FSolverVec3& SolverWind,
const FRotation3& LocalSpaceRotation,
const FRotation3& ReferenceSpaceRotation
)

 This version will load WindVelocity from the config Provide LocalSpaceRotation and/or ReferenceSpaceRotation to convert WindVelocity to solver space based on WindVelocitySpace Chaos/VelocityField.h  

void SetVelocity ( const FSolverVec3& InVelocity
)

   Chaos/VelocityField.h  

void UpdateForces ( const FSolverParticles& InParticles,
const FSolverReal
)

   Chaos/VelocityField.h  

Static

Name Remarks Include Path Unreal Specifiers

static float GetDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetDragString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetFluidDensityString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetHighDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetHighTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector3f GetHighWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/VelocityField.h  

static int32 GetHighWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const int32& Default
)

   Chaos/VelocityField.h  

static float GetLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetLiftString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetLowDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static float GetLowTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector3f GetLowWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/VelocityField.h  

static int32 GetLowWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const int32& Default
)

   Chaos/VelocityField.h  

static float GetOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetOuterDragString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetOuterLiftString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetPressureString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static float GetTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FString GetTurbulenceRatioString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static FVector2f GetWeightedFloatWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector2f& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedFluidDensity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedOuterDrag ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedOuterLift ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedPressure ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< float, float > GetWeightedTurbulenceRatio ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const float& Default
)

   Chaos/VelocityField.h  

static TPair< FVector3f, FVector3f > GetWeightedWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/VelocityField.h  

static TPair< int32, int32 > GetWeightedWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const int32& Default
)

   Chaos/VelocityField.h  

static FVector3f GetWindVelocity ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FVector3f& Default
)

   Chaos/VelocityField.h  

static int32 GetWindVelocitySpace ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const int32& Default
)

   Chaos/VelocityField.h  

static FString GetWindVelocitySpaceString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static FString GetWindVelocityString ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
const FString& Default
)

   Chaos/VelocityField.h  

static bool IsDragAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsDragEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsEnabled ( const FCollectionPropertyConstFacade& PropertyCollection
)

   Chaos/VelocityField.h  

static bool IsFluidDensityAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsFluidDensityEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsLiftAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsLiftEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsOuterDragAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsOuterDragEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsOuterLiftAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsOuterLiftEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsPressureAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsPressureEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsTurbulenceRatioAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsTurbulenceRatioEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsWindVelocityAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsWindVelocityEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsWindVelocitySpaceAnimatable ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

static bool IsWindVelocitySpaceEnabled ( const ::Chaos::Softs::FCollectionPropertyConstFacade& InPropertyCollection,
bool bDefault
)

   Chaos/VelocityField.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page