kluwrap.h

Go to the documentation of this file.

/* $Header: /var/cvs/mbdyn/mbdyn/mbdyn-1.0/libraries/libmbwrap/kluwrap.h,v 1.5 2014/01/13 08:59:07 masarati Exp $ */
/* 
 * HmFe (C) is a FEM analysis code. 
 *
 * Copyright (C) 1996-2006
 *
 * Marco Morandini  <morandini@aero.polimi.it>
 *
 * Dipartimento di Ingegneria Aerospaziale - Politecnico di Milano
 * via La Masa, 34 - 20156 Milano, Italy
 * http://www.aero.polimi.it
 *
 * Changing this copyright notice is forbidden.
 * 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.
 *
 */
/* December 2001 
 * Modified to add a Sparse matrix in row form and to implement methods
 * to be used in the parallel MBDyn Solver.
 *
 * Copyright (C) 2001-2005
 *
 * Giuseppe Quaranta  <quaranta@aero.polimi.it>
 *
 * Dipartimento di Ingegneria Aerospaziale - Politecnico di Milano
 * via La Masa, 34 - 20156 Milano, Italy
 * http://www.aero.polimi.it
 *      
 */
/* 
 * MBDyn (C) is a multibody analysis code. 
 * http://www.mbdyn.org
 *
 * Copyright (C) 1996-2005
 *
 * Pierangelo Masarati  <masarati@aero.polimi.it>
 * Paolo Mantegazza     <mantegazza@aero.polimi.it>
 *
 * Dipartimento di Ingegneria Aerospaziale - Politecnico di Milano
 * via La Masa, 34 - 20156 Milano, Italy
 * http://www.aero.polimi.it
 *
 * Changing this copyright notice is forbidden.
 *
 * 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 (version 2 of the License).
 * 
 *
 * 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
 */

/*
 * Umfpack is used by permission; please read its Copyright,
 * License and Availability note.
 */

#ifndef KLUSparseSolutionManager_hh
#define KLUSparseSolutionManager_hh

#ifdef USE_KLU

#include <iostream>
#include <vector>

extern "C" {
#include <klu.h>
}

#include "myassert.h"
#include "mynewmem.h"
#include "ls.h"
#include "solman.h"
#include "spmapmh.h"
#include "ccmh.h"
#include "dgeequ.h"
#include "linsol.h"
/* KLUSolver - begin */

class KLUSolver: public LinearSolver {
private:
        integer iSize;
        mutable doublereal *Axp;
        mutable integer *Aip;
        mutable integer *App;

        klu_symbolic *Symbolic;
        mutable klu_common Control;
        mutable klu_numeric *Numeric;

        bool bPrepareSymbolic(void);
        
        void Factor(void);

public:
        enum Scale {
                SCALE_NONE = 0,
                SCALE_SUM = 1,
                SCALE_MAX = 2,
                SCALE_UNDEF
        };

        KLUSolver(const integer &size, const doublereal &dPivot, Scale scale = SCALE_UNDEF);
        ~KLUSolver(void);

        void Reset(void);
        void Solve(void) const;

        void MakeCompactForm(SparseMatrixHandler&,
                        std::vector<doublereal>& Ax,
                        std::vector<integer>& Ar,
                        std::vector<integer>& Ac,
                        std::vector<integer>& Ap) const;

        virtual bool bGetConditionNumber(doublereal& dCond);
};

/* KLUSolver - end */

/* KLUSparseSolutionManager - begin */

class KLUSparseSolutionManager: public SolutionManager {
protected:
        mutable SpMapMatrixHandler A;

        std::vector<doublereal> b;

        mutable MyVectorHandler bVH;

        ScaleOpt scale;
        MatrixScaleBase* pMatScale;

        std::vector<doublereal> Ax;
        std::vector<integer> Ai;
        std::vector<integer> Adummy;
        std::vector<integer> Ap;

        /* Passa in forma di Compressed Column (callback per solve,
         * richiesto da SpMap e CC Matrix Handler) */
        virtual void MakeCompressedColumnForm(void);

        template <typename MH>
        void ScaleMatrixAndRightHandSide(MH& mh);

        template <typename MH>
        MatrixScale<MH>& GetMatrixScale();

        void ScaleSolution(void);
        
        /* Backward Substitution */
        void BackSub(doublereal t_iniz = 0.);

public:
        KLUSparseSolutionManager(integer Dim,
                                                         doublereal dPivot = -1.,
                                                         const ScaleOpt& scale = ScaleOpt());
        virtual ~KLUSparseSolutionManager(void);
#ifdef DEBUG
        virtual void IsValid(void) const {
                NO_OP;
        };
#endif /* DEBUG */

        /* Inizializzatore generico */
        virtual void MatrReset(void);
        
        /* Risolve il sistema Backward Substitution; fattorizza se necessario */
        virtual void Solve(void);

        /* Rende disponibile l'handler per la matrice */
        virtual MatrixHandler* pMatHdl(void) const;

        /* Rende disponibile l'handler per il termine noto */
        virtual MyVectorHandler* pResHdl(void) const;

        /* Rende disponibile l'handler per la soluzione */
        virtual MyVectorHandler* pSolHdl(void) const;
};

/* KLUSparseSolutionManager - end */

/* KLUSparseCCSolutionManager - begin */

template <class CC>
class KLUSparseCCSolutionManager: public KLUSparseSolutionManager {
protected:
        bool CCReady;
        CC *Ac;

        virtual void MatrReset(void);
        virtual void MakeCompressedColumnForm(void);
        
public:
        KLUSparseCCSolutionManager(integer Dim,
                                                           doublereal dPivot = -1.,
                                                           const ScaleOpt& scale = ScaleOpt());
        virtual ~KLUSparseCCSolutionManager(void);

        /* Inizializzatore "speciale" */
        virtual void MatrInitialize(void);
        
        /* Rende disponibile l'handler per la matrice */
        virtual MatrixHandler* pMatHdl(void) const;
};

/* KLUSparseCCSolutionManager - end */

#endif /* USE_UMFPACK */

#endif /* KLUSparseSolutionManager_hh */