multimeshvectorfield.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 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 MULTIMESHVECTORFIELD_HPP
44 #define MULTIMESHVECTORFIELD_HPP 1
45 
46 
47 #include <vector>
48 #include "meshvectorfield.hpp"
49 
50 
70 
71  std::vector<MeshVectorField *> _field;
75 public:
76 
85 
92  MultiMeshVectorField( const Mesh &m, const bool fout[3] );
93 
104  MultiMeshVectorField( geom_mode_e geom_mode, const bool fout[3], Int3D size,
105  Vec3D origo, double h );
106 
132  MultiMeshVectorField( geom_mode_e geom_mode, const bool fout[3], double xscale,
133  double fscale, const std::string &filename );
134 
138 
141  MultiMeshVectorField( std::istream &s );
142 
145  virtual ~MultiMeshVectorField();
146 
166  void set_extrapolation( const field_extrpl_e extrpl[6] );
167 
170  void translate( Vec3D x );
171 
174  void scale( double s );
175 
178  void rotate_x( int a );
179 
182  void rotate_y( int a );
183 
186  void rotate_z( int a );
187 
190  void clear();
191 
198  void reset( geom_mode_e geom_mode, const bool fout[3], Int3D size,
199  Vec3D origo, double h );
200 
201 
210  void add_mesh( Int3D size, Vec3D origo, double h );
211 
220  void add_mesh( double xscale, double fscale, const std::string &filename );
221 
225  void get_minmax( double &min, double &max ) const;
226 
229  void get_defined_components( bool fout[3] ) const;
230 
234 
237  const MeshVectorField &operator[]( int i ) const {
238  return( *_field[i] );
239  }
240 
244  return( *_field[i] );
245  }
246 
250  virtual const Vec3D operator()( Vec3D x ) const;
251 
254  void save( const std::string &filename ) const;
255 
258  void save( std::ostream &s ) const;
259 
262  void debug_print( std::ostream &os ) const;
263 };
264 
265 
266 #endif
267 
void set_extrapolation(const field_extrpl_e extrpl[6])
Set the behaviour of field interpolation outside mesh points (extrapolation).
Abstract base class for vector field.
Definition: vectorfield.hpp:53
const MeshVectorField & operator[](int i) const
Return const reference to subfield i.
Definition: multimeshvectorfield.hpp:237
MultiMeshVectorField()
Default constructor.
Mesh geometry definion.
Definition: mesh.hpp:67
geom_mode_e
Geometry mode enum.
Definition: types.hpp:59
virtual ~MultiMeshVectorField()
Destructor.
field_extrpl_e
Field extrapolation mode.
Definition: types.hpp:76
void rotate_x(int a)
Rotate field in coordinate system around x-axis.
Mesh based vector fields
void add_mesh(Int3D size, Vec3D origo, double h)
Add a new mesh field to the multiple mesh vector field.
void debug_print(std::ostream &os) const
Print debugging information to os.
void scale(double s)
Scale field in coordinate system.
MultiMeshVectorField & operator=(const MultiMeshVectorField &f)
Copy operator.
void get_defined_components(bool fout[3]) const
Get which field components are defined.
void reset(geom_mode_e geom_mode, const bool fout[3], Int3D size, Vec3D origo, double h)
Resets the field geometry.
Vector field based on multiple meshes.
Definition: multimeshvectorfield.hpp:69
void rotate_z(int a)
Rotate field in coordinate system around z-axis.
3D Integer vector class.
Definition: vec3d.hpp:289
Mesh based vector field.
Definition: meshvectorfield.hpp:71
void get_minmax(double &min, double &max) const
Search minimum and maximum vector length values of vector field.
void save(const std::string &filename) const
Saves data to a new file filename.
void rotate_y(int a)
Rotate field in coordinate system around y-axis.
Three dimensional vector.
Definition: vec3d.hpp:58
MeshVectorField & operator[](int i)
Return reference to subfield i.
Definition: multimeshvectorfield.hpp:243
void clear()
Clears the field.
virtual const Vec3D operator()(Vec3D x) const
Operator for getting linearly interpolated field value at x.
void translate(Vec3D x)
Translate field in coordinate system.