epot_matrixsolver.hpp

Go to the documentation of this file.

/* Copyright (c) 2011,2012 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 EPOT_MATRIXSOLVER_HPP
#define EPOT_MATRIXSOLVER_HPP 1


#include "epot_solver.hpp"
#include "crowmatrix.hpp"
#include "mvector.hpp"


#define N2D_TYPE_MASK   0x80000000 // 100...
#define N2D_TYPE_FIXED  0x80000000 // 100...
#define N2D_TYPE_FREE   0x00000000 // 000...

#define N2D_INDEX_MASK  0x7FFFFFFF // 011...


class EpotMatrixSolver : public EpotSolver {

protected:

    class Node2DoF {
        Int3D         _size;          
        uint32_t     *_n2d;           
    public:
        
        Node2DoF();
        Node2DoF( Int3D size );
        ~Node2DoF();
        void clear( void );
        void resize( Int3D size );
        
        uint32_t &operator()( int i ) 
            { return( _n2d[i] ); }
        uint32_t &operator()( int i, int j ) 
            { return( _n2d[i+j*_size[0]] ); }
        uint32_t &operator()( int i, int j, int k ) 
            { return( _n2d[i+j*_size[0]+k*_size[0]*_size[1]] ); }
        
        const uint32_t &operator()( int i ) const
            { return( _n2d[i] ); }
        const uint32_t &operator()( int i, int j )  const 
            { return( _n2d[i+j*_size[0]] ); }
        const uint32_t &operator()( int i, int j, int k ) const 
            { return( _n2d[i+j*_size[0]+k*_size[0]*_size[1]] ); }
        
        void debug_print( std::ostream &os ) const;
    };

    uint32_t               _dof;           
    Node2DoF               _n2d;           
    CRowMatrix            *_fd_mat;        
    Vector                *_fd_vec;        
    Vector                *_d_vec;         
    const Vector          *_sol;           
    MeshScalarField       *_epot;
    const MeshScalarField *_scharge;
    

    EpotMatrixSolver( Geometry &geom );

    EpotMatrixSolver( Geometry &geom, std::istream &s );

    void get_vecmat( const CRowMatrix **A, const Vector **B );

    void get_resjac( const CRowMatrix **J, const Vector **R, const Vector &X );

    bool linear( void ) const;

    void set_initial_guess( const MeshScalarField &epot, Vector &X ) const;

    void set_solution( MeshScalarField &epot, const Vector &X ) const;

    void preprocess( MeshScalarField &epot, const MeshScalarField &scharge );

    void postprocess( void );

    void reset_matrix( void );

private:

    void build_mat_vec( void );

    void set_link( uint32_t a, uint32_t b, double val );
    void add_vacuum_node( uint32_t i, uint32_t j, uint32_t k );
    void add_near_solid_node_1d( uint32_t i, const Vec3D &x );
    void add_near_solid_node_2d( uint32_t i, uint32_t j, const Vec3D &x );
    void add_near_solid_node_cyl( uint32_t i, uint32_t j, const Vec3D &x );
    void add_near_solid_node_3d( uint32_t i, uint32_t j, uint32_t k, const Vec3D &x );
    void add_near_solid_node( uint32_t i, uint32_t j, uint32_t k, const Vec3D &x );
    void add_neumann_node_1d( uint32_t i, const Vec3D &x );
    void add_neumann_node_2d( uint32_t i, uint32_t j, const Vec3D &x );
    void add_neumann_node_cyl( uint32_t i, uint32_t j, const Vec3D &x );
    void add_neumann_node_3d( uint32_t i, uint32_t j, uint32_t k, const Vec3D &x );
    void add_neumann_node( uint32_t i, uint32_t j, uint32_t k, const Vec3D &x );

public:

    virtual ~EpotMatrixSolver();

    virtual void debug_print( std::ostream &os ) const;

    virtual void save( std::ostream &s ) const;
};


#endif