epot_efield.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 EPOT_EFIELD_HPP
44 #define EPOT_EFIELD_HPP 1
45 
46 
47 #include "vectorfield.hpp"
48 #include "geometry.hpp"
49 #include "scalarfield.hpp"
50 #include "vec3d.hpp"
51 #include "types.hpp"
52 
53 
70 class EpotEfield : public VectorField {
71 
72  field_extrpl_e _extrpl[6];
74  const Geometry &_g;
75  const ScalarField &_epot;
77 public:
78 
81  EpotEfield( const Geometry &g, const ScalarField &epot );
82 
86 
106  void set_extrapolation( field_extrpl_e extrpl[6] ) {
107  memcpy( _extrpl, extrpl, 6*sizeof(field_extrpl_e) );
108  }
109 
113  virtual const Vec3D operator()( Vec3D x ) const;
114 };
115 
116 
117 #endif
118 
Geometry definition
Scalar fields.
Abstract base class for vector field.
Definition: vectorfield.hpp:53
field_extrpl_e
Field extrapolation mode.
Definition: types.hpp:76
Three dimensional vectors.
Base types.
Vector field based on on-line interpolation of electric potential.
Definition: epot_efield.hpp:70
EpotEfield(const Geometry &g, const ScalarField &epot)
Constructor.
void set_extrapolation(field_extrpl_e extrpl[6])
Set the behaviour of electric field interpolation outside mesh points (extrapolation).
Definition: epot_efield.hpp:106
Geometry defining class.
Definition: geometry.hpp:131
virtual const Vec3D operator()(Vec3D x) const
Operator for getting interpolated electric field value at x.
Three dimensional vector.
Definition: vec3d.hpp:58
~EpotEfield()
Destructor.
Definition: epot_efield.hpp:85
Scalar field class.
Definition: scalarfield.hpp:70
Vector field base.