write_tikz.cc

 
#include "write_tikz.h"
 
#include <fstream>
#include <iostream>
 
#include "lf/base/base.h"
#include "lf/mesh/mesh.h"
 
namespace lf::io {
 
TikzOutputCtrl operator|(const TikzOutputCtrl &lhs, const TikzOutputCtrl &rhs) {
  return static_cast<TikzOutputCtrl>(static_cast<unsigned int>(lhs) |
                                     static_cast<unsigned int>(rhs));
}
 
TikzOutputCtrl operator&(const TikzOutputCtrl &lhs, const TikzOutputCtrl &rhs) {
  return static_cast<TikzOutputCtrl>(static_cast<unsigned int>(lhs) &
                                     static_cast<unsigned int>(rhs));
}
 
// NOLINTNEXTLINE(readability-function-cognitive-complexity)
bool writeTikZ(const lf::mesh::Mesh &mesh, const std::string &filename,
               std::function<bool(const lf::mesh::Entity &)> &&selector,
               TikzOutputCtrl output_ctrl) {
  // Open output file for writing and quit in case of failure
  std::ofstream outfile(filename);
  if (!outfile) {
    return false;
  }
  // ----------------------------------------------------------------
  // For the enum flags: TikzOutputCtrl
  // NOLINTBEGIN(bugprone-non-zero-enum-to-bool-conversion)
  const bool EdgeNumOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::EdgeNumbering);
  const bool NodeNumOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::NodeNumbering);
  const bool CellNumOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::CellNumbering);
  const bool VerticeNumOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::VerticeNumbering);
  const bool RenderCellsOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::RenderCells);
  const bool ArrowsOn =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::ArrowTips);
  const bool WithPreamble =
      static_cast<bool>(output_ctrl & TikzOutputCtrl::WithPreamble);
  // NOLINTEND(bugprone-non-zero-enum-to-bool-conversion)
 
  using size_type = std::size_t;         // lf::base::size_type;
  using dim_t = lf::base::RefEl::dim_t;  // lf::base::dim_t;
  const Eigen::MatrixXd zero(Eigen::MatrixXd::Zero(0, 1));
 
  // Obtain topological dimension of the mesh
  const dim_t dim_mesh = mesh.DimMesh();
  LF_VERIFY_MSG(dim_mesh == 2, "writeTikZ() only available for 2D meshes");
 
  // Run through nodes
  const dim_t node_codim(dim_mesh);  // Codimension number for nodes in the mesh
  const size_type no_of_nodes =
      mesh.NumEntities(node_codim);  // No. of nodes in codimension for nodes
  size_type node_count = 0;
 
  // START writing to file
  if (WithPreamble) {
    outfile << "\\documentclass[12pt,a4paper]{article}\n\\usepackage{tikz}"
               "\n\\begin{document}\n"
            << '\n';
  }
  outfile << "% TikZ document graphics \n";
 
  // Scale font size for large meshes
  if (no_of_nodes > 50) {
    outfile << "\\begin{tikzpicture}[scale=6, >= stealth, inner sep=0pt, "
               "minimum size=0.2cm]\n";
    outfile << "\\tikzstyle{every node}=[font=\\tiny]\n";
  } else {
    outfile << "\\begin{tikzpicture}[scale=4, >= stealth, inner sep=0pt, "
               "minimum size=0.35cm]\n";
  }
 
  // ---------------------------------------------------------------------------
 
  // Loop through codimensions
  for (int co_dim = 0; co_dim <= dim_mesh; co_dim++) {
    // Loop through all types of entities
    for (const mesh::Entity *obj : mesh.Entities(co_dim)) {
      if (selector(*obj)) {  // IF SELECTOR -------
        const size_type obj_idx = mesh.Index(*obj);
        const lf::base::RefEl obj_refel = obj->RefEl();
        const int num_nodes_obj = base::narrow<int>(obj_refel.NumNodes());
        const geometry::Geometry *obj_geo_ptr = obj->Geometry();
        const Eigen::MatrixXd &obj_corners(obj_refel.NodeCoords());
        const Eigen::MatrixXd vertices = obj_geo_ptr->Global(obj_corners);
        const Eigen::MatrixXd center =
            vertices.rowwise().sum() / vertices.cols();
        Eigen::MatrixXd center_mat(center.rows(), num_nodes_obj);
 
        switch (obj_refel) {
          case lf::base::RefEl::kPoint(): {
            if (NodeNumOn) {
              outfile << "\\draw[red, fill = white] (" << vertices(0, 0) << ","
                      << vertices(1, 0) << ") "
                      << "node[draw, circle, fill = white] {" << obj_idx
                      << "};\n";
            } else {
              outfile << "\\draw[red] (" << vertices(0, 0) << ","
                      << vertices(1, 0) << ") " << "node[] {*};\n";
            }  // if NodeNumOn
            break;
 
          }  // case kPoint
 
          case lf::base::RefEl::kSegment(): {
            center_mat << center, center;
            const Eigen::MatrixXd scaled_vertices =
                vertices * 0.80 + center_mat * 0.2;
            const Eigen::MatrixXd semi_scaled_vertices =
                vertices * 0.95 + center_mat * 0.05;
 
            if (ArrowsOn) {
              if (EdgeNumOn && NodeNumOn) {
                outfile << "\\draw[->] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") -- node[black] {"
                        << obj_idx << "} " << "(" << scaled_vertices(0, 1)
                        << "," << scaled_vertices(1, 1) << ");\n";
              } else if (NodeNumOn && !EdgeNumOn) {
                outfile << "\\draw[->] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") -- " << "("
                        << scaled_vertices(0, 1) << "," << scaled_vertices(1, 1)
                        << ");\n";
              } else if (!NodeNumOn && EdgeNumOn) {
                outfile << "\\draw[->] (" << semi_scaled_vertices(0, 0) << ","
                        << semi_scaled_vertices(1, 0) << ") -- node[black] {"
                        << obj_idx << "} " << "(" << semi_scaled_vertices(0, 1)
                        << "," << semi_scaled_vertices(1, 1) << ");\n";
              } else if (!NodeNumOn && !EdgeNumOn) {
                outfile << "\\draw[->] (" << semi_scaled_vertices(0, 0) << ","
                        << semi_scaled_vertices(1, 0) << ") -- " << "("
                        << semi_scaled_vertices(0, 1) << ","
                        << semi_scaled_vertices(1, 1) << ");\n";
              } else {
                std::cout << "Check EdgeNumOn and NodeNumOn for kSegment "
                          << obj_idx << '\n';
              }
 
            } else {
              if (EdgeNumOn) {
                outfile << "\\draw[] (" << vertices(0, 0) << ","
                        << vertices(1, 0) << ") -- node[black] {" << obj_idx
                        << "} " << "(" << vertices(0, 1) << ","
                        << vertices(1, 1) << ");\n";
              } else if (!EdgeNumOn) {
                outfile << "\\draw[] (" << vertices(0, 0) << ","
                        << vertices(1, 0) << ") -- " << "(" << vertices(0, 1)
                        << "," << vertices(1, 1) << ");\n";
              } else {
                std::cout << "Check EdgeNumOn and NodeNumOn for kSegment "
                          << obj_idx << '\n';
              }
            }  // arrows on
 
            break;
          }  // case kSegment
 
          case lf::base::RefEl::kTria(): {
            center_mat << center, center, center;
            const Eigen::MatrixXd scaled_vertices =
                vertices * 0.70 + center_mat * 0.30;
 
            if (RenderCellsOn) {
              if (VerticeNumOn) {
                outfile << "\\draw[green] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") node[] {0} -- ("
                        << scaled_vertices(0, 1) << "," << scaled_vertices(1, 1)
                        << ") node[] {1} -- (" << scaled_vertices(0, 2) << ","
                        << scaled_vertices(1, 2) << ") node[] {2} -- cycle;\n";
              } else {
                outfile << "\\draw[green] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") -- ("
                        << scaled_vertices(0, 1) << "," << scaled_vertices(1, 1)
                        << ") -- (" << scaled_vertices(0, 2) << ","
                        << scaled_vertices(1, 2) << ") -- cycle;\n";
              }  // if EdgeNumOn
 
              if (CellNumOn) {
                outfile << "\\draw[green] (" << center(0, 0) << ","
                        << center(1, 0) << ") node[] {" << obj_idx << "};\n";
              }
 
            }  // RenderCellsOn
            break;
          }  // case kTria
 
          case lf::base::RefEl::kQuad(): {
            center_mat << center, center, center, center;
            const Eigen::MatrixXd scaled_vertices =
                vertices * 0.70 + center_mat * 0.3;
 
            if (RenderCellsOn) {
              if (VerticeNumOn) {
                outfile << "\\draw[magenta] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") node[] {0} -- ("
                        << scaled_vertices(0, 1) << "," << scaled_vertices(1, 1)
                        << ") node[] {1} -- (" << scaled_vertices(0, 2) << ","
                        << scaled_vertices(1, 2) << ") node[] {2} -- ("
                        << scaled_vertices(0, 3) << "," << scaled_vertices(1, 3)
                        << ") node[] {3} -- cycle;\n";
              } else {
                outfile << "\\draw[magenta] (" << scaled_vertices(0, 0) << ","
                        << scaled_vertices(1, 0) << ") -- ("
                        << scaled_vertices(0, 1) << "," << scaled_vertices(1, 1)
                        << ") -- (" << scaled_vertices(0, 2) << ","
                        << scaled_vertices(1, 2) << ") -- ("
                        << scaled_vertices(0, 3) << "," << scaled_vertices(1, 3)
                        << ") -- cycle;\n";
              }
 
              if (CellNumOn) {
                outfile << "\\draw[magenta] (" << center(0, 0) << ","
                        << center(1, 0) << ") node[] {" << obj_idx << "};\n";
              }
 
            }  // RenderCellsOn
 
            break;
          }  // case kQuad
 
          default: {
            std::cout << "Error for object " << obj_idx << " in co-dim "
                      << co_dim << '\n';
            std::cout << "Object type: " << obj_refel << '\n';
            break;
          }  // default
        }  // switch
      }  // IF SELECTOR --------------------
    }  // for entities
 
    node_count++;
    // LF_VERIFY_MSG(node_count == no_of_nodes, "Node count mismatch");
  }  // for codim
 
  outfile << "\\end{tikzpicture}\n";
  if (WithPreamble) {
    outfile << "\n\\end{document}" << '\n';
  }
  return true;
}  // writetikz
 
// Second version of writeTikZ using default selector
bool writeTikZ(const lf::mesh::Mesh &mesh, const std::string &filename,
               TikzOutputCtrl output_ctrl) {
  return writeTikZ(mesh, filename, base::PredicateTrue{}, output_ctrl);
}
 
}  // namespace lf::io