solve.h

Go to the documentation of this file.

/*!
 *
 * Copyright (C) 2007 Technical University of Liberec.  All rights reserved.
 *
 * Please make a following refer to Flow123d on your project site if you use the program for any purpose,
 * especially for academic research:
 * Flow123d, Research Centre: Advanced Remedial Technologies, Technical University of Liberec, Czech Republic
 *
 * This program is free software; you can redistribute it and/or modify it under the terms
 * of the GNU General Public License version 3 as published by the Free Software Foundation.
 *
 * 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 021110-1307, USA.
 *
 *
 * $Id$
 * $Revision$
 * $LastChangedBy$
 * $LastChangedDate$
 *
 * @file
 * @brief Unified interface to various solvers
 *
 * aim: simplified interface to PETSC solvers, Mat, Vec
 * - independent of Seq-MPI
 * - application to parallel PETSC mapping
 * - preallocation by abstract assembly
 *
 * @todo
 * - samostatny objekt LS
 * - samostatne objekty pro matici a vektor
 * - objekty pro mapovani indexu a jejich automaticke pouziti pri asemblaci
 * - podminene veci jako LS View a old_4_new
 * - funkcni stavy LS
 * - solve jako metoda
 * - nastaveni parametru na volajici strane (zavisle na problemu)
 */

#include "input/input_type.hh"
#include "input/accessors.hh"
#include "la/linsys.hh"

#ifndef SOLVE_H
#define SOLVE_H

/*!************************************************
 * ISOL specific parameters
 **************************************/
// Specific parameters for ISOL solver
typedef struct ISOL_params {
    char*           method;         //!< Iteration method
    int             restart;        //!< num of iter. of restart of GMRES
    char*           stop_crit;      //!< Stoping criterion
    double          be_tol;         //!< Backward error tolerance
    int             stop_check;     //!< Stop check
    char*           scaling;        //!< Scaling method
    char*           precond;        //!< Type od preconditioning
    double          sor_omega;      //!< Relaxation parameter
    /// @name ILU preconditioner parameters
    ///@{
    double          ilu_droptol;      //!< drop tolerance
    int             ilu_milu;         //
    int             ilu_cpiv;
    int             ilu_dskip;
    int             ilu_lfil;
    ///@}
} ISOL_params;


/*!************************************************************
 * @name Solver Type
 */
typedef enum {
    UNKNOWN=0,
    SI2=1,
    GI8=2,
    MATLAB=4,
    PETSC_SOLVER=6,
    ISOL=7,
    PETSC_MATIS_SOLVER=8,
    BDDCML_SOLVER=9 
} SolverType;


/*!**************************************************************
 *  Solver structure - no matrix, but parameters ...
 **************************************************************/
struct  Solver {
public:
    static Input::Type::AbstractRecord input_type;
    static Input::Type::Record input_type_petsc;
    static Input::Type::Record input_type_bddc;

    int some_func();



    SolverType      type;           //!< type of the solver
    char    *name;          //!< Name of the solver
    char    *executable;    //!< full path to the external solver executable file
    struct  LinSys   *LinSys;   //!< System to solve
    char    external;       //!< run an external progam as a solver
    char    manual_run;     //!< Run solver manualy ?
    char    use_ctrl_file;  //!< User provided control file ?
    const char  *ctrl_file;     //!< Name of control file
    string  params;         //!< Solver's comamnd line parameters
    char    keep_files;     //!< Keep or remove solver files?
    int     use_last_sol;   //!< Use last known solution? (should be in water module)

    //@{
    //! solver parameters
    int             max_it;          //!< Max. number of iterations
    double          r_tol;           //!< Relative tolerance
    double          a_tol;           //!< Absolute tolerance
    ISOL_params     *isol_params;    //!< optional ISOL parameters
    //@}
};

// public functions
void solver_init( Solver*, Input::AbstractRecord in_rec);
void solve_system( Solver*, LinSys *lin_system);

#endif
//-----------------------------------------------------------------------------
// vim: set cindent: