scalarfield.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2011 Taneli Kalvas. All rights reserved.
6  *
7  * You can redistribute this software and/or modify it under the terms
8  * of the GNU General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * This library is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this library (file "COPYING" included in the package);
19  * if not, write to the Free Software Foundation, Inc., 51 Franklin
20  * Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  * If you have questions about your rights to use or distribute this
23  * software, please contact Berkeley Lab's Technology Transfer
24  * Department at TTD@lbl.gov. Other questions, comments and bug
25  * reports should be sent directly to the author via email at
26  * taneli.kalvas@jyu.fi.
27  *
28  * NOTICE. This software was developed under partial funding from the
29  * U.S. Department of Energy. As such, the U.S. Government has been
30  * granted for itself and others acting on its behalf a paid-up,
31  * nonexclusive, irrevocable, worldwide license in the Software to
32  * reproduce, prepare derivative works, and perform publicly and
33  * display publicly. Beginning five (5) years after the date
34  * permission to assert copyright is obtained from the U.S. Department
35  * of Energy, and subject to any subsequent five (5) year renewals,
36  * the U.S. Government is granted for itself and others acting on its
37  * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
38  * the Software to reproduce, prepare derivative works, distribute
39  * copies to the public, perform publicly and display publicly, and to
40  * permit others to do so.
41  */
42 
43 #ifndef SCALARFIELD_HPP
44 #define SCALARFIELD_HPP 1
45 
46 
47 #include <iostream>
48 #include "geometry.hpp"
49 #include "vec3d.hpp"
50 
51 
70 class ScalarField : public Mesh {
71  double *_F;
75  void check_definition();
76 
77 public:
78 
79 
87  ScalarField();
88 
95  ScalarField( const Mesh &m );
96 
103 
106  ScalarField( std::istream &s );
107 
110  ScalarField( const ScalarField &f );
111 
114  ~ScalarField();
115 
118  void clear();
119 
125  void reset( geom_mode_e geom_mode, Int3D size, Vec3D origo, double h );
126 
135  void get_minmax( double &min, double &max ) const;
136 
144  void epot_get_minmax( const Geometry &g, double &min, double &max ) const;
145 
148  ScalarField &operator=( const ScalarField &f );
149 
152  ScalarField &operator+=( const ScalarField &f );
153 
156  ScalarField &operator*=( double x );
157 
160  ScalarField &operator/=( double x );
161 
164  inline double &operator()( int32_t i ) {
165  return( _F[i] ); }
166 
169  inline double &operator()( int32_t i, int32_t j ) {
170  return( _F[i + j*_size[0]] ); }
171 
174  inline double &operator()( int32_t i, int32_t j, int32_t k ) {
175  return( _F[i + (j + k*_size[1])*_size(0)] ); }
176 
179  inline const double &operator()( int32_t i ) const {
180  return( _F[i] ); }
181 
184  inline const double &operator()( int32_t i, int32_t j ) const {
185  return( _F[i + j*_size[0]] ); }
186 
189  inline const double &operator()( int32_t i, int32_t j, int32_t k ) const {
190  return( _F[i + (j + k*_size[1])*_size(0)] ); }
191 
199  double operator()( Vec3D x ) const;
200 
203  void save( const std::string &filename ) const;
204 
207  void save( std::ostream &s ) const;
208 
211  void debug_print( std::ostream &os ) const;
212 };
213 
214 
215 #endif
216