gmFileWriter.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_FILE_WRITER_H_
#define _GEMA_FILE_WRITER_H_

#include "gmFileIO.h"

#include <QList>
#include <QVariantMap>

class GmCellAccessor;
class GmGaussAccessor;

class GmFileWriter
{
public:

  GmFileWriter(const GmLogCategory& logger) : _logger(logger) {}

  virtual ~GmFileWriter() { }

  /* \brief Creates files and initializes them in preperation for later calls to saveXxxx() functions.
            After those calls, the opened state will be closed by a call to closeFiles().
            On errors this function should delete any files that where eventually created and
            return false.

      \param fileName        The base name of the file that will be created
      \param simData         The simulation data object
      \param filter          The filter object specifying the mesh, the set of nodes, cells and Gauss 
                             rules that should be saved.
      \param options         A set of options specific to the file type
      \param multipleResults Set to true if multiple result sets will be saved to the file
      \param gaussValues     Set to true if Gauss values will be saved to the file at Gauss points.
                             Keep in mind that the filter may store Gauss rules, but if interpolation is 
                             in place, that data is saved as node data, unless the user asked to save 
                             both (node and Gauss values).
      \param discValues      Set to true if Discontinuity set information will be saved.
      \param timeUnit  The unit in which time step information is saved to the file
      \returns Returns true on success, false on errors
  */
  virtual bool createFiles(QString fileName, const GmSimulationData* simData, const GmFileFilter* filter,
                           const QVariantMap& options, bool multipleResults, bool gaussValues, bool discValues,
                           GmFileIO::DumpMode dumpMode, QString timeUnit) = 0;

  virtual bool setCurrentTime(int iter, double time) = 0;

  virtual bool saveGeometry(GmValueAccessor* nodeAc, const double* scaleFactor, const double* offset) = 0;

  virtual bool saveDiscontinuities(const QVector<GmDiscontinuitySet*>& sets, GmFileIO::DiscontinuityDataMode mode,
                                   const UnitConverter* conv, const double* scaleFactor, const double* offset) = 0;

  virtual bool saveData(const QVector<GmResultNodeDataSrc*>&  nodeData, 
                        const QVector<GmResultCellDataSrc*>&  cellData,
                        const QVector<GmResultGaussDataSrc*>& gaussData,
                        int extraColumns, const QVector<int>& propertySets) = 0;


#if 1
//--------------------------------------------------------------------------------------------------------------------
// DEPRECATED FUNCTIONS - Will be removed when the old nf and medit writers are migrated to the new structure
//--------------------------------------------------------------------------------------------------------------------

  /* \brief Creates files and initializes them in preperation for later calls to saveXxxx() functions.
            After those calls, the opened state will be closed by a call to closeFiles().
            On errors this function should delete any files that where eventually created and
            return false.

      \param fileName  The name of the file that will be created
      \param simData   The simulation data object
      \param mesh      The mesh that will be saved.
      \param options   A set of options specific to the file type
      \param numNodeValues   The number of node variables (state vars/attributes) that will be saved
      \param numElemValues   The number of element variables (attributes/properties) that will be saved
      \param intRuleSet      The integration rule set that should be used to determine Gauss points
                             when saving element data in Gauss points or -1 if no Gauss attributes 
                             are present.
      \param multipleResults Set to true if multiple result sets will be saved to the file
      \returns Returns true on success, false on errors
  */
  virtual bool createFiles(QString fileName, const GmSimulationData* simData, const GmMesh* mesh,
                           const QVariantMap& options, int numNodeValues, int numElemValues,
                           int intRuleSet, bool multipleResults)
  {
    Q_UNUSED(fileName); Q_UNUSED(simData); Q_UNUSED(mesh); Q_UNUSED(options); Q_UNUSED(numNodeValues); 
    Q_UNUSED(numElemValues); Q_UNUSED(intRuleSet); Q_UNUSED(multipleResults);
    return false;
  }

  virtual bool saveNodeCoordinates(const GmMesh* mesh, GmValueAccessor* nodeAcc, QList<double>& scaleFactor, QList<double>& offset)
  {
    Q_UNUSED(mesh); Q_UNUSED(nodeAcc); Q_UNUSED(scaleFactor); Q_UNUSED(offset);
    return false;
  }

  virtual bool saveCellGeometry(const GmCellMesh* mesh) { Q_UNUSED(mesh); return false; }

  virtual bool saveNodeData(const GmMesh* mesh, const QList<GmValueAccessor*>& accList, int iter, double currentTime, bool split)
  {
    Q_UNUSED(mesh); Q_UNUSED(accList); Q_UNUSED(iter); Q_UNUSED(currentTime); Q_UNUSED(split);
    return false;
  }

  virtual bool saveElementData(const GmCellMesh* mesh, const QList<GmCellAccessor*>& elemAccList, 
                               const QList<GmGaussAccessor*>& gaussAccList, int iter, double currentTime, bool split)
  {
    Q_UNUSED(mesh); Q_UNUSED(elemAccList); Q_UNUSED(gaussAccList);  Q_UNUSED(iter); Q_UNUSED(currentTime); Q_UNUSED(split);
    return false;
  }

  //--------------------------------------------------------------------------------------------------------------------
  // END DEPRECATED FUNCTIONS
  //--------------------------------------------------------------------------------------------------------------------
#endif


  virtual bool closeFiles(bool deleteFiles = false) = 0;

  virtual QString tempFile() { return QString(); }

  virtual void flushFiles() = 0;

  virtual GmFileFormat* fileFormat() = 0;

  virtual bool dumpSupport() const { return false; }

  virtual bool addSavedItemsToMap(QVariantMap& map) { Q_UNUSED(map); return true; }

  virtual bool loadSavedItemsFromMap(QVariantMap& map) { Q_UNUSED(map); return true; }

protected:
  const GmLogCategory& _logger;    
};

#endif