IOSS 2.0

Ioss_NodeBlock.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_NodeBlock_h
34 #define IOSS_Ioss_NodeBlock_h
35
36 #include "Ioss_EntityType.h" // for EntityType, etc
37 #include "Ioss_Property.h" // for Property
38 #include <Ioss_EntityBlock.h>
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 all nodes in the region.
52 */
53 class NodeBlock : public EntityBlock
54 {
55 public:
56 NodeBlock(DatabaseIO *io_database, const std::string &my_name, int64_t node_count,
57 int64_t degrees_of_freedom);
58
59 ~NodeBlock() override;
60
61 std::string type_string() const override { return "NodeBlock"; }
62 std::string short_type_string() const override { return "nodeblock"; }
63 std::string contains_string() const override { return "Node"; }
64 EntityType type() const override { return NODEBLOCK; }
65
66 bool is_nonglobal_nodeblock() const { return properties.exists("IOSS_INTERNAL_CONTAINED_IN"); }
67
68 virtual const GroupingEntity *contained_in() const override
69 {
70 if (properties.exists("IOSS_INTERNAL_CONTAINED_IN")) {
71 auto ge = properties.get("IOSS_INTERNAL_CONTAINED_IN").get_pointer();
72 return static_cast<const GroupingEntity *>(ge);
73 }
74 else {
75 return GroupingEntity::contained_in();
76 }
77 }
78
79 // Handle implicit properties -- These are calcuated from data stored
80 // in the grouping entity instead of having an explicit value assigned.
81 // An example would be 'element_block_count' for a region.
82 Property get_implicit_property(const std::string &my_name) const override;
83
84 protected:
85 int64_t internal_get_field_data(const Field &field, void *data,
86 size_t data_size) const override;
87
88 int64_t internal_put_field_data(const Field &field, void *data,
89 size_t data_size) const override;
90 };
91 } // namespace Ioss
92 #endif
Ioss::NodeBlock::type
EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition: Ioss_NodeBlock.h:64
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Ioss_Property.h
Ioss::PropertyManager::exists
bool exists(const std::string &property_name) const
Checks if a property exists in the database.
Definition: Ioss_PropertyManager.C:77
Ioss::GroupingEntity::contained_in
virtual const GroupingEntity * contained_in() const
Definition: Ioss_GroupingEntity.C:94
Ioss::PropertyManager::get
Property get(const std::string &property_name) const
Get a property object from the property manager.
Definition: Ioss_PropertyManager.C:88
Ioss::NodeBlock::~NodeBlock
~NodeBlock() override
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::NodeBlock::internal_get_field_data
int64_t internal_get_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_NodeBlock.C:108
Ioss::GroupingEntity::properties
PropertyManager properties
Definition: Ioss_GroupingEntity.h:292
Ioss::EntityType
EntityType
The particular type of GroupingEntity.
Definition: Ioss_EntityType.h:39
Ioss_EntityType.h
Ioss::Property::get_pointer
void * get_pointer() const
Get the property value if it is of type POINTER.
Definition: Ioss_Property.C:216
Ioss::NodeBlock::is_nonglobal_nodeblock
bool is_nonglobal_nodeblock() const
Definition: Ioss_NodeBlock.h:66
Ioss::DatabaseIO
An input or output Database.
Definition: Ioss_DatabaseIO.h:82
Ioss::NodeBlock::contained_in
virtual const GroupingEntity * contained_in() const override
Definition: Ioss_NodeBlock.h:68
Ioss::NodeBlock::NodeBlock
NodeBlock(DatabaseIO *io_database, const std::string &my_name, int64_t node_count, int64_t degrees_of_freedom)
Create a node block.
Definition: Ioss_NodeBlock.C:52
Ioss::EntityBlock
Base class for all 'block'-type grouping entities, which means all members of the block are similar o...
Definition: Ioss_EntityBlock.h:61
Ioss::NODEBLOCK
Definition: Ioss_EntityType.h:40
Ioss::NodeBlock::short_type_string
std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition: Ioss_NodeBlock.h:62
Ioss::NodeBlock::internal_put_field_data
int64_t internal_put_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_NodeBlock.C:114
Ioss::NodeBlock::type_string
std::string type_string() const override
Get the name of the particular type of entity.
Definition: Ioss_NodeBlock.h:61
Ioss::NodeBlock::contains_string
std::string contains_string() const override
What does this entity contain.
Definition: Ioss_NodeBlock.h:63
Ioss::NodeBlock::get_implicit_property
Property get_implicit_property(const std::string &my_name) const override
Calculate and get an implicit property.
Definition: Ioss_NodeBlock.C:103
anonymous_namespace{cth_pressure_map.C}::data
std::vector< char > data
Definition: cth_pressure_map.C:74
Ioss::NodeBlock
A collection of all nodes in the region.
Definition: Ioss_NodeBlock.h:53
Ioss::Property
A named value that has a known type.
Definition: Ioss_Property.h:47
Ioss::GroupingEntity
Base class for all 'grouping' entities. The following derived classes are typical:
Definition: Ioss_GroupingEntity.h:93
Ioss_EntityBlock.h