ensight_io.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


#ifndef LIBMESH_ENSIGHT_IO_H
#define LIBMESH_ENSIGHT_IO_H

// libMesh includes
#include "libmesh/libmesh.h"
#include "libmesh/mesh_base.h"
#include "libmesh/mesh_output.h"

// C++ includes
#include <map>
#include <string>
#include <vector>

namespace libMesh
{

// Forward declarations
class EquationSystems;
enum ElemType : int;

class EnsightIO : public MeshOutput<MeshBase>
{
public:

  EnsightIO (const std::string & filename,
             const EquationSystems & eq);

  ~EnsightIO () = default;

  void add_scalar (const std::string & system,
                   std::string_view scalar_description,
                   std::string_view s);

  void add_vector (const std::string & system,
                   std::string_view vec_description,
                   std::string u,
                   std::string v);

  void add_vector (const std::string & system,
                   std::string_view vec_description,
                   std::string u,
                   std::string v,
                   std::string w);
  void write (Real time = 0);

  virtual void write (const std::string & name) override;

private:
  // Represents the vectors that are used by the EnsightIO
  struct Vectors
  {
    std::string description;
    std::vector<std::string> components;
  };

  // Represents the scalars
  struct Scalars
  {
    std::string scalar_name;
    std::string description;
  };

  // Store the variables of system
  struct SystemVars
  {
    std::vector<Vectors> EnsightVectors;
    std::vector<Scalars> EnsightScalars;
  };

  // private methods
  // write solution in ascii format file
  void write_ascii (Real time = 0);
  void write_scalar_ascii (std::string_view sys, std::string_view var);
  void write_vector_ascii (std::string_view sys, const std::vector<std::string> & vec, std::string_view var_name);
  void write_solution_ascii ();
  void write_geometry_ascii ();
  void write_case();

  // private Attributes
  std::string _ensight_file_name;
  std::vector<Real> _time_steps;

  // mapping from system names to variable names+descriptions
  std::map <std::string, SystemVars> _system_vars_map;

  // Reference to the EquationSystems we were constructed with
  const EquationSystems & _equation_systems;

  // static mapping between libmesh ElemTypes and Ensight element strings.
  static std::map<ElemType, std::string> _element_map;

  // Static function used to build the _element_map.
  static std::map<ElemType, std::string> build_element_map();
};


} // namespace libMesh


#endif // LIBMESH_ENSIGHT_IO_H