lu-umfpack.h

Go to the documentation of this file.

//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //
//                                                                                   //
//                       / /   / /    __    \ \  / /                                 //
//                      / /__ / /   / _ \    \ \/ /                                  //
//                     /  ___  /   | |/_/    / /\ \                                  //
//                    / /   / /    \_\      / /  \ \                                 //
//                                                                                   //
//                                                                                   //
//  Copyright (c) 2016, Jakub Benda, Charles University in Prague                    //
//                                                                                   //
// MIT License:                                                                      //
//                                                                                   //
//  Permission is hereby granted, free of charge, to any person obtaining a          //
// copy of this software and associated documentation files (the "Software"),        //
// to deal in the Software without restriction, including without limitation         //
// the rights to use, copy, modify, merge, publish, distribute, sublicense,          //
// and/or sell copies of the Software, and to permit persons to whom the             //
// Software is furnished to do so, subject to the following conditions:              //
//                                                                                   //
//  The above copyright notice and this permission notice shall be included          //
// in all copies or substantial portions of the Software.                            //
//                                                                                   //
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS          //
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       //
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE       //
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, //
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF         //
// OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  //
//                                                                                   //
//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //

#if (!defined(HEX_LU_UMFPACK) && defined(WITH_UMFPACK))
#define HEX_LU_UMFPACK

// --------------------------------------------------------------------------------- //

#include <umfpack.h>

// --------------------------------------------------------------------------------- //

#include "hex-csrmatrix.h"

// --------------------------------------------------------------------------------- //

#include "luft.h"

// --------------------------------------------------------------------------------- //

#ifdef _LONGINT
    #define UMFPACK_DEFAULTS_F          umfpack_zl_defaults
    #define UMFPACK_SYMBOLIC_F          umfpack_zl_symbolic
    #define UMFPACK_FREE_SYMBOLIC_F     umfpack_zl_free_symbolic
    #define UMFPACK_NUMERIC_F           umfpack_zl_numeric
    #define UMFPACK_SAVE_NUMERIC_F      umfpack_zl_save_numeric
    #define UMFPACK_LOAD_NUMERIC_F      umfpack_zl_load_numeric
    #define UMFPACK_FREE_NUMERIC_F      umfpack_zl_free_numeric
    #define UMFPACK_SOLVE_F             umfpack_zl_solve
    #define UMFPACK_GET_LUNZ_F          umfpack_zl_get_lunz
    #define UMFPACK_REPORT_STATUS_F     umfpack_zl_report_status
    #define UMFPACK_COL_TO_TRIPLET_F    umfpack_zl_col_to_triplet
    #define UMFPACK_TRIPLET_TO_COL_F    umfpack_zl_triplet_to_col
#else
    #define UMFPACK_DEFAULTS_F          umfpack_zi_defaults
    #define UMFPACK_SYMBOLIC_F          umfpack_zi_symbolic
    #define UMFPACK_FREE_SYMBOLIC_F     umfpack_zi_free_symbolic
    #define UMFPACK_NUMERIC_F           umfpack_zi_numeric
    #define UMFPACK_SAVE_NUMERIC_F      umfpack_zi_save_numeric
    #define UMFPACK_LOAD_NUMERIC_F      umfpack_zi_load_numeric
    #define UMFPACK_FREE_NUMERIC_F      umfpack_zi_free_numeric
    #define UMFPACK_SOLVE_F             umfpack_zi_solve
    #define UMFPACK_GET_LUNZ_F          umfpack_zi_get_lunz
    #define UMFPACK_REPORT_STATUS_F     umfpack_zi_report_status
    #define UMFPACK_COL_TO_TRIPLET_F    umfpack_zi_col_to_triplet
    #define UMFPACK_TRIPLET_TO_COL_F    umfpack_zi_triplet_to_col
#endif

// --------------------------------------------------------------------------------- //

class LUft_UMFPACK : public LUft
{
    public:
    
        // run-time selection mechanism
        factorizerRunTimeSelectionDefinitions(LUft_UMFPACK, "umfpack")
        
        
        LUft_UMFPACK ()
            : LUft(), numeric_(nullptr), info_(UMFPACK_INFO) {}
        
        virtual ~LUft_UMFPACK () { drop(); }
        
        // Disable bitwise copy
        LUft_UMFPACK const & operator= (LUft_UMFPACK const &) = delete;
        
        virtual void factorize (CsrMatrix<LU_int_t,Complex> const & matrix, LUftData data);
        
        NumberArray<double> const & info () const { return info_; }
        
        virtual bool valid () const;
        
        virtual std::size_t size () const;
        
        virtual Real cond () const;
        
        virtual void solve (const cArrayView b, cArrayView x, int eqs) const;
        
        virtual void save (std::string name) const;
        
        virtual void load (std::string name, bool throw_on_io_failure = true);
        
        virtual void drop ();
        
    private:
        
        void * numeric_;
        
        NumberArray<LU_int_t> p_;
        NumberArray<LU_int_t> i_;
        NumberArray<std::complex<double>> x_;
        
    public:
        
        mutable NumberArray<double> info_;
};

#endif // WITH_UMFPACK