gmpFemMatrixSet.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_PLUGIN_FEM_MATRIX_SET_H_
#define _GEMA_PLUGIN_FEM_MATRIX_SET_H_

#include "gmpFemProcessConfig.h"
#include "gmpFemVectorSet.h"

#include <gmMatrixSet.h>
#include <gmSolverMatrix.h>

class GmNumSolver;
class GmSolverMatrix;

class GmSparseMatrixLayoutBuilder;

enum GmpFemMatrixTypes
{
  GmpFemMatrix_Eq = 0,  
  GmpFemMatrix_K = 0,   
  GmpFemMatrix_C,       
  GmpFemMatrix_M,       
  //---------------------------------------
  // No changing bellow this line
  //---------------------------------------
  GmpFemMatrix_NumTypes
};


class GMP_FEM_PROCESS_API_EXPORT GmpFemMatrixSet : public GmMatrixSet
{
public:
  GmpFemMatrixSet();
  ~GmpFemMatrixSet();

  enum GmpFemMatrixMode
  {
    MATRIX_MATCH_MODE,  
    MATRIX_SINGLE_MODE, 
    MATRIX_SINGLE_DEBUG_MODE,  
  };

  void clear();

  bool initTypes  (const GmNumSolver* solver, GmpFemMatrixMode mode, int numMatrices, ...);
  bool adjustSizes(int globalNumDofs, int maxElemDofs, bool sparseLayoutChanged);

  void setNumThreads(int nthreads) { assert(_nthreads >= -1); _nthreads = nthreads; }

  void setTransposedDofVector(GmpFemMatrixTypes type, GmpFemVectorTypes vectorType);

  void clearGlobalMatrices(bool keepSparseLayout);

  bool supportsBatchInsert() const;
  bool beginBatchInsert(size_t expectedEntries = 0);
  bool endBatchInsert(bool discardData);

  bool supportsSparseLayouts() const;
  GmSparseMatrixLayoutBuilder* layoutBuilder() const;
  bool emptyLayout() const;

  bool supportsParallelAdd() const { return _parallelSupport; }

  bool needsLocking() const { return _needsLock;  }

  GmSolverMatrix* globalMatrix(GmpFemMatrixTypes type) const
  {
    assert((_mode == MATRIX_MATCH_MODE && index(type) >= 0) || (_mode != MATRIX_MATCH_MODE && type == GmpFemMatrix_Eq));
    return _globalMatrices[tindex(type)]._data;
  }

  GmSolverMatrix* globalMatrixFromIndex(int index) const
  {
    assert(_mode == MATRIX_MATCH_MODE && index >= 0 && index < _nMatrices); 
    return _globalMatrices[index]._data;
  }

  int transposedDofVector(GmpFemMatrixTypes type) const
  {
    assert((_mode == MATRIX_MATCH_MODE && index(type) >= 0) || (_mode != MATRIX_MATCH_MODE && type == GmpFemMatrix_Eq));
    return _globalMatrices[tindex(type)]._transposed;
  }

  int transposedDofVectorFromIndex(int index) const
  {
    assert(_mode == MATRIX_MATCH_MODE && index >= 0 && index < _nMatrices);
    return _globalMatrices[index]._transposed;
  }

  GmSolverMatrix* globalDebugPrintMatrix(GmpFemMatrixTypes type) const
  {
    assert(_mode != MATRIX_SINGLE_MODE && index(type) >= 0);
    return (_mode == MATRIX_MATCH_MODE) ? _globalMatrices[index(type)]._data : _printMatrices[index(type)];
  }

  GmSolverMatrix* globalDebugPrintMatrixFromIndex(int index) const
  {
    assert(_mode != MATRIX_SINGLE_MODE && index >= 0 && index < _nMatrices);
    return (_mode == MATRIX_MATCH_MODE) ? _globalMatrices[index]._data : _printMatrices[index];
  }

  GmpFemMatrixMode mode() const { return _mode; }

  GmpFemMatrixTypes femTypeFromIndex(int index) const { return (GmpFemMatrixTypes)typeFromIndex(index); }


protected:

  int tindex(GmpFemMatrixTypes type) const { return (_mode == MATRIX_MATCH_MODE) ? index(type) : 0; }

  GmpFemMatrixMode   _mode;     
  const GmNumSolver* _solver;   
  int                _nthreads; 

  bool _parallelSupport; 
  bool _needsLock;       

  struct GmpFemMatrixTypeData
  {
    GmSolverMatrix*   _data;       
    int               _transposed; 

    GmpFemMatrixTypeData() { _data = NULL; _transposed = -1; }

    ~GmpFemMatrixTypeData() { delete _data; }
  };

  GmpFemMatrixTypeData* _globalMatrices;

  GmSolverMatrix** _printMatrices;
};


#endif