HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_VectorField Class Reference

This class holds a three dimensional vector field. More...

#include <SIM_VectorField.h>

+ Inheritance diagram for SIM_VectorField:

Classes

class  enforceVelBoundaryVariationalParms
 

Public Types

typedef SIM_RawField rawfield_type
 
typedef UT_Vector3(* ut_velocityCalc )(const UT_Vector3 &pos, void *vp)
 
typedef void(* ut_physParmCalc )(const UT_Vector3 &pos, void *vp, fpreal &bounce, fpreal &friction, fpreal &dynfriction)
 

Public Member Functions

 GETSET_DATA_FUNCS_S (SIM_NAME_POSITIONPATH, PositionPath)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_UNIFORMVOXELS, UniformVoxels)
 Control the number of divisions. More...
 
 GETSET_DATA_FUNCS_B (SIM_NAME_TWOD, TwoDField)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_VOXELPLANE, VoxelPlane)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_DIV, RawDivisions)
 
 GETSET_DATA_FUNCS_I ("uniformdiv", RawUniformDivisions)
 
 GETSET_DATA_FUNCS_F ("divsize", RawDivisionSize)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_CENTER, RawCenter)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_SIZE, RawSize)
 
 GETSET_DATA_FUNCS_V3 ("slicediv", SliceDivisions)
 
 GETSET_DATA_FUNCS_V3 ("sliceoverlapneg", SliceOverlapNeg)
 
 GETSET_DATA_FUNCS_V3 ("sliceoverlappos", SliceOverlapPos)
 
exint getNumSlices () const
 
 GETSET_DATA_FUNCS_I ("totalvoxels", TotalVoxels)
 
 GETSET_DATA_FUNCS_V3 ("totalvoxelres", TotalVoxelRes)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_VOXELSAMPLE, VoxelSampleRaw)
 
 GETSET_DATA_FUNCS_B ("closedends", ClosedEnds)
 
 GETSET_DATA_FUNCS_B ("closexneg", CloseXNeg)
 
 GETSET_DATA_FUNCS_B ("closeyneg", CloseYNeg)
 
 GETSET_DATA_FUNCS_B ("closezneg", CloseZNeg)
 
 GETSET_DATA_FUNCS_B ("closexpos", CloseXPos)
 
 GETSET_DATA_FUNCS_B ("closeypos", CloseYPos)
 
 GETSET_DATA_FUNCS_B ("closezpos", CloseZPos)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_DIRECTION, ExternalDirection)
 
 GETSET_DATA_FUNCS_F (SIM_NAME_TOLERANCE, Tolerance)
 
 GETSET_DATA_FUNCS_B ("usefp16", UseFP16)
 
 GETSET_DATA_FUNCS_I ("border", RawBorder)
 
UT_VoxelBorderType getBorder () const
 
void setBorder (UT_VoxelBorderType border)
 
void getBBox (UT_BoundingBox &bbox) const
 
UT_Vector3 getOrig () const
 
UT_Vector3 getDivisions () const
 
UT_Vector3 getSize () const
 
UT_Vector3 getCenter () const
 
void setDivisions (const UT_Vector3 &div)
 
void setSize (const UT_Vector3 &div)
 
void setCenter (const UT_Vector3 &div)
 
void resizeKeepData (const UT_Vector3 &size, const UT_Vector3 &center, bool keepdata, const char *address=0, int port=-1)
 
void matchField (const SIM_ScalarField *field)
 
void matchField (const SIM_VectorField *field, bool matchsample=false)
 
void matchField (const SIM_MatrixField *field)
 
void matchField (const SIM_IndexField *field)
 
void matchVolume (const GEO_PrimVolume *vol, const UT_DMatrix4 &xform)
 
void matchVDB (const GEO_PrimVDB *vdb, const UT_DMatrix4 &xform)
 
bool isAligned (const SIM_ScalarField *field) const
 
bool isAligned (const SIM_MatrixField *field) const
 
bool isAligned (const SIM_VectorField *field) const
 
bool isAligned (const SIM_RawField *field) const
 
bool isMatching (const SIM_VectorField *field) const
 
bool isFaceSampled () const
 
bool isCenterSampled () const
 
bool isSelfAligned () const
 True if our internal fields are aligned. More...
 
SIM_FieldSample getVoxelSample (int axis) const
 
const UT_Vector3getVoxelSize (int axis) const
 
fpreal getVoxelDiameter (int axis) const
 
UT_Vector3 getVoxelSize () const
 
void setVoxelSize (const UT_Vector3 &voxelsize)
 
UT_Vector3 getValue (const UT_Vector3 &pos) const
 
UT_DMatrix3 getGradient (const UT_Vector3 &pos) const
 Computes the gradient of the vector field in world space.. More...
 
UT_Vector3 getCurl (const UT_Vector3 &pos) const
 Computes the curl at a given worldspace. More...
 
UT_Vector3 getCellValue (int x, int y, int z) const
 
void addToCell (int x, int y, int z, const UT_Vector3 &dv)
 
void advect (UT_Vector3 &pos, float time, float cfl=1.0f) const
 
void advectMidpoint (UT_Vector3 &pos, float time, float cfl=1.0f) const
 Uses second order explicit runge-kutta integration. More...
 
void advectRK3 (UT_Vector3 &pos, float time, float cfl=1.0f) const
 Uses third order explicit runge-kutta integration. More...
 
void advectRK4 (UT_Vector3 &pos, float time, float cfl=1.0f) const
 Uses fourth order explicit runge-kutta integration. More...
 
void advect (const SIM_VectorField *vel, float timestep, const SIM_RawField *collision, SIM_FieldAdvection advectmethod, float cfl)
 
void advect (sim_PointVelocity getVelocity, float timestep, float voxelsize, const SIM_RawField *collision=0, float cfl=1.0f)
 
void advectMinMax (SIM_VectorField *minfield, SIM_VectorField *maxfield, const SIM_VectorField *vel, float timestep, const SIM_RawField *collision, SIM_FieldAdvection advectmethod, float cfl)
 
void projectToNonDivergent (const SIM_RawField *pressureboundary=0, const SIM_RawField *collision=0, SIM_RawField *pressureout=0, bool preservebubble=true, const SIM_RawField *goaldiv=0, SIM_RawIndexField *compout=0, bool ghostfluid=true, bool variational=true, SIM_RawField::PCG_METHOD pcgmethod=SIM_RawField::PCG_MIC, int numiterforcenter=20)
 
void projectToNonDivergentCenter (const SIM_RawField *pressureboundary, const SIM_RawField *goaldiv, int numiter)
 
void projectToNonDivergentFace (const SIM_RawField *pressureboundary, const SIM_RawField *collision, SIM_RawField *pressureout=0, bool preservebubble=true, const SIM_RawField *goaldiv=0, SIM_RawIndexField *compout=0, bool ghostfluid=true, bool variational=true, SIM_RawField::PCG_METHOD pcgmethod=SIM_RawField::PCG_MIC)
 
 THREADED_METHOD1_CONST (SIM_VectorField, getField(0) ->shouldMultiThread(), buildDivergenceCenter, SIM_RawField &, div) void buildDivergenceCenterPartial(SIM_RawField &div
 Evaluates the divergence field for this velocity field. More...
 
 THREADED_METHOD1_CONST (SIM_VectorField, getField(0) ->shouldMultiThread(), buildDivergenceCorner, SIM_RawField &, div) void buildDivergenceCornerPartial(SIM_RawField &div
 Evaluates the divergence field for this velocity field. More...
 
 THREADED_METHOD5 (SIM_VectorField, getField(axis) ->shouldMultiThread(), applyPressureGradientFace, int, axis, const SIM_RawField *, pressure, const SIM_RawField *, surface, const SIM_RawIndexField *, comp, bool, pressureBoundaryAtFace) void applyPressureGradientFacePartial(int axis
 
 THREADED_METHOD1 (SIM_VectorField, getField(0) ->shouldMultiThread(), applyPressureGradientCenter, const SIM_RawField *, pressure) void applyPressureGradientCenterPartial(const SIM_RawField *pressure
 
 THREADED_METHOD1 (SIM_VectorField, getField(0) ->shouldMultiThread(), applyPressureGradientCorner, const SIM_RawField *, pressure) void applyPressureGradientCornerPartial(const SIM_RawField *pressure
 
void distributeBoundaryDivergenceToVolumeFace (SIM_RawField &div, const SIM_RawField *pressureboundary=0, int compnum=-1, const SIM_RawIndexField *comp=0)
 
 THREADED_METHOD6_CONST (SIM_VectorField, div.shouldMultiThread(), hasSurfaceCell, bool *, result, SIM_RawField &, div, const SIM_RawField *, pressureboundary, const SIM_RawField *, collision, int, compnum, const SIM_RawIndexField &, comp) void hasSurfaceCellPartial(bool *result
 
void distributeBoundaryDivergenceToSurfaceFace (SIM_RawField &div, const SIM_RawField *pressureboundary, const SIM_RawField *collision, int compnum, const UT_VoxelArray< int64 > &comp)
 
void enforceBoundary (const SIM_ScalarField *collision=0, const SIM_VectorField *cvel=0, const SIM_VectorField *bvel=0, const SIM_BoundaryLine &worldbline=SIM_BoundaryLine())
 
void enforceVelBoundary (const SIM_ScalarField *collision, ut_velocityCalc calcVelocity, void *vvp, ut_physParmCalc calcPhysParms, void *vpp, bool forbidinterference, const SIM_BoundaryLine &worldbline=SIM_BoundaryLine())
 
void enforceVelBoundaryVariational (const SIM_ScalarField *collision, const SIM_VectorField *weights, ut_velocityCalc calcVelocity, void *vvp, ut_physParmCalc calcPhysParms, void *vpp, bool threadsafe, fpreal bandwidth)
 
 THREADED_METHOD1 (SIM_VectorField, parms.u->shouldMultiThread(), enforceVelBoundaryVariationalAxis, enforceVelBoundaryVariationalParms &, parms)
 
void enforceVelBoundaryVariationalAxisPartial (enforceVelBoundaryVariationalParms &parms, const UT_JobInfo &info)
 
bool indexToPos (int axis, int x, int y, int z, UT_Vector3 &pos) const
 Converts an integer index into a worldspace position. More...
 
bool posToIndex (int axis, const UT_Vector3 &pos, int &x, int &y, int &z) const
 Converts a worldspace position into an integer index. More...
 
SIM_RawFieldgetField (int axis) const
 Retrieve raw field. More...
 
SIM_RawFieldgetXField () const
 
SIM_RawFieldgetYField () const
 
SIM_RawFieldgetZField () const
 
void setField (int axis, SIM_RawField *field)
 
bool hasNan () const
 True if we contain any NANs. More...
 
bool appearsToBeUnused () const
 
SIM_RawFieldstealField (int axis)
 
void testForNan () const
 
void pubHandleModification ()
 
void markGridAsChanged ()
 
void updateTotalVoxels ()
 
GU_ConstDetailHandle createSmokeRepresentation (const SIM_RootData &root) const
 Creates a GDP with us as a Volume Primitive inside it. More...
 
void addSmokeRepresentation (const SIM_RootData &root, GU_Detail *gdp) const
 
- Public Member Functions inherited from SIM_Data
const UT_StringgetDataType () const
 
void initialize (const SIM_SubdataBehavior &subdatabehavior)
 
void makeEqual (const SIM_Data *source, const SIM_SubdataBehavior &subdatabehavior)
 
void setParameters (const SIM_Options &parms)
 
void interpolate (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
int64 getMemorySize () const
 
bool getIsAlternateRepresentation () const
 
bool saveToFile (const char *filename, UT_CompressionType compressionType) const
 
bool saveToStream (std::ostream &os, UT_CompressionType compressionType) const
 
bool loadFromFile (const char *filename)
 
bool loadFromStream (UT_IStream &is, bool skiptype=false)
 
bool getIsOfType (const char *datatype) const
 
const voidgetConstPointerToType (const char *datatype) const
 
voidgetPointerToType (const char *datatype)
 
int getNumSubData () const
 Get the number of sub-data items attached to this data. More...
 
const char * getSubDataName (int index) const
 Get the name of the sub-data at a particular index location. More...
 
int getSubDataIndex (const SIM_Data *subdata) const
 
bool buildSubDataPath (const SIM_Data *subdata, UT_String &pathto) const
 
const SIM_QuerygetQueryObject () const
 
long getGuideParmVersion () const
 
void addGuideDep (DEP_MicroNode &src) const
 
virtual bool getGuideGeometryList (const SIM_RootData &root, const char *datapath, const SIM_Time &t, UT_Array< GU_ConstDetailHandle > &detailArray, UT_Array< UT_DMatrix4 > &xformArray) const
 
GU_ConstDetailHandle getGuideGeometry (const SIM_RootData &root, const char *datapath, UT_DMatrix4 &xform, const SIM_Time &t) const
 
void buildGuideOptions (SIM_Options &options, const SIM_Time &time) const
 
SIM_DatagetSubData (int index)
 
const SIM_DatagetConstSubData (int index) const
 
SIM_DatagetNamedSubData (const char *dataname)
 
const SIM_DatagetConstNamedSubData (const char *dataname) const
 
void filterSubData (SIM_DataArray &ncdp, UT_StringArray *names, const SIM_DataFilter &ncfilter, const char *startfrom, const SIM_DataFilter &recursefilter)
 
void filterConstSubData (SIM_ConstDataArray &dp, UT_StringArray *names, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatagetNthSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
const SIM_DatagetNthConstSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
void forEachSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
void forEachConstSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatacreateNamedSubData (const char *dataname, const char *datatype, int creationflags, UT_String *newdatanameptr=NULL)
 
SIM_DatagetOrCreateAlternateRepresentation (const char *dataname, const char *datatype) const
 
void interpolateSubData (const SIM_Data &source1, const SIM_Data &source2, fpreal interp, const SIM_DataFilter &interpdata, const SIM_DataFilter &recurse)
 
void setNamedSubData (const char *dataname, const SIM_Data *data, int setflags)
 
void createUniqueSubDataName (const SIM_Data *subdata, UT_String &dataname) const
 
void removeNamedSubData (const char *dataname)
 Remove some existing sub-data by name. More...
 
void removeSubData (int index)
 Remove some existing sub-data by index. More...
 
void moveNamedSubData (const char *oldname, const char *newname)
 
const UT_GuidgetUniqueId () const
 
long getReferenceCount () const
 
int getCreatorId () const
 Get the ID of the node that created this data. More...
 
OP_NodegetCreatorNode () const
 Use the creator ID to look up the OP_Node that created this data. More...
 
OP_NodegetOwnerNetwork () const
 Look up the owner node of our engine to get the DOP Network pointer. More...
 
const SIM_EnginegetEngine () const
 Get the engine that created us (from our data factory). More...
 
int getCreatorIndex () const
 Get the output index of the creator node that generated this data. More...
 
const SIM_TimegetCreationTime () const
 Get the creation time for this data. More...
 
bool getIsSelected () const
 Get the selected flag for this data. More...
 
void setIsSelected (bool selected) const
 
bool getSelectionRepresentsObject () const
 
void copyCreationInfoFrom (const SIM_Data *source)
 
OP_NodegetNodePathsRelativeTo () const
 
OP_NodegetOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
OBJ_NodegetOBJNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
SOP_NodegetSOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a SOP_Node. More...
 
POP_NodegetPOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a POP_Node. More...
 
DOP_NodegetDOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a DOP_Node. More...
 
COP2_NodegetCOP2Node (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a COP2_Node. More...
 
CHOP_NodegetCHOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a CHOP_Node. More...
 
void addOPInterest (OP_Node *node) const
 Adds an interest in the specified node to our engine's owner node. More...
 
void addError (const SIM_RootData *root, int errorcode, const char *errorparm, UT_ErrorSeverity severity) const
 Adds an error to our SIM_Engine. More...
 
- Public Member Functions inherited from SIM_OptionsUser
 SIM_OptionsUser (SIM_Data *owner)
 
virtual ~SIM_OptionsUser ()
 
void optionChanged (const char *name)
 
const SIM_OptionsgetOptions () const
 

Public Attributes

const UT_JobInfo &info const
 
const SIM_RawFieldpressure
 
const SIM_RawField const
SIM_RawField
surface
 
const SIM_RawField const
SIM_RawField const
SIM_RawIndexField
comp
 
const SIM_RawField const
SIM_RawField const
SIM_RawIndexField bool 
pressureBoundaryAtFace
 
const SIM_RawField const
SIM_RawField const
SIM_RawIndexField bool const
UT_JobInfo
info
 
const UT_JobInfoinfo
 
SIM_RawFielddiv
 
SIM_RawField const SIM_RawFieldpressureboundary
 
SIM_RawField const
SIM_RawField const
SIM_RawField
collision
 
SIM_RawField const
SIM_RawField const
SIM_RawField int 
compnum
 
SIM_RawField const
SIM_RawField const
SIM_RawField int const
SIM_RawIndexField
comp
 
SIM_RawField const
SIM_RawField const
SIM_RawField int const
SIM_RawIndexField const
UT_JobInfo &info 
const
 

Protected Member Functions

 SIM_VectorField (const SIM_DataFactory *factory)
 
virtual ~SIM_VectorField ()
 
virtual void initializeSubclass ()
 Overrides to properly implement this class as a SIM_Data. More...
 
virtual void makeEqualSubclass (const SIM_Data *source)
 myField aware copy constructor. More...
 
virtual void saveSubclass (std::ostream &os) const
 Saves our attributes, and our internal data if it has been set. More...
 
virtual bool loadSubclass (UT_IStream &is)
 Loads our attributes and internal data if it was set when we saved. More...
 
virtual int64 getMemorySizeSubclass () const
 
virtual void optionChangedSubclass (const char *name)
 Override the setDivisions to rebuild our voxel array on demand. More...
 
- Protected Member Functions inherited from SIM_Data
 SIM_Data (const SIM_DataFactory *factory)
 
virtual ~SIM_Data ()
 
void handleModification (int code=-1)
 
void setNeedsToRecalculateMemorySize () const
 
void deleteQueryObjectIfNotBuilding () const
 Deletes the query object for this data, if there is one. More...
 
void deleteGuideObjectIfNotBuilding () const
 Delete the guide geometry for this data, if it exists. More...
 
void initAlternateRepresentation () const
 
void setNeedsInitialization (bool needsinit) const
 Flags an alternate representation subdata as requiring initialization. More...
 
bool getNeedsInitialization () const
 Tests whether an alternate representation requires initialization. More...
 
bool saveOptionPacket (std::ostream &os, const char *name, const SIM_Options *opts) const
 
bool loadOptionPacket (UT_IStream &is, const char *name, SIM_Options *opts) const
 
bool getIsDoingSimplifiedSaveLoad () const
 
void initializeFromParmDefaults ()
 
void setSelectionRepresentsObject (bool representsobject)
 
virtual void setNeedsInitializationSubclass (bool needsinit) const
 
virtual void saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
virtual bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 
virtual long getGuideParmVersionSubclass () const
 
virtual SIM_GuidecreateGuideObjectSubclass () const
 
virtual void buildGuideGeometrySubclass (const SIM_RootData &root, const SIM_Options &options, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const
 
virtual void setParametersSubclass (const SIM_Options &parms)
 
virtual void setNamedSubDataSubclass (const char *dataname, const SIM_Data *data)
 
virtual void removeNamedSubDataSubclass (const char *dataname)
 
virtual void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
virtual void handleModificationSubclass (int code)
 
virtual bool getIsAlternateRepresentationSubclass () const
 
virtual void initAlternateRepresentationSubclass (const SIM_Data &)
 
virtual voidgetCastToType (const char *datatype) const
 
virtual const UT_StringgetDataTypeSubclass () const
 
const SIM_DatagetAlternateRepresentationOf () const
 
- Protected Member Functions inherited from SIM_OptionsUser
SIM_OptionsgetOptions ()
 

Additional Inherited Members

- Static Public Member Functions inherited from SIM_Data
static bool getDataTypeFromFile (const char *filename, UT_String &datatype)
 
static bool getDataTypeFromStream (UT_IStream &is, UT_String &datatype)
 
static const voidcastConstPointerToType (const SIM_Data *data, const char *datatype)
 
static voidcastPointerToType (SIM_Data *data, const char *datatype)
 
- Static Protected Member Functions inherited from SIM_Data
static const PRM_TemplategetEmptyTemplateList ()
 
static const SIM_DopDescriptiongetEmptyDopDescription ()
 A DOP description that says not to create an automatic DOP. More...
 
static void getDataTypeSuperclasses (UT_StringArray &)
 

Detailed Description

This class holds a three dimensional vector field.

Examples:
SIM/SIM_GasAdd.C.

Definition at line 34 of file SIM_VectorField.h.

Member Typedef Documentation

Definition at line 38 of file SIM_VectorField.h.

typedef void(* SIM_VectorField::ut_physParmCalc)(const UT_Vector3 &pos, void *vp, fpreal &bounce, fpreal &friction, fpreal &dynfriction)

Definition at line 305 of file SIM_VectorField.h.

typedef UT_Vector3(* SIM_VectorField::ut_velocityCalc)(const UT_Vector3 &pos, void *vp)

Definition at line 304 of file SIM_VectorField.h.

Constructor & Destructor Documentation

SIM_VectorField::SIM_VectorField ( const SIM_DataFactory factory)
explicitprotected
virtual SIM_VectorField::~SIM_VectorField ( )
protectedvirtual

Member Function Documentation

void SIM_VectorField::addSmokeRepresentation ( const SIM_RootData root,
GU_Detail gdp 
) const

Adds a volume primitive version of our field to the given gdp.

void SIM_VectorField::addToCell ( int  x,
int  y,
int  z,
const UT_Vector3 dv 
)

Adds a velocity to the given voxel. If this is face, it is divided in two and spread on each of 6 faces. If it is corner, it is divided by 8 and spread along each of 8 corners.

void SIM_VectorField::advect ( UT_Vector3 pos,
float  time,
float  cfl = 1.0f 
) const
inline

Treats this field as a velocity field and advects the given position for the given length of time. Uses first order explicit euler integration

Definition at line 182 of file SIM_VectorField.h.

void SIM_VectorField::advect ( const SIM_VectorField vel,
float  timestep,
const SIM_RawField collision,
SIM_FieldAdvection  advectmethod,
float  cfl 
)

Advects this field by the other given field. Handles the possibility that the other field is this field.

void SIM_VectorField::advect ( sim_PointVelocity  getVelocity,
float  timestep,
float  voxelsize,
const SIM_RawField collision = 0,
float  cfl = 1.0f 
)
void SIM_VectorField::advectMidpoint ( UT_Vector3 pos,
float  time,
float  cfl = 1.0f 
) const
inline

Uses second order explicit runge-kutta integration.

Definition at line 188 of file SIM_VectorField.h.

void SIM_VectorField::advectMinMax ( SIM_VectorField minfield,
SIM_VectorField maxfield,
const SIM_VectorField vel,
float  timestep,
const SIM_RawField collision,
SIM_FieldAdvection  advectmethod,
float  cfl 
)

Advects this by the velocity field, storing our min/max interpolants into the min/max fields

void SIM_VectorField::advectRK3 ( UT_Vector3 pos,
float  time,
float  cfl = 1.0f 
) const
inline

Uses third order explicit runge-kutta integration.

Definition at line 194 of file SIM_VectorField.h.

void SIM_VectorField::advectRK4 ( UT_Vector3 pos,
float  time,
float  cfl = 1.0f 
) const
inline

Uses fourth order explicit runge-kutta integration.

Definition at line 200 of file SIM_VectorField.h.

bool SIM_VectorField::appearsToBeUnused ( ) const
inline

True if we have a constant value. Ignores end conditions in determining this. Used as a rough guess that the field is unused.

Definition at line 391 of file SIM_VectorField.h.

GU_ConstDetailHandle SIM_VectorField::createSmokeRepresentation ( const SIM_RootData root) const

Creates a GDP with us as a Volume Primitive inside it.

void SIM_VectorField::distributeBoundaryDivergenceToSurfaceFace ( SIM_RawField div,
const SIM_RawField pressureboundary,
const SIM_RawField collision,
int  compnum,
const UT_VoxelArray< int64 > &  comp 
)

Distributes any divergence in the boundary condition among all voxels that are on the boundary of the pressureboundary but not on the collision boundary.

void SIM_VectorField::distributeBoundaryDivergenceToVolumeFace ( SIM_RawField div,
const SIM_RawField pressureboundary = 0,
int  compnum = -1,
const SIM_RawIndexField comp = 0 
)

Distributes any divergence in the boundary condition among all voxels equally.

void SIM_VectorField::enforceBoundary ( const SIM_ScalarField collision = 0,
const SIM_VectorField cvel = 0,
const SIM_VectorField bvel = 0,
const SIM_BoundaryLine worldbline = SIM_BoundaryLine() 
)

Enforces boundary conditions on the array. Boundary line should be given in world space

void SIM_VectorField::enforceVelBoundary ( const SIM_ScalarField collision,
ut_velocityCalc  calcVelocity,
void vvp,
ut_physParmCalc  calcPhysParms,
void vpp,
bool  forbidinterference,
const SIM_BoundaryLine worldbline = SIM_BoundaryLine() 
)

Enforces boundary conditions on a velocity field by making sure we are lifting from the surface, allowing tangential motion. forbidinterference keeps the normal enforcement behaviour of explicitly setting all side boundaries that have a inward pointing velocity to zero relative motion SIM_BoundaryLine is given in world space and allows for an open boundary to exist above a "line" in an otherwise closed boundary.

void SIM_VectorField::enforceVelBoundaryVariational ( const SIM_ScalarField collision,
const SIM_VectorField weights,
ut_velocityCalc  calcVelocity,
void vvp,
ut_physParmCalc  calcPhysParms,
void vpp,
bool  threadsafe,
fpreal  bandwidth 
)

Enforces boundary conditions on a velocity field by making sure we are lifting from the surface, allowing tangential motion. forbidinterference keeps the normal enforcement behaviour of explicitly setting all side boundaries that have a inward pointing velocity to zero relative motion.

void SIM_VectorField::enforceVelBoundaryVariationalAxisPartial ( enforceVelBoundaryVariationalParms parms,
const UT_JobInfo info 
)
void SIM_VectorField::getBBox ( UT_BoundingBox bbox) const

Controls the dimensions of where the field is properly defined in the field space.

UT_VoxelBorderType SIM_VectorField::getBorder ( ) const
inline

Definition at line 76 of file SIM_VectorField.h.

UT_Vector3 SIM_VectorField::getCellValue ( int  x,
int  y,
int  z 
) const

Gets the velocity at the given voxel location, interpolating if we have corner or face velocities.

UT_Vector3 SIM_VectorField::getCenter ( ) const
UT_Vector3 SIM_VectorField::getCurl ( const UT_Vector3 pos) const

Computes the curl at a given worldspace.

UT_Vector3 SIM_VectorField::getDivisions ( ) const

Calculate the size and divisions according to options such as 2d or equal sized voxels.

SIM_RawField* SIM_VectorField::getField ( int  axis) const
inline

Retrieve raw field.

Examples:
SIM/SIM_GasAdd.C.

Definition at line 375 of file SIM_VectorField.h.

UT_DMatrix3 SIM_VectorField::getGradient ( const UT_Vector3 pos) const

Computes the gradient of the vector field in world space..

virtual int64 SIM_VectorField::getMemorySizeSubclass ( ) const
protectedvirtual

Override this function to return an accurate representation of the amount of memory used by this piece of data. The size of subdata should not be included in this calculation.

Reimplemented from SIM_Data.

exint SIM_VectorField::getNumSlices ( ) const
inline

Definition at line 58 of file SIM_VectorField.h.

UT_Vector3 SIM_VectorField::getOrig ( ) const
inline

Definition at line 83 of file SIM_VectorField.h.

SIM_VectorField::GETSET_DATA_FUNCS_B ( SIM_NAME_TWOD  ,
TwoDField   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closedends"  ,
ClosedEnds   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closexneg"  ,
CloseXNeg   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closeyneg"  ,
CloseYNeg   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closezneg"  ,
CloseZNeg   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closexpos"  ,
CloseXPos   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closeypos"  ,
CloseYPos   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "closezpos"  ,
CloseZPos   
)
SIM_VectorField::GETSET_DATA_FUNCS_B ( "usefp16"  ,
UseFP16   
)
SIM_VectorField::GETSET_DATA_FUNCS_F ( "divsize"  ,
RawDivisionSize   
)
SIM_VectorField::GETSET_DATA_FUNCS_F ( SIM_NAME_TOLERANCE  ,
Tolerance   
)
SIM_VectorField::GETSET_DATA_FUNCS_I ( SIM_NAME_UNIFORMVOXELS  ,
UniformVoxels   
)

Control the number of divisions.

SIM_VectorField::GETSET_DATA_FUNCS_I ( SIM_NAME_VOXELPLANE  ,
VoxelPlane   
)
SIM_VectorField::GETSET_DATA_FUNCS_I ( "uniformdiv"  ,
RawUniformDivisions   
)
SIM_VectorField::GETSET_DATA_FUNCS_I ( "totalvoxels"  ,
TotalVoxels   
)
SIM_VectorField::GETSET_DATA_FUNCS_I ( SIM_NAME_VOXELSAMPLE  ,
VoxelSampleRaw   
)
SIM_VectorField::GETSET_DATA_FUNCS_I ( "border"  ,
RawBorder   
)
SIM_VectorField::GETSET_DATA_FUNCS_S ( SIM_NAME_POSITIONPATH  ,
PositionPath   
)

Accesses the relative path to the position data associated with this geometry.

SIM_VectorField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_DIV  ,
RawDivisions   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_CENTER  ,
RawCenter   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_SIZE  ,
RawSize   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( "slicediv"  ,
SliceDivisions   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( "sliceoverlapneg"  ,
SliceOverlapNeg   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( "sliceoverlappos"  ,
SliceOverlapPos   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( "totalvoxelres"  ,
TotalVoxelRes   
)
SIM_VectorField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_DIRECTION  ,
ExternalDirection   
)
UT_Vector3 SIM_VectorField::getSize ( ) const
UT_Vector3 SIM_VectorField::getValue ( const UT_Vector3 pos) const

Access the field value given a world space location. This does trilinear interpolation.

fpreal SIM_VectorField::getVoxelDiameter ( int  axis) const
inline

Definition at line 151 of file SIM_VectorField.h.

SIM_FieldSample SIM_VectorField::getVoxelSample ( int  axis) const
const UT_Vector3& SIM_VectorField::getVoxelSize ( int  axis) const
inline

Definition at line 150 of file SIM_VectorField.h.

UT_Vector3 SIM_VectorField::getVoxelSize ( ) const
inline

Definition at line 153 of file SIM_VectorField.h.

SIM_RawField* SIM_VectorField::getXField ( ) const
inline

Definition at line 376 of file SIM_VectorField.h.

SIM_RawField* SIM_VectorField::getYField ( ) const
inline

Definition at line 377 of file SIM_VectorField.h.

SIM_RawField* SIM_VectorField::getZField ( ) const
inline

Definition at line 378 of file SIM_VectorField.h.

bool SIM_VectorField::hasNan ( ) const
inline

True if we contain any NANs.

Definition at line 385 of file SIM_VectorField.h.

bool SIM_VectorField::indexToPos ( int  axis,
int  x,
int  y,
int  z,
UT_Vector3 pos 
) const

Converts an integer index into a worldspace position.

virtual void SIM_VectorField::initializeSubclass ( )
protectedvirtual

Overrides to properly implement this class as a SIM_Data.

Reimplemented from SIM_Data.

bool SIM_VectorField::isAligned ( const SIM_ScalarField field) const
bool SIM_VectorField::isAligned ( const SIM_MatrixField field) const
bool SIM_VectorField::isAligned ( const SIM_VectorField field) const

True if we are component-wise aligned, our x/y/z fields may still be unaligned with respect to each other.

bool SIM_VectorField::isAligned ( const SIM_RawField field) const
bool SIM_VectorField::isCenterSampled ( ) const
inline

Definition at line 138 of file SIM_VectorField.h.

bool SIM_VectorField::isFaceSampled ( ) const
inline

Definition at line 133 of file SIM_VectorField.h.

bool SIM_VectorField::isMatching ( const SIM_VectorField field) const
inline

Determines if we match in terms of voxel cells - same bounding box and number of cells. Due to sampling, this does not mean the sample points will match Because our internal fields are always matching by definition, we can just test the first field.

Definition at line 130 of file SIM_VectorField.h.

bool SIM_VectorField::isSelfAligned ( ) const
inline

True if our internal fields are aligned.

Definition at line 144 of file SIM_VectorField.h.

virtual bool SIM_VectorField::loadSubclass ( UT_IStream is)
protectedvirtual

Loads our attributes and internal data if it was set when we saved.

Reimplemented from SIM_Data.

virtual void SIM_VectorField::makeEqualSubclass ( const SIM_Data source)
protectedvirtual

myField aware copy constructor.

Reimplemented from SIM_Data.

void SIM_VectorField::markGridAsChanged ( )
inline

Definition at line 410 of file SIM_VectorField.h.

void SIM_VectorField::matchField ( const SIM_ScalarField field)

Match this field to the given reference field. We will end up with the same size/divisions/twod/uniform, but not the same sampling pattern

void SIM_VectorField::matchField ( const SIM_VectorField field,
bool  matchsample = false 
)
void SIM_VectorField::matchField ( const SIM_MatrixField field)
void SIM_VectorField::matchField ( const SIM_IndexField field)
void SIM_VectorField::matchVDB ( const GEO_PrimVDB vdb,
const UT_DMatrix4 xform 
)
void SIM_VectorField::matchVolume ( const GEO_PrimVolume vol,
const UT_DMatrix4 xform 
)
virtual void SIM_VectorField::optionChangedSubclass ( const char *  name)
protectedvirtual

Override the setDivisions to rebuild our voxel array on demand.

Reimplemented from SIM_OptionsUser.

bool SIM_VectorField::posToIndex ( int  axis,
const UT_Vector3 pos,
int x,
int y,
int z 
) const

Converts a worldspace position into an integer index.

void SIM_VectorField::projectToNonDivergent ( const SIM_RawField pressureboundary = 0,
const SIM_RawField collision = 0,
SIM_RawField pressureout = 0,
bool  preservebubble = true,
const SIM_RawField goaldiv = 0,
SIM_RawIndexField compout = 0,
bool  ghostfluid = true,
bool  variational = true,
SIM_RawField::PCG_METHOD  pcgmethod = SIM_RawField::PCG_MIC,
int  numiterforcenter = 20 
)

Projects the field into the space of non-divergent fields. All divergent components of this field are removed.

void SIM_VectorField::projectToNonDivergentCenter ( const SIM_RawField pressureboundary,
const SIM_RawField goaldiv,
int  numiter 
)
void SIM_VectorField::projectToNonDivergentFace ( const SIM_RawField pressureboundary,
const SIM_RawField collision,
SIM_RawField pressureout = 0,
bool  preservebubble = true,
const SIM_RawField goaldiv = 0,
SIM_RawIndexField compout = 0,
bool  ghostfluid = true,
bool  variational = true,
SIM_RawField::PCG_METHOD  pcgmethod = SIM_RawField::PCG_MIC 
)
void SIM_VectorField::pubHandleModification ( )
inline
Examples:
SIM/SIM_GasAdd.C.

Definition at line 404 of file SIM_VectorField.h.

void SIM_VectorField::resizeKeepData ( const UT_Vector3 size,
const UT_Vector3 center,
bool  keepdata,
const char *  address = 0,
int  port = -1 
)

Resizes our field keeping our field data. The final size will be an integer number of voxels matching our current voxel size. The final center will be an integer number of voxel offset from our current center. This allows us to do a perfect copy of the data.

virtual void SIM_VectorField::saveSubclass ( std::ostream &  os) const
protectedvirtual

Saves our attributes, and our internal data if it has been set.

Reimplemented from SIM_Data.

void SIM_VectorField::setBorder ( UT_VoxelBorderType  border)
inline

Definition at line 77 of file SIM_VectorField.h.

void SIM_VectorField::setCenter ( const UT_Vector3 div)
void SIM_VectorField::setDivisions ( const UT_Vector3 div)

Adjusts the size/divisions of this field, overriding and twod or uniform voxel settings.

void SIM_VectorField::setField ( int  axis,
SIM_RawField field 
)

Sets the field to the given field, gaining ownership of it. The new field must already match the field it will replace.

void SIM_VectorField::setSize ( const UT_Vector3 div)
void SIM_VectorField::setVoxelSize ( const UT_Vector3 voxelsize)
inline

Definition at line 154 of file SIM_VectorField.h.

SIM_RawField* SIM_VectorField::stealField ( int  axis)

Steals the field, replacing this copy with an empty field and returning the old version.

void SIM_VectorField::testForNan ( ) const
SIM_VectorField::THREADED_METHOD1 ( SIM_VectorField  ,
getField(0) ->shouldMultiThread()  ,
applyPressureGradientCenter  ,
const SIM_RawField ,
pressure   
) const
SIM_VectorField::THREADED_METHOD1 ( SIM_VectorField  ,
getField(0) ->shouldMultiThread()  ,
applyPressureGradientCorner  ,
const SIM_RawField ,
pressure   
) const
SIM_VectorField::THREADED_METHOD1 ( SIM_VectorField  ,
parms.u->  shouldMultiThread(),
enforceVelBoundaryVariationalAxis  ,
enforceVelBoundaryVariationalParms ,
parms   
)
SIM_VectorField::THREADED_METHOD1_CONST ( SIM_VectorField  ,
getField(0) ->shouldMultiThread()  ,
buildDivergenceCenter  ,
SIM_RawField ,
div   
)

Evaluates the divergence field for this velocity field.

SIM_VectorField::THREADED_METHOD1_CONST ( SIM_VectorField  ,
getField(0) ->shouldMultiThread()  ,
buildDivergenceCorner  ,
SIM_RawField ,
div   
)

Evaluates the divergence field for this velocity field.

SIM_VectorField::THREADED_METHOD5 ( SIM_VectorField  ,
getField(axis) ->shouldMultiThread()  ,
applyPressureGradientFace  ,
int  ,
axis  ,
const SIM_RawField ,
pressure  ,
const SIM_RawField ,
surface  ,
const SIM_RawIndexField ,
comp  ,
bool  ,
pressureBoundaryAtFace   
)

Applies a pressure differential to the given component of our velocity field

SIM_VectorField::THREADED_METHOD6_CONST ( SIM_VectorField  ,
div.  shouldMultiThread(),
hasSurfaceCell  ,
bool *  ,
result  ,
SIM_RawField ,
div  ,
const SIM_RawField ,
pressureboundary  ,
const SIM_RawField ,
collision  ,
int  ,
compnum  ,
const SIM_RawIndexField ,
comp   
)

Determines if the given component has any surface cells. result should be preloaded with false.

void SIM_VectorField::updateTotalVoxels ( )

Recomputes total number of voxels to be stored on our options data for ease of reading

Member Data Documentation

SIM_RawField const SIM_RawField const SIM_RawField* SIM_VectorField::collision

Definition at line 290 of file SIM_VectorField.h.

Definition at line 255 of file SIM_VectorField.h.

Definition at line 290 of file SIM_VectorField.h.

Definition at line 290 of file SIM_VectorField.h.

const UT_JobInfo &info SIM_VectorField::const

Definition at line 236 of file SIM_VectorField.h.

SIM_RawField const SIM_RawField const SIM_RawField int const SIM_RawIndexField const UT_JobInfo& info SIM_VectorField::const

Definition at line 290 of file SIM_VectorField.h.

SIM_RawField& SIM_VectorField::div

Definition at line 290 of file SIM_VectorField.h.

const UT_JobInfo & SIM_VectorField::info

Definition at line 255 of file SIM_VectorField.h.

const UT_JobInfo& SIM_VectorField::info

Definition at line 267 of file SIM_VectorField.h.

const SIM_RawField* SIM_VectorField::pressure

Definition at line 255 of file SIM_VectorField.h.

SIM_RawField const SIM_RawField* SIM_VectorField::pressureboundary

Definition at line 290 of file SIM_VectorField.h.

const SIM_RawField const SIM_RawField const SIM_RawIndexField bool SIM_VectorField::pressureBoundaryAtFace

Definition at line 255 of file SIM_VectorField.h.

const SIM_RawField const SIM_RawField* SIM_VectorField::surface

Definition at line 255 of file SIM_VectorField.h.


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