epot_solver.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2013 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_SOLVER_HPP
#define EPOT_SOLVER_HPP 1


#include <iostream>
#include <stdint.h>
#include "solver.hpp"
#include "callback.hpp"
#include "meshscalarfield.hpp"
#include "geometry.hpp"


class InitialPlasma : public CallbackFunctorB_V {

    coordinate_axis_e _axis;
    double            _val;

public:

    InitialPlasma( coordinate_axis_e axis, double val ) 
        : _axis(axis), _val(val) {}

    ~InitialPlasma() {}

    virtual bool operator()( const Vec3D &x ) const {
        switch( _axis ) {
        case AXIS_X:
            if( x[0] < _val )
                return( true );
            else 
                return( false );
            break;
        case AXIS_Y:
        case AXIS_R:
            if( x[1] < _val )
                return( true );
            else 
                return( false );
            break;
        case AXIS_Z:
            if( x[2] < _val )
                return( true );
            else 
                return( false );
            break;
        }

        // Never here
        return( false );
    }
};


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


#define EPOT_SOLVER_BXMIN 1
#define EPOT_SOLVER_BXMAX 2
#define EPOT_SOLVER_BYMIN 4
#define EPOT_SOLVER_BYMAX 8
#define EPOT_SOLVER_BZMIN 16
#define EPOT_SOLVER_BZMAX 32


#define PLASMA_INITIAL PLASMA_PEXP_INITIAL

class EpotSolver {

protected:

    Geometry           &_geom;             
    plasma_mode_e       _plasma;           
    double              _rhoe;             
    double              _Te;               
    double              _Up;               
    std::vector<double> _rhoi;             
    std::vector<double> _Ei;               
    double              _force_pot;        
    CallbackFunctorB_V *_force_pot_func;   
    CallbackFunctorD_V *_force_pot_func2;  
    CallbackFunctorB_V *_init_plasma_func; 
    double              _plA;              
    double              _plB;              
    double              _plC;              
    std::vector<double> _plD;              
    std::vector<double> _plE;              
    void pexp_newton( double &rhs, double &drhs, double epot ) const;

    void nsimp_newton( double &rhs, double &drhs, double epot ) const;

    uint8_t boundary_index( uint32_t i ) const;

    uint8_t boundary_index( uint32_t i, uint32_t j ) const;

    uint8_t boundary_index( uint32_t i, uint32_t j, uint32_t k ) const;

    uint8_t boundary_index_general( uint32_t i, uint32_t j, uint32_t k ) const;

    void preprocess( MeshScalarField &epot );

    void postprocess( void );

    virtual void reset_problem( void ) = 0;
    
    MeshScalarField *evaluate_scharge( const ScalarField &__scharge ) const;

    virtual void subsolve( MeshScalarField &epot, const MeshScalarField &scharge ) = 0;

public:

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

    EpotSolver( Geometry &geom );

    EpotSolver( const EpotSolver &epsolver, Geometry &geom );

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

    virtual ~EpotSolver() {}

/* ************************************** *
 * Problem constructing and solving       *
 * ************************************** */

    void set_parameters( const EpotSolver &epsolver );

    void set_forced_potential_volume( double force_pot, 
                                      CallbackFunctorB_V *force_pot_func );

    void set_forced_potential_volume( CallbackFunctorD_V *force_pot_func );

    void set_initial_plasma( double Up, 
                             CallbackFunctorB_V *init_plasma_func );

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

    void set_nsimp_initial_plasma( CallbackFunctorB_V *init_plasma_func );

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

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

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

    bool linear( void ) const;

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

    const Geometry &geometry( void ) const;

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

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


#endif