exodusII_io.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 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_EXODUSII_IO_H
#define LIBMESH_EXODUSII_IO_H


// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/mesh_input.h"
#include "libmesh/mesh_output.h"
#include "libmesh/parallel_object.h"
#include "libmesh/boundary_info.h" // BoundaryInfo::BCTuple
#include "libmesh/exodus_header_info.h"

namespace libMesh
{

// Forward declarations
class EquationSystems;
class ExodusII_IO_Helper;
class MeshBase;
class System;

class ExodusII_IO : public MeshInput<MeshBase>,
                    public MeshOutput<MeshBase>,
                    public ParallelObject
{
public:

  explicit
  ExodusII_IO (MeshBase & mesh,
               bool single_precision=false);

  explicit
  ExodusII_IO (const MeshBase & mesh,
               bool single_precision=false);

  ExodusII_IO (ExodusII_IO &&) = default;
  ExodusII_IO (const ExodusII_IO &) = delete;
  ExodusII_IO & operator= (const ExodusII_IO &) = delete;
  ExodusII_IO & operator= (ExodusII_IO &&) = delete;
  virtual ~ExodusII_IO ();

  static int get_exodus_version();

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

  ExodusHeaderInfo read_header (const std::string & name);

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

  void verbose (bool set_verbosity);

  void write_complex_magnitude (bool val);

  void write_added_sides (bool val);

  virtual bool get_add_sides () override;

  const std::vector<Real> & get_time_steps();

  int get_num_time_steps();

  void copy_nodal_solution(System & system,
                           std::string system_var_name,
                           std::string exodus_var_name,
                           unsigned int timestep=1);

  void copy_elemental_solution(System & system,
                               std::string system_var_name,
                               std::string exodus_var_name,
                               unsigned int timestep=1);

  void copy_scalar_solution(System & system,
                            std::vector<std::string> system_var_names,
                            std::vector<std::string> exodus_var_names,
                            unsigned int timestep=1);

  void read_elemental_variable(std::string elemental_var_name,
                               unsigned int timestep,
                               std::map<unsigned int, Real> & unique_id_to_value_map);

  void read_global_variable(std::vector<std::string> global_var_names,
                            unsigned int timestep,
                            std::vector<Real> & global_values);

  void write_discontinuous_exodusII (const std::string & name,
                                     const EquationSystems & es,
                                     const std::set<std::string> * system_names=nullptr);

  void write_timestep_discontinuous (const std::string &fname,
                                     const EquationSystems &es,
                                     const int timestep,
                                     const Real time,
                                     const std::set<std::string> * system_names=nullptr);

  void write_element_data (const EquationSystems & es);

  void
  write_element_data_from_discontinuous_nodal_data
  (const EquationSystems & es,
   const std::set<std::string> * system_names = nullptr,
   const std::string & var_suffix = "_elem_node_");

  using MeshOutput<MeshBase>::write_nodal_data;
  using MeshOutput<MeshBase>::write_nodal_data_discontinuous;

  virtual void write_nodal_data (const std::string &,
                                 const std::vector<Number> &,
                                 const std::vector<std::string> &) override;

  void write_nodal_data_discontinuous (const std::string &,
                                       const std::vector<Number> &,
                                       const std::vector<std::string> &) override;

  void write_global_data (const std::vector<Number> &,
                          const std::vector<std::string> &);

  void write_information_records (const std::vector<std::string> &);

  void write_timestep (const std::string & fname,
                       const EquationSystems & es,
                       const int timestep,
                       const Real time,
                       const std::set<std::string> * system_names=nullptr);

  virtual void write_equation_systems (const std::string & fname,
                                       const EquationSystems & es,
                                       const std::set<std::string> * system_names=nullptr) override;

  void write_elemsets();

  void
  write_sideset_data (int timestep,
                      const std::vector<std::string> & var_names,
                      const std::vector<std::set<boundary_id_type>> & side_ids,
                      const std::vector<std::map<BoundaryInfo::BCTuple, Real>> & bc_vals);

  void
  read_sideset_data (int timestep,
                     std::vector<std::string> & var_names,
                     std::vector<std::set<boundary_id_type>> & side_ids,
                     std::vector<std::map<BoundaryInfo::BCTuple, Real>> & bc_vals);

  void
  get_sideset_data_indices (std::map<BoundaryInfo::BCTuple, unsigned int> & bc_array_indices);

  void
  write_nodeset_data (int timestep,
                      const std::vector<std::string> & var_names,
                      const std::vector<std::set<boundary_id_type>> & node_boundary_ids,
                      const std::vector<std::map<BoundaryInfo::NodeBCTuple, Real>> & bc_vals);

  void
  read_nodeset_data (int timestep,
                     std::vector<std::string> & var_names,
                     std::vector<std::set<boundary_id_type>> & node_boundary_ids,
                     std::vector<std::map<BoundaryInfo::NodeBCTuple, Real>> & bc_vals);

  void
  get_nodeset_data_indices (std::map<BoundaryInfo::NodeBCTuple, unsigned int> & bc_array_indices);

  void
  write_elemset_data (int timestep,
                      const std::vector<std::string> & var_names,
                      const std::vector<std::set<elemset_id_type>> & elemset_ids_in,
                      const std::vector<std::map<std::pair<dof_id_type, elemset_id_type>, Real>> & elemset_vals);

  void
  read_elemset_data (int timestep,
                     std::vector<std::string> & var_names,
                     std::vector<std::set<elemset_id_type>> & elemset_ids_in,
                     std::vector<std::map<std::pair<dof_id_type, elemset_id_type>, Real>> & elemset_vals);

  void
  get_elemset_data_indices (std::map<std::pair<dof_id_type, elemset_id_type>, unsigned int> & elemset_array_indices);

  void set_extra_integer_vars(const std::vector<std::string> & extra_integer_vars);

  void set_output_variables(const std::vector<std::string> & output_variables,
                            bool allow_empty = true);

  void use_mesh_dimension_instead_of_spatial_dimension(bool val);

  void write_as_dimension(unsigned dim);

  void set_coordinate_offset(Point p);

  void append(bool val);

  const std::vector<std::string> & get_elem_var_names();

  const std::vector<std::string> & get_nodal_var_names();

  const std::vector<std::string> & get_global_var_names();

  const std::vector<int> & get_elem_num_map() const;

  const std::vector<int> & get_node_num_map() const;

#ifdef LIBMESH_HAVE_EXODUS_API

  ExodusII_IO_Helper & get_exio_helper();
#endif

  void set_hdf5_writing(bool write_hdf5);

  void set_discontinuous_bex(bool disc_bex);

  void write_nodal_data_common(std::string fname,
                               const std::vector<std::string> & names,
                               bool continuous=true);

private:
#ifdef LIBMESH_HAVE_EXODUS_API
  std::unique_ptr<ExodusII_IO_Helper> exio_helper;

  int _timestep;

  bool _verbose;

  bool _append;
#endif

  std::vector<std::string> _extra_integer_vars;

  std::vector<std::string> _output_variables;

  bool _allow_empty_variables;

  bool _write_complex_abs;

  bool _disc_bex;
};


} // namespace libMesh


#endif // LIBMESH_EXODUSII_IO_H