Hdf5DataWriter.hpp

/*

Copyright (c) 2005-2016, University of Oxford.
All rights reserved.

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef HDF5DATAWRITER_HPP_
#define HDF5DATAWRITER_HPP_


// Not sure why this seems to need to be included here as well as in AbstractHdf5Access.hpp,
// but it does on some of the build machines.
#ifndef H5_USE_16_API
#define H5_USE_16_API 1
#endif

#include <vector>

#include "AbstractHdf5Access.hpp"
#include "DataWriterVariable.hpp"
#include "DistributedVectorFactory.hpp"

class Hdf5DataWriter : public AbstractHdf5Access //: public AbstractDataWriter
{
private:

    DistributedVectorFactory& mrVectorFactory;

    bool mCleanDirectory;                           
    bool mUseExistingFile;                          
    bool mIsInDefineMode;                           
    bool mIsFixedDimensionSet;                      
    unsigned mEstimatedUnlimitedLength;             
    unsigned mFileFixedDimensionSize;               
    unsigned mDataFixedDimensionSize;               
    unsigned mLo;                                   
    unsigned mHi;                                   
    unsigned mNumberOwned;                          
    unsigned mOffset;                               
    bool mNeedExtend;                               
    bool mUseMatrixForIncompleteData;               
    std::vector<DataWriterVariable> mVariables;     
    long unsigned mCurrentTimeStep;                 
    Mat mSinglePermutation;                         
    Mat mDoublePermutation;                         
    Mat mSingleIncompleteOutputMatrix;              
    Mat mDoubleIncompleteOutputMatrix;              
    bool mUseOptimalChunkSizeAlgorithm;             
    hsize_t mChunkSize[DATASET_DIMS];               
    hsize_t mNumberOfChunks;                  
    hsize_t mFixedChunkSize[DATASET_DIMS];          
    void CheckVariableName(const std::string& rName);

    void CheckUnitsName(const std::string& rName);

    void ComputeIncompleteOffset();

    void OpenFile();

    hsize_t CalculateNumberOfChunks();

    void CalculateChunkDims( unsigned targetSize, unsigned* pChunkSizeInBytes, bool* pAllOneChunk );

    void SetChunkSize();

public:

    Hdf5DataWriter(DistributedVectorFactory& rVectorFactory,
                   const std::string& rDirectory,
                   const std::string& rBaseName,
                   bool cleanDirectory=true,
                   bool extendData=false,
                   std::string datasetName="Data");

    virtual ~Hdf5DataWriter();

    void DefineFixedDimension(long dimensionSize);

    void DefineFixedDimension(const std::vector<unsigned>& rNodesToOuput, long vecSize);

    void DefineUnlimitedDimension(const std::string& rVariableName, const std::string& rVariableUnits, unsigned estimatedLength = 1);

    void AdvanceAlongUnlimitedDimension();

    int DefineVariable(const std::string& rVariableName, const std::string& rVariableUnits);

    bool IsInDefineMode();

    virtual void EndDefineMode();

    void PossiblyExtend();

    void EmptyDataset();

    void PutVector(int variableID, Vec petscVector);

    void PutStripedVector(std::vector<int> variableIDs, Vec petscVector);

    void PutUnlimitedVariable(double value);

    void Close();

    int GetVariableByName(const std::string& rVariableName);


    bool ApplyPermutation(const std::vector<unsigned>& rPermutation, bool unsafeExtendingMode=false);

    void DefineFixedDimensionUsingMatrix(const std::vector<unsigned>& rNodesToOuput, long vecSize);

    void SetFixedChunkSize(const unsigned& rTimestepsPerChunk,
                           const unsigned& rNodesPerChunk,
                           const unsigned& rVariablesPerChunk);

};

#endif /*HDF5DATAWRITER_HPP_*/