vectorfield.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2010 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef VECTORFIELD_HPP
#define VECTORFIELD_HPP 1


#include "geometry.hpp"
#include "vec3d.hpp"
#include "types.hpp"


class VectorField {
    geom_mode_e _geom_mode; 
    Int3D       _size;      
    Vec3D       _origo;     
    Vec3D       _max;       
    double      _h;         
    double      _div_h;     
    double     *_F[3];      
    field_extrpl_e   _extrpl[6];   
    bool parse_line( const std::string &str, double c[6], double xscale, double fscale, 
                     size_t cdim, size_t fdim, const std::string &filename, size_t linec );

    void transform( int ind[3] );

public:


    VectorField();

    VectorField( const Geometry &g, bool fout[3] );

    VectorField( geom_mode_e geom_mode, bool fout[3], Int3D size, 
                 Vec3D origo, double h );

    VectorField( geom_mode_e geom_mode, bool fout[3], double xscale, 
                 double fscale, const std::string &filename );

    VectorField( const VectorField &f );

    ~VectorField();

    inline geom_mode_e geom_mode( void ) const { return( _geom_mode ); }

    inline Int3D size( void ) const { return( _size ); }

    inline int32_t size( int i ) const { return( _size[i] ); }
   
    inline int32_t nodecount( void ) const { return( _size[0]*_size[1]*_size[2] ); }

    inline Vec3D origo( void ) const { return( _origo ); }

    inline double origo( int i ) const { return( _origo[i] ); }

    inline double h( void ) const { return( _h ); }

    inline double div_h( void ) const { return( _div_h ); }

    void set_extrapolation( field_extrpl_e extrpl[6] ) {
        memcpy( _extrpl, extrpl, 6*sizeof(field_extrpl_e) );
    }

    void translate( Vec3D x );

    void scale( double s );

    void rotate_x( int a );

    void rotate_y( int a );

    void rotate_z( int a );

    void clear();

    void reset( geom_mode_e geom_mode, bool fout[3], Int3D size, 
                Vec3D origo, double h );

    void get_minmax( double &min, double &max ) const;

    void get_defined_components( bool fout[3] ) const;

    VectorField &operator=( const VectorField &f );

    VectorField &operator+=( const VectorField &f );

    VectorField &operator*=( double x );

    VectorField &operator/=( double x );

    const Vec3D operator()( int32_t i ) const;

    const Vec3D operator()( int32_t i, int32_t j ) const;

    const Vec3D operator()( int32_t i, int32_t j, int32_t k ) const;

    void set( int32_t i, const Vec3D &v );
    
    void set( int32_t i, int32_t j, const Vec3D &v );

    void set( int32_t i, int32_t j, int32_t k, const Vec3D &v );

    Vec3D operator()( Vec3D x ) const;

    void debug_print( void ) const;
};


#endif