Navigation

Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
   Version 1.0.6dev
      Class Index
      File List
   Version 1.0.6
   Version 1.0.5new_solver
   Version 1.0.5dev
   Version 1.0.5b
   Version 1.0.4dev
   Version 1.0.4
Publications


Hosted by Get Ion Beam Simulator at SourceForge.net. Fast, secure and Free Open Source software downloads
mesh.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 MESH_HPP
44 #define MESH_HPP 1
45 
46 
47 #include <stdint.h>
48 #include <vector>
49 #include <iostream>
50 #include "file.hpp"
51 #include "vec3d.hpp"
52 #include "types.hpp"
53 
54 
67 class Mesh
68 {
69 protected:
75  double _h;
76  double _div_h;
78 public:
79 
85  Mesh();
86 
93 
96  Mesh( std::istream &is );
97 
100  ~Mesh() {}
101 
104  void reset( geom_mode_e geom_mode, Int3D size, Vec3D origo, double h );
105 
108  geom_mode_e geom_mode( void ) const { return( _geom_mode ); }
109 
112  uint32_t dim( void ) const;
113 
116  Int3D size( void ) const { return( _size ); }
117 
120  uint32_t size( int i ) const { return( _size[i] ); }
121 
124  uint32_t nodecount( void ) const { return( _size[0]*_size[1]*_size[2] ); }
125 
128  Vec3D origo( void ) const { return( _origo ); }
129 
132  double origo( int i ) const { return( _origo[i] ); }
133 
137  Vec3D max( void ) const { return( _max ); }
138 
142  double max( int i ) const { return( _max[i] ); }
143 
146  double h( void ) const { return( _h ); }
147 
150  double div_h( void ) const { return( _div_h ); }
151 
157  Int3D closest_node( Vec3D x ) const;
158 
164  Int3D mesh_number( Vec3D x ) const;
165 
171  Vec3D coord_of_node( Int3D n ) const;
172 
175  void save( std::ostream &os ) const;
176 
181  bool operator==( const Mesh &m ) const;
182 
185  bool operator!=( const Mesh &m ) const;
186 
189  void debug_print( std::ostream &os ) const;
190 };
191 
192 
193 #endif
194 
3D Integer vector class.
Definition: vec3d.hpp:320
Mesh geometry definion.
Definition: mesh.hpp:68
uint32_t dim(void) const
Returns number of dimensions in geometry.
Definition: mesh.cpp:111
void debug_print(std::ostream &os) const
Print debugging information to stream os.
Definition: mesh.cpp:185
bool operator==(const Mesh &m) const
Equality.
Definition: mesh.cpp:163
double h(void) const
Returns mesh cell size.
Definition: mesh.hpp:146
Int3D size(void) const
Returns size array of geometry.
Definition: mesh.hpp:116
Vec3D max(void) const
Returns vector pointing to the last mesh point opposite of origo.
Definition: mesh.hpp:137
Mesh()
Default constructor for mesh definition.
Definition: mesh.cpp:49
double max(int i) const
Returns i-th component of vector pointing to the last mesh point opposite of origo.
Definition: mesh.hpp:142
Vec3D _max
Location of mesh point (size[0]-1,size[1]-1,size[2]-1) [m].
Definition: mesh.hpp:73
double div_h(void) const
Returns reciprocal of mesh cell size (1/h).
Definition: mesh.hpp:150
~Mesh()
Destructor.
Definition: mesh.hpp:100
Int3D mesh_number(Vec3D x) const
Returns node, which contains x.
Definition: mesh.cpp:138
Int3D closest_node(Vec3D x) const
Returns node closest to location x.
Definition: mesh.cpp:130
uint32_t nodecount(void) const
Returns number of nodes in the mesh.
Definition: mesh.hpp:124
geom_mode_e _geom_mode
Geometry mode
Definition: mesh.hpp:70
void save(std::ostream &os) const
Saves geometry data to stream os.
Definition: mesh.cpp:154
Vec3D origo(void) const
Returns origo vector of geometry.
Definition: mesh.hpp:128
double _h
Length of mesh step [m].
Definition: mesh.hpp:75
Vec3D _origo
Location of mesh point (0,0,0) [m].
Definition: mesh.hpp:72
void reset(geom_mode_e geom_mode, Int3D size, Vec3D origo, double h)
Reset mesh definition.
Definition: mesh.cpp:75
Vec3D coord_of_node(Int3D n) const
Returns coordinates of node i.
Definition: mesh.cpp:146
Int3D _size
Size of mesh.
Definition: mesh.hpp:71
double _div_h
Reciprocal of length of mesh step [1/m].
Definition: mesh.hpp:76
uint32_t size(int i) const
Returns size of solid mesh in direction i.
Definition: mesh.hpp:120
double origo(int i) const
Returns i-th component of vector origo.
Definition: mesh.hpp:132
geom_mode_e geom_mode(void) const
Returns geometry mode.
Definition: mesh.hpp:108
bool operator!=(const Mesh &m) const
Non-equality.
Definition: mesh.cpp:174
Three dimensional vector.
Definition: vec3d.hpp:58
Bindary file writing and reading tools.
Base types.
geom_mode_e
Geometry mode enum.
Definition: types.hpp:59
Three dimensional vectors.


Reference manual for Ion Beam Simulator 1.0.6dev
Generated by Doxygen 1.9.1 on Thu Sep 11 2025 09:37:24.