readme.txt

Finite Volume Poisson PDE Solver

/*readme.txt*/
/***********************************************************************
    Finite Volume Poisson PDE Solver: C-Library & Matlab Toolbox
    Implements numerical solution of Poisson PDE
    in 2D  Cartesian and Cylindrical coordinates

    Copyright (C) 2004 Igor Kaufman
    Copyright (C) 2004 Lancaster University, UK

    This program is free software; you can redistribute it 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 program 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 program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


    Author's email: [e-mail]

    APPLICATION    : README
    VERSION        : 1.0
************************************************************************/
/*17.01.04*/

C-Library & Matlab Toolbox implement a numerical solution of Poisson equation

div(e*grad(u))=f

for Cartesian 1D, Cartesian 2D and axis-symmetrical cylindrical coordinates
with respect to steeply varying dielectrical permittivity e.
Library uses regular rectangular grid with mixed boundary conditions,
FVM-based equation discretization and iterative methods for solving sparse
linear system.

Full description and last updates will be available at
http://www.lancs.ac.uk/~kaufmani/psn/

C-LIBRARY (/psn_lib)
FILES:
COMMON.C, COMMON.H - data types, memory management
LINALG.C, LINALG.H - solution of tridiagonal system
PSN_1D.C, PSN_1D.H - 1D Poisson solver
PSN_2D.C, PSN_2D.H - 2D and Cylindrical Poisson solver

PSN_LIB_FILES.TXT  - File list

---------------------------------------
MATLAB TOOLBOX (/psn_mex)
FILES:
PSN_1D_MEX.C - POISSON1D MATLAB MEX SOURCE
PSN_2D_MEX.C - POISSON2D MATLAB MEX SOURCE

PSN_1D_MEX.DLL - POISSON1D MATLAB MEX DLL (Windows)
PSN_2D_MEX.DLL - POISSON2D MATLAB MEX DLL (Windows)

PSN_2D_MEX.M - POISSON2D MATLAB HELP
PSN_2D_DEMO.M - POISSON2D DEMO, CARTESIAN COORDINATES
PSN_CYL_DEMO.M - POISSON2D DEMO, CYLINDRICAL COORDINATES

PSN_MEX_FILES.TXT  - File list

-------------------------------------
Folder /mex contains (c)MATLAB header files (just to simplify use of Builder C++ compiler project)

-------------------------------------
FAST START:
1. Copy all files to appropriate folder
2. Make /psn_mex as current MAtlab directory
3. Type "psn_2d_demo" from Matlab command line