HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GAS_ProjectNonDivergent.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: GAS_ProjectNonDivergent.h ( GAS Library, C++)
7  *
8  * COMMENTS:
9  */
10 
11 #ifndef __GAS_ProjectNonDivergent__
12 #define __GAS_ProjectNonDivergent__
13 
14 #include "GAS_API.h"
15 
17 #include <GU/GU_Detail.h>
18 
19 #include "GAS_SubSolver.h"
20 #include "GAS_Utils.h"
21 
22 class GU_Detail;
23 class SIM_VectorField;
24 
26 {
27 public:
28  GET_DATA_FUNC_S(GAS_NAME_FIELD, FieldName);
29  GET_DATA_FUNC_S(GAS_NAME_GEOMETRY, GeometryName);
30  GET_DATA_FUNC_S(GAS_NAME_COLLISION, CollisionName);
31  GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);
32  GET_DATA_FUNC_S(GAS_NAME_PRESSURE, PressureName);
33  GET_DATA_FUNC_S(GAS_NAME_DIVERGENCE, DivergenceName);
34  GET_DATA_FUNC_S("component", ComponentName);
35  GET_DATA_FUNC_B("preservebubble", PreserveBubble);
36  GET_DATA_FUNC_B("ghostfluid", GhostFluid);
37  GET_DATA_FUNC_B("variational", Variational);
38  GET_DATA_FUNC_I("preconditioner", Preconditioner);
39  GET_DATA_FUNC_I("numiter", NumIterations);
40 
41 protected:
42  explicit GAS_ProjectNonDivergent(const SIM_DataFactory *factory);
43  virtual ~GAS_ProjectNonDivergent();
44 
45  /// Moves the fields given by FieldName by the given velocity
46  /// field. Moves the points given by GeometryName likewise.
47  virtual bool solveGasSubclass(SIM_Engine &engine,
48  SIM_Object *obj,
49  SIM_Time time,
50  SIM_Time timestep);
51 
52  /// Projects the field in the specific case of particles.
53  void projectToNonDivergent(GU_Detail *gdp);
54 
55 private:
56  static const SIM_DopDescription *getDopDescription();
57 
61  "Gas ProjectNonDivergent",
62  getDopDescription());
63 };
64 
65 #endif
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
#define GAS_NAME_GEOMETRY
Definition: GAS_Utils.h:28
#define GAS_NAME_DIVERGENCE
Definition: GAS_Utils.h:24
GT_API const UT_StringHolder time
#define GAS_API
Definition: GAS_API.h:10
#define GAS_NAME_COLLISION
Definition: GAS_Utils.h:19
virtual bool solveGasSubclass(SIM_Engine &engine, SIM_Object *obj, SIM_Time time, SIM_Time timestep)=0
#define GAS_NAME_VELOCITY
Definition: GAS_Utils.h:40
#define DECLARE_DATAFACTORY(DataClass, SuperClass, Description, DopParms)
Definition: SIM_DataUtils.h:58
#define GAS_NAME_FIELD
Definition: GAS_Utils.h:25
#define GET_DATA_FUNC_I(DataName, FuncName)
#define GET_DATA_FUNC_B(DataName, FuncName)
#define GAS_NAME_PRESSURE
Definition: GAS_Utils.h:31
This class holds a three dimensional vector field.
#define GET_DATA_FUNC_S(DataName, FuncName)