Overture  Version 25
GridFunctionParameters.h
Go to the documentation of this file.
1 #ifndef GRID_FUNCTION_PARAMETERS_H
2 #define GRID_FUNCTION_PARAMETERS_H
3 
4 class GridFunctionParameters
5 {
6 public:
7 
8  // Here we define all the enums related to GridFunctionType's
9  enum GridFunctionType
10  {
11  defaultCentering=-1,
12  general,
13  vertexCentered,
14  cellCentered,
15  faceCenteredAll,
16  faceCenteredAxis1,
17  faceCenteredAxis2,
18  faceCenteredAxis3,
19  faceCentered, // for unstructured grids
20  edgeCentered // for unstructured grids
21  };
22 
23  enum GridFunctionTypeWithComponents
24  {
25  generalWith0Components,
26  generalWith1Component,
27  generalWith2Components,
28  generalWith3Components,
29  generalWith4Components,
30  generalWith5Components,
31 
32  vertexCenteredWith0Components,
33  vertexCenteredWith1Component,
34  vertexCenteredWith2Components,
35  vertexCenteredWith3Components,
36  vertexCenteredWith4Components,
37  vertexCenteredWith5Components,
38 
39  cellCenteredWith0Components,
40  cellCenteredWith1Component,
41  cellCenteredWith2Components,
42  cellCenteredWith3Components,
43  cellCenteredWith4Components,
44  cellCenteredWith5Components,
45 
46  faceCenteredAllWith0Components,
47  faceCenteredAllWith1Component,
48  faceCenteredAllWith2Components,
49  faceCenteredAllWith3Components,
50  faceCenteredAllWith4Components,
51  faceCenteredAllWith5Components,
52 
53  faceCenteredAxis1With0Components,
54  faceCenteredAxis1With1Component,
55  faceCenteredAxis1With2Components,
56  faceCenteredAxis1With3Components,
57  faceCenteredAxis1With4Components,
58  faceCenteredAxis1With5Components,
59 
60  faceCenteredAxis2With0Components,
61  faceCenteredAxis2With1Component,
62  faceCenteredAxis2With2Components,
63  faceCenteredAxis2With3Components,
64  faceCenteredAxis2With4Components,
65  faceCenteredAxis2With5Components,
66 
67  faceCenteredAxis3With0Components,
68  faceCenteredAxis3With1Component,
69  faceCenteredAxis3With2Components,
70  faceCenteredAxis3With3Components,
71  faceCenteredAxis3With4Components,
72  faceCenteredAxis3With5Components
73  };
74 
75  enum faceCenteringType // Here are some standard types of face centred grid functions
76  {
77  none=-1, // not face centred
78  direction0=0, // all components are face centred along direction (i.e. axis) = 0
79  direction1=1, // all components are face centred along direction (i.e. axis) = 1
80  direction2=2, // all components are face centred along direction (i.e. axis) = 2
81  all=-2, // components are face centred in all directions, positionOfFaceCentering determines
82  // the Index position that is used for the "directions"
83  faceCenteredUnstructured=3, // face centered on an unstructured grid
84  edgeCenteredUnstructured=4 // edge centered on an unstructured grid
85  };
86 
87 
88  GridFunctionType inputType, // type of the input grid function (for Coefficient matrices)
89  outputType; // type for the result
90 
91  GridFunctionParameters();
92  ~GridFunctionParameters();
93 
94  // This constructors cast a GridFunctionType into a GridFunctionParameter object with outputType=type
95  GridFunctionParameters(const GridFunctionType & type);
96 
97  // convert a GridFunctionParameters object into a GridFunctionType
98  operator GridFunctionType () const;
99 
100 };
101 
102 #endif
Generated on Fri Jan 4 2013 10:17:53 for Overture by   doxygen 1.8.3