seacas-docs/ioss_html/Ios3__DatabaseIO_8h_source.html

// Copyright(C) 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 "ios3_export.h"


#include "Ioss_DatabaseIO.h" // for DatabaseIO

#include "Ioss_IOFactory.h"  // for IOFactory


#include "Ios3_AwsHelpers.h"


namespace Ios3 {


  class IOS3_EXPORT IOFactory : public Ioss::IOFactory

  {

  public:

    static const IOFactory *factory();


  private:

    IOFactory();

    Ioss::DatabaseIO *make_IO(const std::string &filename, Ioss::DatabaseUsage db_usage,

                              Ioss_MPI_Comm                communicator,

                              const Ioss::PropertyManager &properties) const;

  };


  class IOS3_EXPORT DatabaseIO : public Ioss::DatabaseIO

  {

  private:

    bool put_properties() const;

    void finalize_database() const override;


  public:

    DatabaseIO(Ioss::Region *region, const std::string &filename, Ioss::DatabaseUsage db_usage,

               Ioss_MPI_Comm communicator, const Ioss::PropertyManager &props);


    ~DatabaseIO() override;


    // Check capabilities of input/output database...  Returns an

    // unsigned int with the supported Ioss::EntityTypes or'ed

    // together. If "return_value & Ioss::EntityType" is set, then the

    // database supports that type (e.g. return_value & Ioss::FACESET)


    IOSS_NODISCARD virtual unsigned entity_field_support() const override

    {

      return Ioss::NODEBLOCK | Ioss::EDGEBLOCK | Ioss::FACEBLOCK | Ioss::ELEMENTBLOCK |

             Ioss::NODESET | Ioss::EDGESET | Ioss::FACESET | Ioss::ELEMENTSET | Ioss::SIDESET |

             Ioss::SIDEBLOCK | Ioss::REGION | Ioss::SUPERELEMENT;

    }


    int spatial_dimension() const { return spatialDimension; }

    int node_block_count() const { return nodeBlockCount; }

    int element_block_count() const { return elementBlockCount; }

    int nodeset_count() const { return nodesetCount; }

    int sideset_count() const { return sidesetCount; }


    /** Return a string specifying underlying format of database (exodus, cgns, ...) */

    IOSS_NODISCARD virtual std::string get_format() const override { return "s3"; };


    IOSS_NODISCARD virtual int int_byte_size_db() const override { return sizeof(int); }


    virtual int64_t get_field_internal(const Ioss::Region *reg, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::NodeBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::EdgeBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::FaceBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::ElementBlock *eb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::SideBlock *fb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::NodeSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::EdgeSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::FaceSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::ElementSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::SideSet *fs, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::CommSet *cs, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t get_field_internal(const Ioss::StructuredBlock *sb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    IOSS_NOOP_GFI(Ioss::Assembly)

    IOSS_NOOP_GFI(Ioss::Blob)


    virtual int64_t put_field_internal(const Ioss::Region *reg, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::NodeBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::EdgeBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::FaceBlock *nb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::ElementBlock *eb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::SideBlock *fb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::NodeSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::EdgeSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::FaceSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::ElementSet *ns, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::SideSet *fs, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::CommSet *cs, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    virtual int64_t put_field_internal(const Ioss::StructuredBlock *sb, const Ioss::Field &field,

                                       void *data, size_t data_size) const override;

    IOSS_NOOP_PFI(Ioss::Assembly)

    IOSS_NOOP_PFI(Ioss::Blob)


  private:

    int64_t get_field_internal(const Ioss::GroupingEntity &e, const Ioss::Field &f, void *data,

                               size_t data_size) const;

    int64_t put_field_internal(const Ioss::GroupingEntity &e, const Ioss::Field &f, void *data,

                               size_t data_size) const;


    virtual bool begin_nl(Ioss::State state) override;

    virtual bool end_nl(Ioss::State state) override;


    virtual void read_meta_data_nl() override;


    void put_qa();

    void put_info();

    void write_meta_data(Ioss::IfDatabaseExistsBehavior behavior);


    /*

     * TODO identify all the get_*{blocks|sets} needed here

     */

    void get_step_times_nl() override;


    void read_region();

    void read_entity_properties(std::vector<std::string> &keys, Ioss::GroupingEntity &entity);

    Ioss::Property read_property(std::vector<unsigned char> &value);

    void           read_entity_fields(std::vector<std::string> &keys, Ioss::GroupingEntity &entity);


    Ioss::Map &get_node_map() const;


    void get_edgeblocks();

    void get_elemblocks();

    void get_faceblocks();

    void get_nodeblocks();

    void get_structuredblocks();


    void get_edgesets();

    void get_elemsets();

    void get_facesets();

    void get_nodesets();

    void get_sidesets();

    void get_commsets();


    int spatialDimension{3};


    int nodeBlockCount{0};

    int elementBlockCount{0};

    int nodesetCount{0};

    int sidesetCount{0};


    mutable Ioss::Map nodeMap;


    Ios3::helpers::HelperParameters               helper_params;

    std::shared_ptr<Ios3::helpers::HelperContext> helper_context;


    std::string bucket_name;

  };


} // namespace Ios3

Ios3_AwsHelpers.h

IOSS_NODISCARD
#define IOSS_NODISCARD
Definition Ioss_CodeTypes.h:57

IOSS_NOOP_PFI
#define IOSS_NOOP_PFI(type)
Definition Ioss_CodeTypes.h:117

Ioss_MPI_Comm
MPI_Comm Ioss_MPI_Comm
Definition Ioss_CodeTypes.h:62

IOSS_NOOP_GFI
#define IOSS_NOOP_GFI(type)
Definition Ioss_CodeTypes.h:112

Ioss_DatabaseIO.h

Ioss_IOFactory.h

Ios3::DatabaseIO::nodeMap
Ioss::Map nodeMap
Definition Ios3_DatabaseIO.h:169

Ios3::DatabaseIO::int_byte_size_db
virtual IOSS_NODISCARD int int_byte_size_db() const override
Definition Ios3_DatabaseIO.h:62

Ios3::DatabaseIO::bucket_name
std::string bucket_name
Definition Ios3_DatabaseIO.h:174

Ios3::DatabaseIO::get_format
virtual IOSS_NODISCARD std::string get_format() const override
Definition Ios3_DatabaseIO.h:60

Ios3::DatabaseIO::helper_context
std::shared_ptr< Ios3::helpers::HelperContext > helper_context
Definition Ios3_DatabaseIO.h:172

Ios3::DatabaseIO::sidesetCount
int sidesetCount
Definition Ios3_DatabaseIO.h:167

Ios3::DatabaseIO::nodesetCount
int nodesetCount
Definition Ios3_DatabaseIO.h:166

Ios3::DatabaseIO::element_block_count
int element_block_count() const
Definition Ios3_DatabaseIO.h:55

Ios3::DatabaseIO::entity_field_support
virtual IOSS_NODISCARD unsigned entity_field_support() const override
Definition Ios3_DatabaseIO.h:46

Ios3::DatabaseIO::spatialDimension
int spatialDimension
Definition Ios3_DatabaseIO.h:162

Ios3::DatabaseIO::nodeBlockCount
int nodeBlockCount
Definition Ios3_DatabaseIO.h:164

Ios3::DatabaseIO::finalize_database
void finalize_database() const override
Definition Ios3_DatabaseIO.C:93

Ios3::DatabaseIO::elementBlockCount
int elementBlockCount
Definition Ios3_DatabaseIO.h:165

Ios3::DatabaseIO::helper_params
Ios3::helpers::HelperParameters helper_params
Definition Ios3_DatabaseIO.h:171

Ios3::DatabaseIO::spatial_dimension
int spatial_dimension() const
Definition Ios3_DatabaseIO.h:53

Ios3::DatabaseIO::nodeset_count
int nodeset_count() const
Definition Ios3_DatabaseIO.h:56

Ios3::DatabaseIO::node_block_count
int node_block_count() const
Definition Ios3_DatabaseIO.h:54

Ios3::DatabaseIO::put_properties
bool put_properties() const
Definition Ios3_DatabaseIO.C:75

Ios3::DatabaseIO::sideset_count
int sideset_count() const
Definition Ios3_DatabaseIO.h:57

Ios3::DatabaseIO::DatabaseIO
DatabaseIO(Ioss::Region *region, const std::string &filename, Ioss::DatabaseUsage db_usage, Ioss_MPI_Comm communicator, const Ioss::PropertyManager &props)
Definition Ios3_DatabaseIO.C:50

Ios3::IOFactory::factory
static const IOFactory * factory()
Definition Ios3_DatabaseIO.C:35

Ios3::IOFactory::make_IO
Ioss::DatabaseIO * make_IO(const std::string &filename, Ioss::DatabaseUsage db_usage, Ioss_MPI_Comm communicator, const Ioss::PropertyManager &properties) const
Definition Ios3_DatabaseIO.C:43

Ios3::IOFactory::IOFactory
IOFactory()
Definition Ios3_DatabaseIO.C:41

Ioss::Assembly
A homogeneous collection of other GroupingEntities.
Definition Ioss_Assembly.h:31

Ioss::Blob
A homogeneous collection of other GroupingEntities.
Definition Ioss_Blob.h:31

Ioss::CommSet
Definition Ioss_CommSet.h:27

Ioss::DatabaseIO
An input or output Database.
Definition Ioss_DatabaseIO.h:63

Ioss::EdgeBlock
A collection of element edges with the same topology.
Definition Ioss_EdgeBlock.h:29

Ioss::EdgeSet
A collection of element edges.
Definition Ioss_EdgeSet.h:30

Ioss::ElementBlock
A collection of elements having the same topology.
Definition Ioss_ElementBlock.h:29

Ioss::ElementSet
A collection of elements.
Definition Ioss_ElementSet.h:30

Ioss::FaceBlock
A collection of element faces with the same topology.
Definition Ioss_FaceBlock.h:29

Ioss::FaceSet
A collection of element faces.
Definition Ioss_FaceSet.h:30

Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition Ioss_Field.h:28

Ioss::GroupingEntity
Base class for all 'grouping' entities. The following derived classes are typical:
Definition Ioss_GroupingEntity.h:67

Ioss::IOFactory
The main public user interface for creating Ioss::DatabaseIO objects.
Definition Ioss_IOFactory.h:35

Ioss::Map
Definition Ioss_Map.h:46

Ioss::NodeBlock
A collection of all nodes in the region.
Definition Ioss_NodeBlock.h:33

Ioss::NodeSet
A collection of nodes.
Definition Ioss_NodeSet.h:29

Ioss::PropertyManager
A collection of Ioss::Property objects.
Definition Ioss_PropertyManager.h:36

Ioss::Property
A named value that has a known type.
Definition Ioss_Property.h:27

Ioss::Region
A grouping entity that contains other grouping entities.
Definition Ioss_Region.h:93

Ioss::SideBlock
A collection of element sides having the same topology.
Definition Ioss_SideBlock.h:37

Ioss::SideSet
A collection of element sides.
Definition Ioss_SideSet.h:29

Ioss::StructuredBlock
A structured zone – i,j,k.
Definition Ioss_StructuredBlock.h:91

Ios3
Definition Ios3_AwsHelpers.C:58

Ios3::data_size
size_t data_size(const Ioss::Field &f)
Definition Ios3_FieldSerialization.C:12

Ioss::State
State
Access states for a database.
Definition Ioss_State.h:15

Ioss::DatabaseUsage
DatabaseUsage
Specifies how an Ioss::DatabaseIO object will be used.
Definition Ioss_DBUsage.h:13

Ioss::IfDatabaseExistsBehavior
IfDatabaseExistsBehavior
Definition Ioss_DBUsage.h:32

Ioss::EDGESET
@ EDGESET
Definition Ioss_EntityType.h:18

Ioss::SIDEBLOCK
@ SIDEBLOCK
Definition Ioss_EntityType.h:24

Ioss::FACESET
@ FACESET
Definition Ioss_EntityType.h:19

Ioss::ELEMENTBLOCK
@ ELEMENTBLOCK
Definition Ioss_EntityType.h:16

Ioss::REGION
@ REGION
Definition Ioss_EntityType.h:25

Ioss::EDGEBLOCK
@ EDGEBLOCK
Definition Ioss_EntityType.h:14

Ioss::SUPERELEMENT
@ SUPERELEMENT
Definition Ioss_EntityType.h:26

Ioss::FACEBLOCK
@ FACEBLOCK
Definition Ioss_EntityType.h:15

Ioss::NODEBLOCK
@ NODEBLOCK
Definition Ioss_EntityType.h:13

Ioss::SIDESET
@ SIDESET
Definition Ioss_EntityType.h:21

Ioss::NODESET
@ NODESET
Definition Ioss_EntityType.h:17

Ioss::ELEMENTSET
@ ELEMENTSET
Definition Ioss_EntityType.h:20

Ios3::helpers::HelperParameters
Definition Ios3_AwsHelpers.h:27