CmguiMeshWriter.hpp

/*
 
Copyright (c) 2005-2024, 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 CMGUIWRITER_HPP_
#define CMGUIWRITER_HPP_
 
#include "AbstractTetrahedralMeshWriter.hpp"
#include "OutputFileHandler.hpp"
 
static constexpr char CmguiNodeFileHeader3D[] = R"( #Fields=1
 1) coordinates, coordinate, rectangular cartesian, #Components=3
   x.  Value index= 1, #Derivatives= 0
   y.  Value index= 2, #Derivatives= 0
   z.  Value index= 3, #Derivatives= 0
)";
 
static  constexpr char CmguiNodeFileHeader2D[] = R"( #Fields=1
 1) coordinates, coordinate, rectangular cartesian, #Components=2
   x.  Value index= 1, #Derivatives= 0
   y.  Value index= 2, #Derivatives= 0
)";
 
 
static constexpr char CmguiNodeFileHeader1D[] = R"( #Fields=1
 1) coordinates, coordinate, rectangular cartesian, #Components=1
   x.  Value index= 1, #Derivatives= 0
)";
 
static constexpr char CmguiElementFileHeader3D[] = R"(Shape.  Dimension=3, simplex(2;3)*simplex*simplex
 #Scale factor sets= 0
 #Nodes= 4
)";
 
static constexpr char CmguiElementFileHeader3DQuadratic[] = R"(Shape.  Dimension=3, simplex(2;3)*simplex*simplex
 #Scale factor sets= 0
 #Nodes= 10
)";
 
 
static constexpr char CmguiElementFileHeader2D[] = R"(Shape.  Dimension=2, simplex(2)*simplex
 #Scale factor sets= 0
 #Nodes= 3
)";
 
static constexpr char CmguiElementFileHeader2DQuadratic[] = R"(Shape.  Dimension=2, simplex(2)*simplex
 #Scale factor sets= 0
 #Nodes= 6
)";
 
static constexpr char CmguiElementFileHeader1D[] = R"(Shape.  Dimension=1, line
 #Scale factor sets= 0
 #Nodes= 2
)";
 
static constexpr char CmguiElementFileHeader1DQuadratic[] = R"(Shape.  Dimension=1, line
 #Scale factor sets= 0
 #Nodes= 3
)";
 
 
static constexpr char CmguiCoordinatesFileHeader3D[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=3
   x.  l.simplex(2;3)*l.simplex*l.simplex, no modify, standard node based.
     #Nodes= 4
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
   y.  l.simplex(2;3)*l.simplex*l.simplex, no modify, standard node based.
     #Nodes= 4
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
   z.  l.simplex(2;3)*l.simplex*l.simplex, no modify, standard node based.
     #Nodes= 4
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
)";
 
 
static constexpr char CmguiCoordinatesFileHeader3DQuadratic[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=3
   x.  q.simplex(2;3)*q.simplex*q.simplex, no modify, standard node based.
     #Nodes= 10
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
      7.  #Values=1
       Value indices:     1
       Scale factor indices:   7
      8.  #Values=1
       Value indices:     1
       Scale factor indices:   8
      9.  #Values=1
       Value indices:     1
       Scale factor indices:   9
      10.  #Values=1
       Value indices:     1
       Scale factor indices:   10
   y.  q.simplex(2;3)*q.simplex*q.simplex, no modify, standard node based.
     #Nodes= 10
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
      7.  #Values=1
       Value indices:     1
       Scale factor indices:   7
      8.  #Values=1
       Value indices:     1
       Scale factor indices:   8
      9.  #Values=1
       Value indices:     1
       Scale factor indices:   9
      10.  #Values=1
       Value indices:     1
       Scale factor indices:   10
   z.  q.simplex(2;3)*q.simplex*q.simplex, no modify, standard node based.
     #Nodes= 10
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
      7.  #Values=1
       Value indices:     1
       Scale factor indices:   7
      8.  #Values=1
       Value indices:     1
       Scale factor indices:   8
      9.  #Values=1
       Value indices:     1
       Scale factor indices:   9
      10.  #Values=1
       Value indices:     1
       Scale factor indices:   10
)";
 
 
static constexpr char CmguiCoordinatesFileHeader2D[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=2
   x.  l.simplex(2)*l.simplex, no modify, standard node based.
     #Nodes= 3
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
   y.  l.simplex(2)*l.simplex, no modify, standard node based.
     #Nodes= 3
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
)";
 
 
static constexpr char CmguiCoordinatesFileHeader2DQuadratic[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=2
   x.  q.simplex(2)*q.simplex, no modify, standard node based.
     #Nodes= 6
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
   y.  q.simplex(2)*q.simplex, no modify, standard node based.
     #Nodes= 6
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
)";
 
static constexpr char CmguiCoordinatesFileHeader1D[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=1
   x.  l.Lagrange, no modify, standard node based.
     #Nodes= 2
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
)";
 
 
static constexpr char CmguiCoordinatesFileHeader1DQuadratic[] = R"( 1) coordinates, coordinate, rectangular cartesian, #Components=1
   x.  q.Lagrange, no modify, standard node based.
     #Nodes= 3
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
)";
 
static constexpr char CmguiAdditionalFieldHeader3D[] = R"( field, rectangular cartesian, #Components=1
   x.  l.simplex(2;3)*l.simplex*l.simplex, no modify, standard node based.
     #Nodes= 4
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
)";
 
 
static constexpr char CmguiAdditionalFieldHeader3DQuadratic[] = R"( field, rectangular cartesian, #Components=1
   x.  q.simplex(2;3)*q.simplex*q.simplex, no modify, standard node based.
     #Nodes= 10
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
      7.  #Values=1
       Value indices:     1
       Scale factor indices:   7
      8.  #Values=1
       Value indices:     1
       Scale factor indices:   8
      9.  #Values=1
       Value indices:     1
       Scale factor indices:   9
      10.  #Values=1
       Value indices:     1
       Scale factor indices:   10
)";
 
static constexpr char CmguiAdditionalFieldHeader2D[] = R"( field, rectangular cartesian, #Components=1
   x.  l.simplex(2)*l.simplex, no modify, standard node based.
     #Nodes= 3
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
)";
 
static constexpr char CmguiAdditionalFieldHeader2DQuadratic[] = R"( field, rectangular cartesian, #Components=1
   x.  q.simplex(2)*q.simplex, no modify, standard node based.
     #Nodes= 6
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
      4.  #Values=1
       Value indices:     1
       Scale factor indices:   4
      5.  #Values=1
       Value indices:     1
       Scale factor indices:   5
      6.  #Values=1
       Value indices:     1
       Scale factor indices:   6
)";
 
 
static constexpr char CmguiAdditionalFieldHeader1D[] = R"( field, rectangular cartesian, #Components=1
   x.  l.Lagrange, no modify, standard node based.
     #Nodes= 2
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
)";
 
static constexpr char CmguiAdditionalFieldHeader1DQuadratic[] = R"( field, rectangular cartesian, #Components=1
   x.  q.Lagrange, no modify, standard node based.
     #Nodes= 2
      1.  #Values=1
       Value indices:     1
       Scale factor indices:   1
      2.  #Values=1
       Value indices:     1
       Scale factor indices:   2
      3.  #Values=1
       Value indices:     1
       Scale factor indices:   3
)";
 
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class CmguiMeshWriter : public AbstractTetrahedralMeshWriter<ELEMENT_DIM,SPACE_DIM>
{
protected:
 
    std::vector<std::string> mAdditionalFieldNames;
 
 
    std::vector<std::string> mRegionNames;// {tissue, bath, whatever}
 
    std::string mGroupName;
 
    std::string mElementFileHeader;
 
    std::string mCoordinatesFileHeader;
 
    std::string mAdditionalFieldHeader;
 
    unsigned mNumNodesPerElement;
 
    std::vector<unsigned> mReordering;
 
    std::ios_base::openmode GetOpenMode(bool append);
 
    out_stream OpenNodeFile(bool append = false);
 
    std::vector<boost::shared_ptr<std::ofstream> > OpenElementFiles(bool append = false);
 
    void WriteNodeFileHeader(out_stream& rpNodeFile);
 
    void WriteElementsFileHeader(std::vector<boost::shared_ptr<std::ofstream> >& rElemFiles);
 
 
    void CreateFilesWithHeaders();
 
    void AppendLocalDataToFiles();
 
    void WriteFilesFooter();
 
public:
 
    CmguiMeshWriter(const std::string& rDirectory,
                    const std::string& rBaseName,
                    bool cleanDirectory=true);
 
    void WriteFiles();
 
    void SetAdditionalFieldNames(std::vector<std::string>& rFieldNames);
 
    void SetRegionNames(std::vector<std::string>& rRegionNames);
 
    virtual ~CmguiMeshWriter()
    {}
 
    // A method called CompareCmguiFiles() has been removed, please use FileComparison class instead.
};
 
#endif /*CMGUIWRITER_HPP_*/