shell_interface.h

Go to the documentation of this file.

/*
 * Copyright(C) 1999-2025 National Technology & Engineering Solutions
 * of Sandia, LLC (NTESS).  Under the terms of Contract DE-NA0003525 with
 * NTESS, the U.S. Government retains certain rights in this software.
 *
 * See packages/seacas/LICENSE for details
 */
#pragma once
 
#include <iosfwd>
#include <limits>
#include <string>
#include <vector>
 
#include "Ioss_GetLongOpt.h"
 
/** \brief A special namespace for the io_shell demonstration program interFace.
 */
namespace IOShell {
  class Interface
  {
  public:
    explicit Interface(std::string app_version);
 
    bool parse_options(int argc, char **argv, int my_processor);
 
    //! Dumps representation of data in this class to cerr
 
    void enroll_options();
 
    Ioss::GetLongOption options_;
 
    std::vector<std::string> inputFile;
    std::string              version{};
    std::string              outputFile;
    std::string              inFiletype{"unknown"};
    std::string              outFiletype{"unknown"};
    std::string              changeSetName;
    std::string              selectedChangeSets;
    std::string              decomp_method;
    std::string              decomp_extra{"processor_id"};
    std::string              compose_output{"default"};
    std::string              customField{};
    double                   maximum_time{std::numeric_limits<double>::max()};
    double                   minimum_time{-std::numeric_limits<double>::max()};
    double                   append_time{std::numeric_limits<double>::max()};
    double                   time_scale{1.0};
    double                   time_offset{0.0};
    double                   timestep_delay{0.0};
    double                   rel_tolerance{0.0};
    double                   abs_tolerance{0.0};
    double                   tol_floor{0.0};
    int                      append_step{std::numeric_limits<int>::max()};
    int                      surface_split_type{-1};
    int                      data_storage_type{0};
    int                      compression_level{0};
    int                      quantize_nsd{0};
    int                      serialize_io_size{0};
    int                      flush_interval{0};
 
    //! If non-empty, then it is a list of times that should be transferred to the output file.
    std::vector<double> selected_times{};
 
    //! If non-empty, then it is a list of steps that should be transferred to the output file.
    //  A negative value counts from end. -1 is last, -2 is second last...
    std::vector<int> selected_steps{};
 
    //! If non-empty, then it is a list of element blocks, nodesets,
    //! sidesets that should be omitted from the output file
    std::vector<std::string> omitted_blocks{};
    std::vector<std::string> omitted_sets{};
 
    //! If non-empty, a list of element block ids and/or names that
    //! should be omitted in a parallel decomposition. The blocks will
    //! still appear in the decomposed files, but will not affect the
    //! balance. Only active element blocks will be load-balanced.
    std::vector<int> decomp_omitted_block_ids{};
    std::string      decomp_omitted_block_names{};
 
    //! If non-zero, then put `split_times` timesteps in each file. Then close file and start new
    //! file.
    // If `split_cyclic == 0`, then filenames will be
    // filename.e-s000X; if `split_cyclic > 0`, then filenames will be
    // filename.e.{A|B|C...}
    int split_times{0};
    //! If non-zero, then the `split_times` timesteps will be put into
    // `split_cyclic` files and then recycle filenames.  For example:
    // `split_times=1` and `split_cyclic=3`, t=1 ->file.A, t=2
    // ->file.B, t=3 -> file.C, t=4 -> file.A If `split_times=2` and
    // `split_cyclic=2`, then t=1,2 -> file.A, t=3,4 -> file.B, t=5,6
    // -> file.A, t=7,8 -> file.B
    int  split_cyclic{0};
    bool shuffle{false};
    bool zlib{false};
    bool szip{false};
    bool zstd{false};
    bool bz2{false};
    bool quant{false};
    bool debug{false};
    bool detect_nans{false};
    bool statistics{false};
    bool memory_statistics{false};
    bool do_transform_fields{false};
    bool ints_64_bit{false};
    bool ints_32_bit{false};
    bool reals_32_bit{false};
    bool netcdf3{false};
    bool netcdf4{false};
    bool netcdf5{false};
    bool quiet{false};
    bool in_memory_read{false};
    bool in_memory_write{false};
    bool lowercase_variable_names{false};
    bool lowercase_database_names{false};
    bool delete_timesteps{false};
    bool minimize_open_files{false};
    bool disable_field_recognition{false};
    bool retain_empty_blocks{false};
    // Put transient data for each timestep in separate file (EXPERIMENTAL)
    bool file_per_state{false};
    // Testing CGNS - defines zones in reverse order from input file.
    bool reverse{false};
    bool add_processor_id_field{false};
    bool boundary_sideset{false};
    bool compare{false};
    bool ignore_qa_info{false};
    bool ignore_node_map{false};
    bool ignore_elem_map{false};
    bool ignore_edge_map{false};
    bool ignore_face_map{false};
    bool delete_qa{false};
    bool delete_info{false};
    bool line_decomp{false};
    char fieldSuffixSeparator{'_'};
  };
  class Interface {…};
} // namespace IOShell
namespace IOShell {…}