scalarfield.hpp
Go to the documentation of this file.
00001 
00005 /* Copyright (c) 2005-2011 Taneli Kalvas. All rights reserved.
00006  *
00007  * You can redistribute this software and/or modify it under the terms
00008  * of the GNU General Public License as published by the Free Software
00009  * Foundation; either version 2 of the License, or (at your option)
00010  * any later version.
00011  * 
00012  * This library is distributed in the hope that it will be useful, but
00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00015  * General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with this library (file "COPYING" included in the package);
00019  * if not, write to the Free Software Foundation, Inc., 51 Franklin
00020  * Street, Fifth Floor, Boston, MA 02110-1301 USA
00021  * 
00022  * If you have questions about your rights to use or distribute this
00023  * software, please contact Berkeley Lab's Technology Transfer
00024  * Department at TTD@lbl.gov. Other questions, comments and bug
00025  * reports should be sent directly to the author via email at
00026  * taneli.kalvas@jyu.fi.
00027  * 
00028  * NOTICE. This software was developed under partial funding from the
00029  * U.S.  Department of Energy.  As such, the U.S. Government has been
00030  * granted for itself and others acting on its behalf a paid-up,
00031  * nonexclusive, irrevocable, worldwide license in the Software to
00032  * reproduce, prepare derivative works, and perform publicly and
00033  * display publicly.  Beginning five (5) years after the date
00034  * permission to assert copyright is obtained from the U.S. Department
00035  * of Energy, and subject to any subsequent five (5) year renewals,
00036  * the U.S. Government is granted for itself and others acting on its
00037  * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
00038  * the Software to reproduce, prepare derivative works, distribute
00039  * copies to the public, perform publicly and display publicly, and to
00040  * permit others to do so.
00041  */
00042 
00043 #ifndef SCALARFIELD_HPP
00044 #define SCALARFIELD_HPP 1
00045 
00046 
00047 #include <iostream>
00048 #include "geometry.hpp"
00049 #include "vec3d.hpp"
00050 
00051 
00070 class ScalarField : public Mesh {
00071     double     *_F;         
00075     void check_definition();
00076 
00077 public:
00078 
00079 
00087     ScalarField();
00088 
00095     ScalarField( const Mesh &m );
00096 
00102     ScalarField( geom_mode_e geom_mode, Int3D size, Vec3D origo, double h );
00103 
00106     ScalarField( std::istream &s );
00107 
00110     ScalarField( const ScalarField &f );
00111 
00114     ~ScalarField();
00115 
00118     void clear();
00119 
00125     void reset( geom_mode_e geom_mode, Int3D size, Vec3D origo, double h );
00126 
00135     void get_minmax( double &min, double &max ) const;
00136 
00144     void epot_get_minmax( const Geometry &g, double &min, double &max ) const;
00145 
00148     ScalarField &operator=( const ScalarField &f );
00149 
00152     ScalarField &operator+=( const ScalarField &f );
00153 
00156     ScalarField &operator*=( double x );
00157 
00160     ScalarField &operator/=( double x );
00161 
00164     inline double &operator()( int32_t i ) { 
00165         return( _F[i] ); }
00166 
00169     inline double &operator()( int32_t i, int32_t j ) {
00170         return( _F[i + j*_size[0]] ); }
00171 
00174     inline double &operator()( int32_t i, int32_t j, int32_t k ) {
00175         return( _F[i + (j + k*_size[1])*_size(0)] ); }
00176 
00179     inline const double &operator()( int32_t i ) const { 
00180         return( _F[i] ); }
00181 
00184     inline const double &operator()( int32_t i, int32_t j ) const {
00185         return( _F[i + j*_size[0]] ); }
00186 
00189     inline const double &operator()( int32_t i, int32_t j, int32_t k ) const {
00190         return( _F[i + (j + k*_size[1])*_size(0)] ); }
00191 
00199     double operator()( Vec3D x ) const;
00200 
00203     void save( const std::string &filename ) const;
00204 
00207     void save( std::ostream &s ) const;
00208 
00211     void debug_print( std::ostream &os ) const;
00212 };
00213 
00214 
00215 #endif
00216