Overture  Version 25
InterpolateParameters.h
Go to the documentation of this file.
1 #ifndef InterpolateParameters_h
2 #define InterpolateParameters_h
3 
4 #include <Overture.h>
5 #include <NameList.h>
6 //#include <AMR++.h>
7 
8 class InterpolateParameters
9 {
10  public:
11 
12  InterpolateParameters (const int numberFOfDimensions_=2, const bool debug_ = LogicalFalse);
13  ~InterpolateParameters();
14 
15  enum InterpolateType
16  {
17  defaultValue,
18  polynomial,
19  fullWeighting,
20  nearestNeighbor,
21  injection,
22  numberOfInterpolateTypes
23  };
24 
25  enum InterpolateOffsetDirection
26  {
27  offsetInterpolateToLeft,
28  offsetInterpolateToRight,
29  numberOfInterpolateOffsetDirections
30  };
31 
32  int interactivelySetParameters ();
33 
34  void display () const;
35 
36  int get( const GenericDataBase & dir, const aString & name);
37 
38  int put( GenericDataBase & dir, const aString & name) const;
39 
40  static const int defaultAmrRefinementRatio;
41  static const GridFunctionParameters::GridFunctionType defaultGridCentering;
42  static const InterpolateParameters::InterpolateType defaultInterpolateType;
43  static const int defaultInterpolateOrder;
44  static const int defaultMaxRefinementRatio;
45  static const int defaultNumberOfDimensions;
46  static const real coeffEps;
47  static const InterpolateOffsetDirection defaultInterpolateOffsetDirection;
48 
49  bool debug;
50 
51  protected:
52  //...class data is protected; use access functions to get or set values
53 
54  IntegerArray amrRefinementRatio__;
55  int maxRefinementRatio__;
56  int numberOfDimensions__;
57  GridFunctionParameters::GridFunctionType gridCentering__;
58  InterpolateType interpolateType__;
59  int interpolateOrder__;
60 
61 //bool preComputeAllCoefficients__;
62  bool useGeneralInterpolationFormula__;
63 
64  public:
65  //...class member access functions
66 
67  void setAmrRefinementRatio (const IntegerArray& amrRefinementRatio_);
68  void setNumberOfDimensions (const int numberOfDimensions_=defaultNumberOfDimensions);
69 
70  void setInterpolateType (const InterpolateParameters::InterpolateType interpolateType_ =
71  InterpolateParameters::defaultInterpolateType);
72  void setInterpolateOrder (const int interpolateOrder_ =
73  InterpolateParameters::defaultInterpolateOrder);
74  void setGridCentering (const GridFunctionParameters::GridFunctionType gridCentering_ =
75  InterpolateParameters::defaultGridCentering);
76 //void setPreComputeAllCoefficients (const bool TrueOrFalse = LogicalFalse);
77  void setUseGeneralInterpolationFormula (const bool TrueOrFalse = LogicalFalse);
78 
79 
80  int amrRefinementRatio (const int axis) const { return amrRefinementRatio__(axis);};
81  GridFunctionParameters::GridFunctionType gridCentering () const { return gridCentering__;};
82  InterpolateType interpolateType () const { return interpolateType__;};
83  int interpolateOrder () const { return interpolateOrder__;};
84  int numberOfDimensions () const { return numberOfDimensions__;};
85  bool useGeneralInterpolationFormula () const { return useGeneralInterpolationFormula__;};
86 
87 
88  NameList nl;
89 };
90 
91 #endif
92 
93 
94 
95 
96 
97 
98 
99 
100 
101 
102 
103 
Generated on Fri Jan 4 2013 10:17:54 for Overture by   doxygen 1.8.3