epot_problem.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2011 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_PROBLEM_HPP
#define EPOT_PROBLEM_HPP 1


#include <iostream>
#include <stdint.h>
#include "problem.hpp"
#include "solver.hpp"
#include "scalarfield.hpp"
#include "geometry.hpp"
#include "vec3d.hpp"


enum plasma_mode_e {PLASMA_NONE = 0, PLASMA_PEXP_INITIAL, PLASMA_PEXP, 
                    PLASMA_NSIMP_INITIAL, PLASMA_NSIMP};

#define PLASMA_INITIAL PLASMA_PEXP_INITIAL

class EpotProblem : public Problem {

    class Node2DoF {
        Int3D         _size;          
        int32_t      *_n2d;           
    public:
        
        Node2DoF() : _size(0), _n2d(0) {}
        Node2DoF( Int3D size ) : _size(size) {
            _n2d = new int32_t[_size[0]*_size[1]*_size[2]];
        }
        ~Node2DoF() { delete _n2d; }
        
        void resize( Int3D size ) {
            _size = size;
            if( _n2d )
                delete _n2d;
            _n2d = new int32_t[_size[0]*_size[1]*_size[2]];
        }
        
        int32_t &operator()( int i ) 
            { return( _n2d[i] ); }
        int32_t &operator()( int i, int j ) 
            { return( _n2d[i+j*_size[0]] ); }
        int32_t &operator()( int i, int j, int k ) 
            { return( _n2d[i+j*_size[0]+k*_size[0]*_size[1]] ); }
        
        const int32_t &operator()( int i ) const
            { return( _n2d[i] ); }
        const int32_t &operator()( int i, int j )  const 
            { return( _n2d[i+j*_size[0]] ); }
        const int32_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;
    };

    int32_t             _nodecount;     
    int32_t             _dof;           
    Node2DoF            _n2d;           
    CRowMatrix         *_fd_mat;        
    Vector             *_fd_vec;        
    const Geometry     *_g;             
    mutable CRowMatrix *_fd_mat2;       
    mutable Vector     *_fd_vec2;       
    mutable Vector     *_fd_vec3;       
    int32_t             _neumann_order; 
    bool                _smooth_solid;  
    plasma_mode_e       _plasma;        
    double              _rhoe;          
    double              _Te;            
    double              _Up;            
    std::vector<double> _rhoi;          
    std::vector<double> _Ei;            
    double              _force_pot;     
    bool (*_force_pot_func)(double,double,double); 
    bool (*_init_plasma_func)(double,double,double); 
    Solver             *_solver;        
    void set_link( CRowMatrix &A, Vector &B, 
                   int32_t a, int32_t b, double val );

    void add_initial_plasma( int32_t i, int32_t j, int32_t k, 
                             CRowMatrix &A, Vector &B, Node2DoF &n2d );

    void add_forced_pot( int32_t i, int32_t j, int32_t k, 
                         CRowMatrix &A, Vector &B, Node2DoF &n2d );

    void add_vacuum_node( int32_t i, int32_t j, int32_t k, 
                          CRowMatrix &A, Vector &B, Node2DoF &n2d );

    void add_neumann_node( signed char a, int32_t i, int32_t j, int32_t k, 
                           CRowMatrix &A, Vector &B, Node2DoF &n2d );

    void add_solid_edge_node( signed char a, int32_t i, int32_t j, int32_t k, 
                              CRowMatrix &A, Vector &B, Node2DoF &n2d );
    
    void clear_problem( void );

public:

/* ************************************** *
 * Constructors and destructor            *
 * ************************************** */

    EpotProblem();

    EpotProblem( std::istream &s );

    ~EpotProblem();
    
/* ************************************** *
 * Problem constructing and solving       *
 * ************************************** */

    void set_neumann_order( int32_t order );

    void enable_smooth_solids( bool enable );

    void set_forced_potential_volume( double force_pot, 
                                      bool (*force_pot_func)(double,double,double) );

    void set_initial_plasma( double Up, 
                             bool (*plasma_func)(double,double,double) );

    void set_pexp_plasma( double rhoe, double Te, double Up );

    void set_nsimp_initial_plasma( bool (*plasma_func)(double,double,double) );

    void set_nsimp_plasma( double rhop, double Ep, 
                           std::vector<double> rhoi, std::vector<double> Ei );

    void construct( const Geometry &g );

    void set_solver( Solver &s );

    void solve( ScalarField &epot, const ScalarField &scharge ) const;

/* ************************************** *
 * Solver interface                       *
 * ************************************** */

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

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

    bool linear( void ) const;

/* ************************************** *
 * Misc                                   *
 * ************************************** */

    int get_dof( void ) const { return( _dof ); }

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

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


#endif