HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GAS_MatchField.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_MatchField.h ( GAS Library, C++)
7  *
8  * COMMENTS:
9  */
10 
11 #ifndef __GAS_MatchField__
12 #define __GAS_MatchField__
13 
14 #include "SIMZ_API.h"
15 
17 #include <GU/GU_Detail.h>
18 
19 #include <GAS/GAS_SubSolver.h>
20 #include <GAS/GAS_Utils.h>
21 
22 class GU_Detail;
23 class SIM_VectorField;
24 class SIM_IndexField;
25 
27 {
28 public:
29  GET_DATA_FUNC_S(GAS_NAME_FIELD, FieldName);
30  GET_DATA_FUNC_S("reffield", RefFieldName);
31  GET_DATA_FUNC_S("refsoppath", RefSopPath);
32 
33  GET_DATA_FUNC_I("rank", Rank);
34  GET_DATA_FUNC_I("border", Border);
35  GET_DATA_FUNC_B("matchsamples", MatchSamples);
36 
37 protected:
38  explicit GAS_MatchField(const SIM_DataFactory *factory);
39  virtual ~GAS_MatchField();
40 
41  /// Builds a field that matches the reference field.
42  virtual bool solveGasSubclass(SIM_Engine &engine,
43  SIM_Object *obj,
44  SIM_Time time,
45  SIM_Time timestep);
46 
47 private:
48  static const SIM_DopDescription *getDopDescription();
49 
53  "Gas MatchField",
54  getDopDescription());
55 };
56 
57 #endif
#define SIMZ_API
Definition: SIMZ_API.h:10
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
virtual bool solveGasSubclass(SIM_Engine &engine, SIM_Object *obj, SIM_Time time, SIM_Time timestep)=0
This class holds a three dimensional scalar field.
#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)
This class holds a three dimensional vector field.
#define GET_DATA_FUNC_S(DataName, FuncName)