IOSS 2.0

Ioss_SideSet.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_SideSet_h
34 #define IOSS_Ioss_SideSet_h
35
36 #include "Ioss_EntityType.h" // for EntityType, etc
37 #include <Ioss_GroupingEntity.h> // for GroupingEntity
38 #include <Ioss_Property.h> // for Property
39 #include <cstddef> // for size_t
40 #include <cstdint> // for int64_t
41 #include <string> // for string
42 #include <vector> // for vector
43
44 namespace Ioss {
45 class DatabaseIO;
46 class Field;
47 class SideBlock;
48
49 using SideBlockContainer = std::vector<SideBlock *>;
50
51 /** \brief A collection of element sides.
52 */
53 class SideSet : public GroupingEntity
54 {
55 public:
56 SideSet(DatabaseIO *io_database, const std::string &my_name);
57 ~SideSet() override;
58
59 std::string type_string() const override { return "SideSet"; }
60 std::string short_type_string() const override { return "surface"; }
61 std::string contains_string() const override { return "Element/Side pair"; }
62 EntityType type() const override { return SIDESET; }
63
64 bool add(SideBlock *side_block);
65 const SideBlockContainer &get_side_blocks() const;
66 SideBlock * get_side_block(const std::string &my_name) const;
67 size_t side_block_count() const { return sideBlocks.size(); }
68
69 size_t block_count() const { return sideBlocks.size(); }
70 SideBlock *get_block(size_t which) const;
71
72 void block_membership(std::vector<std::string> &block_members) override;
73
74 // Handle implicit properties -- These are calcuated from data stored
75 // in the grouping entity instead of having an explicit value assigned.
76 // An example would be 'element_block_count' for a region.
77 Property get_implicit_property(const std::string &my_name) const override;
78
79 int max_parametric_dimension() const;
80
81 protected:
82 int64_t internal_get_field_data(const Field &field, void *data,
83 size_t data_size) const override;
84
85 int64_t internal_put_field_data(const Field &field, void *data,
86 size_t data_size) const override;
87
88 private:
89 SideBlockContainer sideBlocks;
90 std::vector<std::string> blockMembership; // What element blocks do the
91 // elements in this sideset belong to.
92 };
93 } // namespace Ioss
94 #endif
Ioss::SideSet::sideBlocks
SideBlockContainer sideBlocks
Definition: Ioss_SideSet.h:89
Ioss::SideBlockContainer
std::vector< SideBlock * > SideBlockContainer
Definition: Ioss_SideSet.h:49
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Ioss_Property.h
Ioss::SideSet::block_count
size_t block_count() const
Definition: Ioss_SideSet.h:69
Ioss::SideSet::type_string
std::string type_string() const override
Get the name of the particular type of entity.
Definition: Ioss_SideSet.h:59
Ioss::SideSet::type
EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition: Ioss_SideSet.h:62
Ioss::SideSet::get_side_blocks
const SideBlockContainer & get_side_blocks() const
Definition: Ioss_SideSet.C:106
Ioss::SideSet::max_parametric_dimension
int max_parametric_dimension() const
Definition: Ioss_SideSet.C:164
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::SideSet::get_block
SideBlock * get_block(size_t which) const
Definition: Ioss_SideSet.C:108
Ioss::SideSet::block_membership
void block_membership(std::vector< std::string > &block_members) override
Get list of blocks that the entities in this GroupingEntity "touch".
Definition: Ioss_SideSet.C:184
Ioss::SideSet::blockMembership
std::vector< std::string > blockMembership
Definition: Ioss_SideSet.h:90
Ioss::EntityType
EntityType
The particular type of GroupingEntity.
Definition: Ioss_EntityType.h:39
Ioss_EntityType.h
Ioss::DatabaseIO
An input or output Database.
Definition: Ioss_DatabaseIO.h:82
Ioss::SideSet::internal_get_field_data
int64_t internal_get_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_SideSet.C:140
Ioss::SideSet::add
bool add(SideBlock *side_block)
Definition: Ioss_SideSet.C:131
Ioss::SideBlock
A collection of element sides having the same topology.
Definition: Ioss_SideBlock.h:59
Ioss::SideSet::~SideSet
~SideSet() override
Definition: Ioss_SideSet.C:95
Ioss::SideSet::get_side_block
SideBlock * get_side_block(const std::string &my_name) const
Definition: Ioss_SideSet.C:118
Ioss::SideSet::side_block_count
size_t side_block_count() const
Definition: Ioss_SideSet.h:67
Ioss::SideSet::internal_put_field_data
int64_t internal_put_field_data(const Field &field, void *data, size_t data_size) const override
Definition: Ioss_SideSet.C:146
Ioss_GroupingEntity.h
Ioss::SideSet::contains_string
std::string contains_string() const override
What does this entity contain.
Definition: Ioss_SideSet.h:61
anonymous_namespace{cth_pressure_map.C}::data
std::vector< char > data
Definition: cth_pressure_map.C:74
Ioss::SideSet::get_implicit_property
Property get_implicit_property(const std::string &my_name) const override
Calculate and get an implicit property.
Definition: Ioss_SideSet.C:152
Ioss::SideSet::short_type_string
std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition: Ioss_SideSet.h:60
Ioss::Property
A named value that has a known type.
Definition: Ioss_Property.h:47
Ioss::SideSet
A collection of element sides.
Definition: Ioss_SideSet.h:53
Ioss::GroupingEntity
Base class for all 'grouping' entities. The following derived classes are typical:
Definition: Ioss_GroupingEntity.h:93
Ioss::SIDESET
Definition: Ioss_EntityType.h:48
Ioss::SideSet::SideSet
SideSet(DatabaseIO *io_database, const std::string &my_name)
Create a side set with no members initially.
Definition: Ioss_SideSet.C:88