Vortex Studio SDK Classes Documentation
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Vx::VxPlanarFluidState Class Reference

VxPlanarFluidState a simple static horizontal fluid interface with fluid everywhere below the surface. More...

#include <Vx/VxFluidInteraction.h>

+ Inheritance diagram for Vx::VxPlanarFluidState:

Public Member Functions

virtual double getLevel (const VxReal3) const
 returns the water level at pos (pure virtual, must be overwriten)
 
virtual void getMinMaxLevel (const VxReal3, const VxReal3, double *minLevel, double *maxLevel) const
 returns the min and max water level inside the bounding box (pure virtual, must be overwriten)
 
- Public Member Functions inherited from Vx::VxFluidState
virtual const char * getClassName () const
 Returns the class name.
 
double getDefaultDensity () const
 Returns the fluid default density. More...
 
const VxVector3getDefaultVelocity () const
 returns the default velocity for this fluid.
 
virtual double getDensity (const VxReal3) const
 returns the density at pos, this function should be overridden if the density varies within the fluid
 
virtual double getTemperature (const VxReal3) const
 returns the fluid temperature within the fluid, this is currently unused
 
virtual void getVelocity (const VxReal3, VxReal3 v) const
 returns the fluid velocity and pos, this function should be overridden if the velocity varies within the fluid
 
void setDefaultVelocity (const VxVector3 &v)
 set the default velocity for this fluid.
 
- Public Member Functions inherited from Vx::VxBase
unsigned int getCreationIndex () const
 Access the creation index of the instance.
 
const char * getName () const
 Retrieves the name. More...
 
void setCombinedName (const char *base, const char *name, size_t i=0)
 Utility to set the name to a concatenate string = base_name_i.
 
virtual void setName (const char *name)
 Sets the name.
 

Additional Inherited Members

- Static Public Member Functions inherited from Vx::VxBase
static Subscriber * getConstructorSubscriber ()
 Returns default static VxBase Subscriber that is be called each time an instance of VxBase is create.
 
static void setConstructorSubscriber (Subscriber *inSub)
 Sets a default static VxBase Subscriber that will be called each time an instance of VxBase is create.
 
- Static Public Attributes inherited from Vx::VxFluidState
static VxVector3 sBoxSubdivisionSideMaxLengthXYZ
 default face added mass moment coeff
 
static double sCylinderDragCoeff
 default sphere drag coeff
 
static double sFaceAddedMassCoeff
 default flat face drag coeff
 
static double sFaceAddedMassMomentCoeff
 default face drag moment coeff
 
static double sFaceDragCoeff
 default cyl drag coeff
 
static double sFaceDragMomentCoeff
 default face added mass coeff
 
static double sFaceLiftCoeff
 default flat face drag coeff
 

Detailed Description

VxPlanarFluidState a simple static horizontal fluid interface with fluid everywhere below the surface.

The plane elevation is specified in the constructor or the setLevel method, the orientation set according to the setGravity.