IOSS 2.0
Loading...
Searching...
No Matches
Ioss_NodeSet.h
Go to the documentation of this file.
1// Copyright(C) 1999-2020, 2022, 2023, 2024 National Technology & Engineering Solutions
2// of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
3// NTESS, the U.S. Government retains certain rights in this software.
4//
5// See packages/seacas/LICENSE for details
6
7#pragma once
8
9#include "ioss_export.h"
10
11#include "Ioss_EntitySet.h" // for EntitySet
12#include "Ioss_EntityType.h" // for EntityType, etc
13#include "Ioss_Property.h" // for Property
14#include <cstddef> // for size_t
15#include <cstdint> // for int64_t
16#include <string> // for string
17namespace Ioss {
18 class DatabaseIO;
19} // namespace Ioss
20namespace Ioss {
21 class Field;
22} // namespace Ioss
23
24namespace Ioss {
25
26 /** \brief A collection of nodes.
27 */
28 class IOSS_EXPORT NodeSet : public EntitySet
29 {
30 public:
31 NodeSet(); // Used for template typing only
32 NodeSet(const NodeSet &) = default;
33 NodeSet(DatabaseIO *io_database, const std::string &my_name, int64_t number_nodes);
34
35 IOSS_NODISCARD std::string type_string() const override { return "NodeSet"; }
36 IOSS_NODISCARD std::string short_type_string() const override { return "nodelist"; }
37 IOSS_NODISCARD std::string contains_string() const override { return "Node"; }
38 IOSS_NODISCARD EntityType type() const override { return NODESET; }
39
40 // Handle implicit properties -- These are calculated from data stored
41 // in the grouping entity instead of having an explicit value assigned.
42 // An example would be 'element_block_count' for a region.
43 IOSS_NODISCARD Property get_implicit_property(const std::string &my_name) const override;
44
45 protected:
46 int64_t internal_get_field_data(const Field &field, void *data,
47 size_t data_size) const override;
48
49 int64_t internal_put_field_data(const Field &field, void *data,
50 size_t data_size) const override;
51
52 int64_t internal_get_zc_field_data(const Field &field, void **data,
53 size_t *data_size) const override;
54 };
55} // namespace Ioss
#define IOSS_NODISCARD
Definition Ioss_CodeTypes.h:55
An input or output Database.
Definition Ioss_DatabaseIO.h:63
Base class for all 'set'-type grouping entities, which means that members of the set are not necessar...
Definition Ioss_EntitySet.h:38
Holds metadata for bulk data associated with a GroupingEntity.
Definition Ioss_Field.h:25
A collection of nodes.
Definition Ioss_NodeSet.h:29
IOSS_NODISCARD std::string type_string() const override
Get the name of the particular type of entity.
Definition Ioss_NodeSet.h:35
IOSS_NODISCARD std::string contains_string() const override
What does this entity contain.
Definition Ioss_NodeSet.h:37
IOSS_NODISCARD EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition Ioss_NodeSet.h:38
IOSS_NODISCARD std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition Ioss_NodeSet.h:36
NodeSet(const NodeSet &)=default
A named value that has a known type.
Definition Ioss_Property.h:27
The main namespace for the Ioss library.
Definition Ioad_DatabaseIO.C:40
EntityType
The particular type of GroupingEntity.
Definition Ioss_EntityType.h:12
@ NODESET
Definition Ioss_EntityType.h:17