HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GAS_Viscosity.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_Viscosity.h ( GAS Library, C++)
7  *
8  * COMMENTS:
9  */
10 
11 #ifndef __GAS_Viscosity_h__
12 #define __GAS_Viscosity_h__
13 
14 #include "GAS_SubSolver.h"
15 #include "GAS_Utils.h"
17 
18 class SIM_VectorField;
19 class SIM_RawField;
20 class SIM_ScalarField;
21 class SIM_RawIndexField;
22 
23 template<typename T>
25 
27 {
28 public:
29  /// These macros are used to create the accessors
30  /// getFieldDstName and getFieldSrcName functions we'll use
31  /// to access our data options.
35  GET_DATA_FUNC_F("minviscosity", MinViscosity);
36  GET_DATA_FUNC_F("extrapdist", ExtrapolationDistance);
37  GET_DATA_FUNC_I("numsupersamples", NumSuperSamples);
38  GET_DATA_FUNC_I("floatprecision", FloatPrecision);
39  GET_DATA_FUNC_B("usepreconditioner", UsePreconditioner);
40  GET_DATA_FUNC_B(SIM_NAME_OPENCL, UseOpenCL);
41  GET_DATA_FUNC_I("maxsolveriterations", MaxSolverIterations);
42 
43  GET_DATA_FUNC_B("collisionweighttoggle", UseComputeCollisionWeights);
44 
45  GET_DATA_FUNC_F("waterline",Waterline);
46  GET_DATA_FUNC_B("usewaterline",UseWaterline);
47  GET_DATA_FUNC_V3("waterlinedirection",WaterlineDirection);
48 
51 
52 protected:
53  explicit GAS_Viscosity(const SIM_DataFactory *factory);
54  virtual ~GAS_Viscosity();
55 
56  /// The overloaded callback that GAS_SubSolver will invoke to
57  /// perform our actual computation. We are giving a single object
58  /// at a time to work on.
59  virtual bool solveGasSubclass(SIM_Engine &engine,
60  SIM_Object *obj,
61  SIM_Time time,
62  SIM_Time timestep);
63 
64  virtual void initializeSubclass();
65 
66 
67 private:
68  /// We define this to be a DOP_Auto node which means we do not
69  /// need to implement a DOP_Node derivative for this data. Instead,
70  /// this description is used to define the interface.
71  static const SIM_DopDescription *getDopDescription();
72 
73  /// These macros are necessary to bind our node to the factory and
74  /// ensure useful constants like BaseClass are defined.
78  "Gas Viscosity",
79  getDopDescription());
80 
81 };
82 
83 
84 #endif
85 
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
#define SIM_NAME_TOLERANCE
Definition: SIM_Names.h:201
#define GET_DATA_FUNC_V3(DataName, FuncName)
GT_API const UT_StringHolder time
#define GAS_NAME_USETIMESTEP
Definition: GAS_Utils.h:37
#define GAS_API
Definition: GAS_API.h:10
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 GET_DATA_FUNC_I(DataName, FuncName)
#define GET_DATA_FUNC_B(DataName, FuncName)
#define SIM_NAME_SCALE
Definition: SIM_Names.h:182
#define GET_DATA_FUNC_F(DataName, FuncName)
This class holds a three dimensional scalar field.
#define SIM_NAME_OPENCL
Definition: SIM_Names.h:221
#define GAS_NAME_TIMESCALE
Definition: GAS_Utils.h:38
This class holds a three dimensional vector field.
#define GET_DATA_FUNC_S(DataName, FuncName)
virtual void initializeSubclass()