doxygen: intern/smoke tagged.
[blender.git] / intern / smoke / intern / tnt / tnt_fortran_array3d.h
1 /** \file smoke/intern/tnt/tnt_fortran_array3d.h
2  *  \ingroup smoke
3  */
4 /*
5 *
6 * Template Numerical Toolkit (TNT): Three-dimensional Fortran numerical array
7 *
8 * Mathematical and Computational Sciences Division
9 * National Institute of Technology,
10 * Gaithersburg, MD USA
11 *
12 *
13 * This software was developed at the National Institute of Standards and
14 * Technology (NIST) by employees of the Federal Government in the course
15 * of their official duties. Pursuant to title 17 Section 105 of the
16 * United States Code, this software is not subject to copyright protection
17 * and is in the public domain. NIST assumes no responsibility whatsoever for
18 * its use by other parties, and makes no guarantees, expressed or implied,
19 * about its quality, reliability, or any other characteristic.
20 *
21 */
22
23
24
25 #ifndef TNT_FORTRAN_ARRAY3D_H
26 #define TNT_FORTRAN_ARRAY3D_H
27
28 #include <cstdlib>
29 #include <iostream>
30 #ifdef TNT_BOUNDS_CHECK
31 #include <assert.h>
32 #endif
33 #include "tnt_i_refvec.h"
34
35 namespace TNT
36 {
37
38 template <class T>
39 class Fortran_Array3D 
40 {
41
42
43   private: 
44
45
46                 i_refvec<T> v_;
47                 int m_;
48                 int n_;
49                 int k_;
50                 T* data_;
51
52   public:
53
54     typedef         T   value_type;
55
56                Fortran_Array3D();
57                Fortran_Array3D(int m, int n, int k);
58                Fortran_Array3D(int m, int n, int k,  T *a);
59                Fortran_Array3D(int m, int n, int k, const T &a);
60     inline Fortran_Array3D(const Fortran_Array3D &A);
61         inline Fortran_Array3D & operator=(const T &a);
62         inline Fortran_Array3D & operator=(const Fortran_Array3D &A);
63         inline Fortran_Array3D & ref(const Fortran_Array3D &A);
64                Fortran_Array3D copy() const;
65                    Fortran_Array3D & inject(const Fortran_Array3D & A);
66         inline T& operator()(int i, int j, int k);
67         inline const T& operator()(int i, int j, int k) const ;
68         inline int dim1() const;
69         inline int dim2() const;
70         inline int dim3() const;
71         inline int ref_count() const;
72                ~Fortran_Array3D();
73
74
75 };
76
77 template <class T>
78 Fortran_Array3D<T>::Fortran_Array3D() :  v_(), m_(0), n_(0), k_(0), data_(0) {}
79
80
81 template <class T>
82 Fortran_Array3D<T>::Fortran_Array3D(const Fortran_Array3D<T> &A) : 
83         v_(A.v_), m_(A.m_), n_(A.n_), k_(A.k_), data_(A.data_) {}
84
85
86
87 template <class T>
88 Fortran_Array3D<T>::Fortran_Array3D(int m, int n, int k) : 
89         v_(m*n*k), m_(m), n_(n), k_(k), data_(v_.begin()) {}
90
91
92
93 template <class T>
94 Fortran_Array3D<T>::Fortran_Array3D(int m, int n, int k, const T &val) : 
95         v_(m*n*k), m_(m), n_(n), k_(k), data_(v_.begin())
96 {
97         for (T* p = data_; p < data_ + m*n*k; p++)
98                 *p = val;
99 }
100
101 template <class T>
102 Fortran_Array3D<T>::Fortran_Array3D(int m, int n, int k, T *a) : 
103         v_(a), m_(m), n_(n), k_(k), data_(v_.begin()) {}
104
105
106
107
108 template <class T>
109 inline T& Fortran_Array3D<T>::operator()(int i, int j, int k) 
110
111 #ifdef TNT_BOUNDS_CHECK
112         assert(i >= 1);
113         assert(i <= m_);
114         assert(j >= 1);
115         assert(j <= n_);
116         assert(k >= 1);
117         assert(k <= k_);
118 #endif
119
120         return data_[(k-1)*m_*n_ + (j-1) * m_ + i-1];
121
122 }
123
124 template <class T>
125 inline const T& Fortran_Array3D<T>::operator()(int i, int j, int k)  const
126
127 #ifdef TNT_BOUNDS_CHECK
128         assert(i >= 1);
129         assert(i <= m_);
130         assert(j >= 1);
131         assert(j <= n_);
132         assert(k >= 1);
133         assert(k <= k_);
134 #endif
135
136         return data_[(k-1)*m_*n_ + (j-1) * m_ + i-1];
137 }
138
139
140 template <class T>
141 Fortran_Array3D<T> & Fortran_Array3D<T>::operator=(const T &a)
142 {
143
144         T *end = data_ + m_*n_*k_;
145
146         for (T *p=data_; p != end; *p++ = a);
147
148         return *this;
149 }
150
151 template <class T>
152 Fortran_Array3D<T> Fortran_Array3D<T>::copy() const
153 {
154
155         Fortran_Array3D B(m_, n_, k_);
156         B.inject(*this);
157         return B;
158         
159 }
160
161
162 template <class T>
163 Fortran_Array3D<T> & Fortran_Array3D<T>::inject(const Fortran_Array3D &A)
164 {
165
166         if (m_ == A.m_ && n_ == A.n_ && k_ == A.k_)
167         {
168                 T *p = data_;
169                 T *end = data_ + m_*n_*k_;
170                 const T* q = A.data_;
171                 for (; p < end; *p++ =  *q++);
172         }
173         return *this;
174 }
175
176
177
178
179 template <class T>
180 Fortran_Array3D<T> & Fortran_Array3D<T>::ref(const Fortran_Array3D<T> &A)
181 {
182
183         if (this != &A)
184         {
185                 v_ = A.v_;
186                 m_ = A.m_;
187                 n_ = A.n_;
188                 k_ = A.k_;
189                 data_ = A.data_;
190         }
191         return *this;
192 }
193
194 template <class T>
195 Fortran_Array3D<T> & Fortran_Array3D<T>::operator=(const Fortran_Array3D<T> &A)
196 {
197         return ref(A);
198 }
199
200 template <class T>
201 inline int Fortran_Array3D<T>::dim1() const { return m_; }
202
203 template <class T>
204 inline int Fortran_Array3D<T>::dim2() const { return n_; }
205
206 template <class T>
207 inline int Fortran_Array3D<T>::dim3() const { return k_; }
208
209
210 template <class T>
211 inline int Fortran_Array3D<T>::ref_count() const 
212
213         return v_.ref_count(); 
214 }
215
216 template <class T>
217 Fortran_Array3D<T>::~Fortran_Array3D()
218 {
219 }
220
221
222 } /* namespace TNT */
223
224 #endif
225 /* TNT_FORTRAN_ARRAY3D_H */
226