sparsemtrx.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef sparsemtrx_h
#define sparsemtrx_h
 
#include "oofemenv.h"
#include "floatarray.h"
#include "floatmatrix.h"
#include "intarray.h"
#include "error.h"
#include "sparsemtrxtype.h"
 
#include <memory>
 
namespace oofem {
class EngngModel;
class TimeStep;
class UnknownNumberingScheme;

class OOFEM_EXPORT SparseMtrx
{
public:
    typedef long SparseMtrxVersionType;
 
protected:
    int nRows;
    int nColumns;

    SparseMtrxVersionType version;
 
public:
    SparseMtrx(int n=0, int m=0) : nRows(n), nColumns(m), version(0) { }
    virtual ~SparseMtrx() { }

    SparseMtrxVersionType giveVersion() { return this->version; }

    void checkBounds(int i, int j) const {
        if ( i <= 0 ) {
            OOFEM_ERROR("matrix error on rows : %d <= 0", i);
        } else if ( j <= 0 ) {
            OOFEM_ERROR("matrix error on columns : %d <= 0", j);
        } else if ( i > nRows ) {
            OOFEM_ERROR("matrix error on rows : %d => %d", i, nRows);
        } else if ( j > nColumns ) {
            OOFEM_ERROR("matrix error on columns : %d => %d", j, nColumns);
        }
    }

    int giveNumberOfRows() const { return nRows; }
    int giveNumberOfColumns() const { return nColumns; }
    bool isSquare() const { return nRows == nColumns; }
    bool isNotEmpty() const { return nRows > 0 && nColumns > 0; }

    virtual std::unique_ptr<SparseMtrx> clone() const
    {
        OOFEM_ERROR("Not implemented");
    }

    virtual void times(const FloatArray &x, FloatArray &answer) const { OOFEM_ERROR("Not implemented"); }
    virtual void timesT(const FloatArray &x, FloatArray &answer) const { OOFEM_ERROR("Not implemented"); }
    virtual void times(const FloatMatrix &B, FloatMatrix &answer) const { OOFEM_ERROR("Not implemented"); }
    virtual void timesT(const FloatMatrix &B, FloatMatrix &answer) const { OOFEM_ERROR("Not implemented"); }
    virtual void times(double x) { OOFEM_ERROR("Not implemented"); }
    virtual void add(double x, SparseMtrx &m) { OOFEM_ERROR("Not implemented"); }
    virtual void addDiagonal(double x, FloatArray &m) {
        for ( int i = 1; i <= m.giveSize(); ++i ) {
            this->at(i, i) += x * m.at(i);
        }
    }

    virtual int buildInternalStructure(EngngModel *eModel, int n, int m, const IntArray &I, const IntArray &J) { OOFEM_ERROR("Not implemented"); }
    virtual int buildInternalStructure(EngngModel *eModel, int di, const UnknownNumberingScheme &s) = 0;
    virtual int buildInternalStructure(EngngModel *eModel, int di, const UnknownNumberingScheme &r_s,
                                       const UnknownNumberingScheme &c_s) {
        OOFEM_ERROR("Not implemented");
    }

    virtual int assemble(const IntArray &loc, const FloatMatrix &mat) = 0;
    virtual int assemble(const IntArray &rloc, const IntArray &cloc, const FloatMatrix &mat) = 0;

    virtual int assembleBegin() { return 1; }
    virtual int assembleEnd() { return 1; }

    virtual bool canBeFactorized() const = 0;
    virtual SparseMtrx *factorized() { return NULL; }
    virtual FloatArray *backSubstitutionWith(FloatArray &y) const { return NULL; }
    virtual void zero() = 0;

    virtual double computeNorm() const {
        OOFEM_ERROR("Not implemented");
    }
 
    virtual std::unique_ptr<SparseMtrx> giveSubMatrix(const IntArray &rows, const IntArray &cols) 
    { OOFEM_ERROR("Not implemented"); }
    
    virtual double &at(int i, int j) = 0;
    virtual double at(int i, int j) const = 0;
    virtual bool isAllocatedAt(int i, int j) const { return false; }
    virtual void toFloatMatrix(FloatMatrix &answer) const { OOFEM_ERROR("Not implemented"); }
    virtual void printStatistics() const {  OOFEM_LOG_INFO("Not implemented file %s, line %d\n", __FILE__, __LINE__); }
    virtual void printYourself() const { OOFEM_LOG_INFO("Not implemented file %s, line %d\n", __FILE__, __LINE__); }
    virtual void writeToFile(const char *fname) const { OOFEM_LOG_INFO("Not implemented file %s, line %d\n", __FILE__, __LINE__); }
    virtual SparseMtrxType giveType() const = 0;
    virtual bool isAsymmetric() const = 0;
 
    virtual const char *giveClassName() const = 0;
    std :: string errorInfo(const char *func) const { return std :: string(giveClassName()) + func; }


    FloatArray operator *( const FloatArray & x ) const
    {
        FloatArray answer;
        this->times(x, answer);
        return answer;
    }

    FloatArray trans_mult(const FloatArray &x) const
    {
        FloatArray answer;
        this->timesT(x, answer);
        return answer;
    }

};
} // end namespace oofem
#endif // sparsemtrx_h