IOSS 2.0

Ioss_NodeSet.h
Go to the documentation of this file.
1 // Copyright(C) 1999-2017 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 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following
14 // disclaimer in the documentation and/or other materials provided
15 // with the distribution.
16 //
17 // * Neither the name of NTESS nor the names of its
18 // contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 #ifndef IOSS_Ioss_NodeSet_h
34 #define IOSS_Ioss_NodeSet_h
35
36 #include "Ioss_EntityType.h" // for EntityType, etc
37 #include "Ioss_Property.h" // for Property
38 #include <Ioss_EntitySet.h> // for EntitySet
39 #include <cstddef> // for size_t
40 #include <cstdint> // for int64_t
41 #include <string> // for string
42 namespace Ioss {
43 class DatabaseIO;
44 } // namespace Ioss
45 namespace Ioss {
46 class Field;
47 } // namespace Ioss
48
49 namespace Ioss {
50
51 /** \brief A collection of nodes.
52 */
53 class NodeSet : public EntitySet
54 {
55 public:
56 NodeSet(); // Used for template typing only
57 NodeSet(DatabaseIO *io_database, const std::string &my_name, int64_t number_nodes);
58
59 std::string type_string() const override { return "NodeSet"; }
60 std::string short_type_string() const override { return "nodelist"; }
61 EntityType type() const override { return NODESET; }
62
63 // Handle implicit properties -- These are calcuated from data stored
64 // in the grouping entity instead of having an explicit value assigned.
65 // An example would be 'element_block_count' for a region.
66 Property get_implicit_property(const std::string &my_name) const override;
67
68 protected:
69 int64_t internal_get_field_data(const Field &field, void *data,
70 size_t data_size) const override;
71
72 int64_t internal_put_field_data(const Field &field, void *data,
73 size_t data_size) const override;
74 };
75 } // namespace Ioss
76 #endif
Ioss::Property
A named value that has a known type.
Definition: Ioss_Property.h:47
Ioss::NodeSet::get_implicit_property
Property get_implicit_property(const std::string &my_name) const override
Calculate and get an implicit property.
Definition: Ioss_NodeSet.C:72
Ioss_Property.h
Ioss
The main namespace for the Ioss library.
Definition: Iocgns_DatabaseIO.h:50
Ioss::DatabaseIO
An input or output Database.
Definition: Ioss_DatabaseIO.h:80
Ioss::EntitySet
Base class for all &#39;set&#39;-type grouping entities, which means that members of the set are not necessar...
Definition: Ioss_EntitySet.h:61
Ioss::NodeSet
A collection of nodes.
Definition: Ioss_NodeSet.h:53
Ioss::NodeSet::internal_get_field_data
int64_t internal_get_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_NodeSet.C:60
Ioss::NodeSet::short_type_string
std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition: Ioss_NodeSet.h:60
Ioss::NodeSet::type
EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition: Ioss_NodeSet.h:61
Ioss::NodeSet::type_string
std::string type_string() const override
Get the name of the particular type of entity.
Definition: Ioss_NodeSet.h:59
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Ioss_EntitySet.h
Ioss::NODESET
Definition: Ioss_EntityType.h:44
Ioss::NodeSet::NodeSet
NodeSet()
Definition: Ioss_NodeSet.C:46
Ioss::NodeSet::internal_put_field_data
int64_t internal_put_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_NodeSet.C:66
Ioss::EntityType
EntityType
The particular type of GroupingEntity.
Definition: Ioss_EntityType.h:39
anonymous_namespace{Ioss_Utils.C}::data
std::vector< char > data
Definition: Ioss_Utils.C:78
Ioss_EntityType.h