FieldIO.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File FieldIO.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// License for the specific language governing rights and limitations under
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Field IO prototype definitions
//
///////////////////////////////////////////////////////////////////////////////

#ifndef NEKTAR_LIB_UTILITIES_BASIC_UTILS_FIELDIO_H
#define NEKTAR_LIB_UTILITIES_BASIC_UTILS_FIELDIO_H

#include <LibUtilities/BasicUtils/CompressData.h>
#include <LibUtilities/BasicUtils/ShapeType.hpp>
#include <LibUtilities/Foundations/Basis.h>
#include <LibUtilities/Foundations/Points.h>
#include <tinyxml.h>

namespace Nektar
{
namespace LibUtilities
{
static std::vector<NekDouble>                NullNekDoubleVector;
static std::vector<LibUtilities::PointsType> NullPointsTypeVector;
static std::vector<unsigned int>             NullUnsignedIntVector;

typedef std::map<std::string, std::string> FieldMetaDataMap;
static FieldMetaDataMap NullFieldMetaDataMap;
static std::vector<std::vector<NekDouble> > NullVectorNekDoubleVector =
    boost::assign::list_of(NullNekDoubleVector);

struct FieldDefinitions
{
    FieldDefinitions(
        ShapeType                                   shapeType,
        const std::vector<unsigned int>            &elementIDs,
        const std::vector<LibUtilities::BasisType> &basis,
        bool                                        uniOrder,
        const std::vector<unsigned int>            &numModes,
        const std::vector<std::string>             &fields,
        int                                         NumHomoDir = 0,
        const std::vector<NekDouble>               &HomoLengths
                                                          = NullNekDoubleVector,
        bool                                        homoStrips = false,
        const std::vector<unsigned int>            &HomoSIDs 
                                                        = NullUnsignedIntVector,
        const std::vector<unsigned int>            &HomoZIDs
                                                        = NullUnsignedIntVector,
        const std::vector<unsigned int>            &HomoYIDs
                                                        = NullUnsignedIntVector,
        const std::vector<LibUtilities::PointsType> &points
                                                         = NullPointsTypeVector,
        bool                                        pointsDef = false,
        const std::vector<unsigned int>            &numPoints
                                                        = NullUnsignedIntVector,
        bool numPointsDef = false)
        : m_shapeType(shapeType), m_elementIDs(elementIDs), m_basis(basis),
          m_numHomogeneousDir(NumHomoDir), m_homogeneousLengths(HomoLengths),
          m_homoStrips(homoStrips), m_homogeneousSIDs(HomoSIDs),
          m_homogeneousZIDs(HomoZIDs), m_homogeneousYIDs(HomoYIDs),
          m_points(points), m_pointsDef(pointsDef), m_uniOrder(uniOrder),
          m_numModes(numModes), m_numPoints(numPoints),
          m_numPointsDef(numPointsDef), m_fields(fields)
    {
    }

    ShapeType                             m_shapeType;
    std::vector<unsigned int>             m_elementIDs;
    std::vector<LibUtilities::BasisType>  m_basis;
    int                                   m_numHomogeneousDir;
    std::vector<NekDouble>                m_homogeneousLengths;
    bool                                  m_homoStrips;
    std::vector<unsigned int>             m_homogeneousSIDs;
    std::vector<unsigned int>             m_homogeneousZIDs;
    std::vector<unsigned int>             m_homogeneousYIDs;
    /// True if filesystem is shared.
    bool                                  m_sharedFilesystem;
    /// Define the type of points per direction.
    std::vector<LibUtilities::PointsType> m_points;
    bool                                  m_pointsDef;
    /// Define order of the element group.
    /// * UniOrder: same order for each element
    /// * MixOrder: definition of a different order for each element.
    bool                                  m_uniOrder;
    /// Define number of modes per direction.
    std::vector<unsigned int>             m_numModes;
    std::vector<unsigned int>             m_numPoints;
    bool                                  m_numPointsDef;
    std::vector<std::string>              m_fields;
};

typedef boost::shared_ptr<FieldDefinitions> FieldDefinitionsSharedPtr;

/// Write a field file in serial only
LIB_UTILITIES_EXPORT void Write(
    const std::string                      &outFile,
    std::vector<FieldDefinitionsSharedPtr> &fielddefs,
    std::vector<std::vector<NekDouble> >   &fielddata,
    const FieldMetaDataMap                 &fieldinfomap = NullFieldMetaDataMap);

/// Imports an FLD file
LIB_UTILITIES_EXPORT void Import(
    const std::string                      &infilename,
    std::vector<FieldDefinitionsSharedPtr> &fielddefs,
    std::vector<std::vector<NekDouble> >   &fielddata
                                                    = NullVectorNekDoubleVector,
    FieldMetaDataMap                       &fieldinfomap = NullFieldMetaDataMap,
    const Array<OneD, int>                  ElementiDs   = NullInt1DArray);

/// Class for operating on FLD files
class FieldIO
{
public:
    /// Constructor
    LIB_UTILITIES_EXPORT FieldIO(LibUtilities::CommSharedPtr pComm,
                                 bool sharedFilesystem = false);

    /// Write data in FLD format
    LIB_UTILITIES_EXPORT void Write(
        const std::string                      &outFile,
        std::vector<FieldDefinitionsSharedPtr> &fielddefs,
        std::vector<std::vector<NekDouble> >   &fielddata,
        const FieldMetaDataMap                 &fieldinfomap
                                                        = NullFieldMetaDataMap);

    /// Imports an FLD file.
    LIB_UTILITIES_EXPORT void Import(
        const std::string                      &infilename,
        std::vector<FieldDefinitionsSharedPtr> &fielddefs,
        std::vector<std::vector<NekDouble> >   &fielddata
                                                    = NullVectorNekDoubleVector,
        FieldMetaDataMap                       &fieldinfomap
                                                         = NullFieldMetaDataMap,
        const Array<OneD, int>                  ElementiDs = NullInt1DArray);

    /// Imports the definition of the meta data
    LIB_UTILITIES_EXPORT void ImportFieldMetaData(
        std::string       filename,
        FieldMetaDataMap &fieldmetadatamap);

    /// Imports the definition of the meta data
    LIB_UTILITIES_EXPORT void ImportFieldMetaData(
        TiXmlDocument &doc, FieldMetaDataMap &fieldmetadatamap);

    /// Imports the definition of the fields.
    LIB_UTILITIES_EXPORT void ImportFieldDefs(
        TiXmlDocument                          &doc,
        std::vector<FieldDefinitionsSharedPtr> &fielddefs,
        bool                                    expChild);

    /// Imports the data fileds.
    LIB_UTILITIES_EXPORT void ImportFieldData(
        TiXmlDocument                                &doc,
        const std::vector<FieldDefinitionsSharedPtr> &fielddefs,
        std::vector<std::vector<NekDouble> >         &fielddata);

    LIB_UTILITIES_EXPORT void WriteMultiFldFileIDs(
        const std::string              &outfile,
        const std::vector<std::string>  fileNames,
        std::vector<std::vector<unsigned int> > &elementList,
        const FieldMetaDataMap         &fieldinfomap = NullFieldMetaDataMap);

protected:
    /// Communicator to use when writing parallel format
    LibUtilities::CommSharedPtr m_comm;

    /// True if same filesystem accessible by all processes.
    bool                        m_sharedFilesystem;

    LIB_UTILITIES_EXPORT void AddInfoTag(
        TiXmlElement *root, const FieldMetaDataMap &fieldmetadatamap);

    LIB_UTILITIES_EXPORT void GenerateSeqString(
        const std::vector<unsigned int> &elmtids, std::string &idString);

    LIB_UTILITIES_EXPORT std::string SetUpOutput(const std::string outname);

    LIB_UTILITIES_EXPORT void SetUpFieldMetaData(
        const std::string                             outname,
        const std::vector<FieldDefinitionsSharedPtr> &fielddefs,
        const FieldMetaDataMap                       &fieldmetadatamap);

    LIB_UTILITIES_EXPORT void ImportMultiFldFileIDs(
        const std::string        &inFile,
        std::vector<std::string> &fileNames,
        std::vector<std::vector<unsigned int> > &elementList,
        FieldMetaDataMap         &fieldmetadatamap);

    LIB_UTILITIES_EXPORT int CheckFieldDefinition(
        const FieldDefinitionsSharedPtr &fielddefs);

    LIB_UTILITIES_EXPORT virtual std::string GetFileEnding() const
    {
        return "fld";
    };

};

typedef boost::shared_ptr<FieldIO> FieldIOSharedPtr;
}
}
#endif