IOSS 2.0

Ioss_Region.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_Region_h
34 #define IOSS_Ioss_Region_h
35
36 #include <Ioss_CoordinateFrame.h> // for CoordinateFrame
37 #include <Ioss_DatabaseIO.h> // for DatabaseIO
38 #include <Ioss_EntityType.h> // for EntityType, etc
39 #include <Ioss_GroupingEntity.h> // for GroupingEntity
40 #include <Ioss_MeshType.h>
41 #include <Ioss_Property.h> // for Property
42 #include <Ioss_State.h> // for State
43 #include <cstddef> // for size_t, nullptr
44 #include <cstdint> // for int64_t
45 #include <functional> // for less
46 #include <iosfwd> // for ostream
47 #include <map> // for map, map<>::value_compare
48 #include <string> // for string, operator<
49 #include <utility> // for pair
50 #include <vector> // for vector
51 namespace Ioss {
52 class CommSet;
53 class EdgeBlock;
54 class EdgeSet;
55 class ElementBlock;
56 class ElementSet;
57 class FaceBlock;
58 class FaceSet;
59 class Field;
60 class NodeBlock;
61 class NodeSet;
62 class SideBlock;
63 class SideSet;
64 class StructuredBlock;
65 } // namespace Ioss
66 // Needed for node_global_to_local inline function.
67
68 namespace Ioss {
69
70 class CoordinateFrame;
71
72 using NodeBlockContainer = std::vector<NodeBlock *>;
73 using EdgeBlockContainer = std::vector<EdgeBlock *>;
74 using FaceBlockContainer = std::vector<FaceBlock *>;
75 using ElementBlockContainer = std::vector<ElementBlock *>;
76
77 using NodeSetContainer = std::vector<NodeSet *>;
78 using EdgeSetContainer = std::vector<EdgeSet *>;
79 using FaceSetContainer = std::vector<FaceSet *>;
80 using ElementSetContainer = std::vector<ElementSet *>;
81
82 using SideSetContainer = std::vector<SideSet *>;
83 using StructuredBlockContainer = std::vector<StructuredBlock *>;
84 using CommSetContainer = std::vector<CommSet *>;
85 using StateTimeContainer = std::vector<double>;
86
87 using CoordinateFrameContainer = std::vector<CoordinateFrame>;
88
89 using AliasMap = std::map<std::string, std::string, std::less<std::string>>;
90
91 /** \brief A grouping entity that contains other grouping entities.
92 *
93 * Maintains a list of NodeBlocks, ElementBlocks, NodeLists, CommLists and Surfaces.
94 * [Similar to the "Composite Pattern" in Design Patterns] All interface to
95 * GroupingEntities is through the Region class; clients of the IO subsystem have no direct
96 * access to the underlying GroupingEntities (other than the Region).
97 */
98 class Region : public GroupingEntity
99 {
100 public:
101 explicit Region(DatabaseIO *iodatabase = nullptr, const std::string &my_name = "");
102
103 ~Region() override;
104
105 std::string type_string() const override { return "Region"; }
106 std::string short_type_string() const override { return "region"; }
107 std::string contains_string() const override { return "Entities"; }
108 EntityType type() const override { return REGION; }
109
110 MeshType mesh_type() const;
111 const std::string mesh_type_string() const;
112 bool node_major() const;
113
114 void output_summary(std::ostream &strm, bool do_transient = true);
115
116 bool supports_field_type(Ioss::EntityType fld_type) const;
117
118 // Helper function...
119 int64_t node_global_to_local(int64_t global, bool must_exist = true) const;
120
121 bool begin_mode(State new_state);
122 bool end_mode(State current_state);
123
124 // Add a new state at this time, return state number
125 virtual int add_state(double time)
126 {
127 IOSS_FUNC_ENTER(m_);
128 return add_state__(time);
129 }
130 virtual int add_state__(double time);
131
132 // Get time corresponding to specified state
133
134 virtual double get_state_time(int state = -1) const;
135 int get_current_state() const;
136 double begin_state(int state);
137 double end_state(int state);
138
139 /** \brief Determine whether the metadata defining the model (nontransient,
140 * geometry, and toploloty) has been set.
141 *
142 * \returns True if the metadata defining the model has been set.
143 */
144 bool model_defined() const { return modelDefined; }
145
146 /** \brief Determine whether the metadata related to the transient
147 * data has been set.
148 *
149 * \returns True if the metadata related to the transient data has been set.
150 */
151 bool transient_defined() const { return transientDefined; }
152
153 // Return a pair consisting of the step (1-based) corresponding to
154 // the maximum time on the database and the corresponding maximum
155 // time value. Note that this may not necessarily be the last step
156 // on the database if cycle and overlay are being used.
157 std::pair<int, double> get_max_time() const;
158
159 // Return a pair consisting of the step (1-based) corresponding to
160 // the minimum time on the database and the corresponding minimum
161 // time value. Note that this may not necessarily be the first step
162 // on the database if cycle and overlay are being used.
163 std::pair<int, double> get_min_time() const;
164
165 // Functions for an output region...
166 bool add(NodeBlock *node_block);
167 bool add(EdgeBlock *edge_block);
168 bool add(FaceBlock *face_block);
169 bool add(ElementBlock *element_block);
170 bool add(SideSet *sideset);
171 bool add(NodeSet *nodeset);
172 bool add(EdgeSet *edgeset);
173 bool add(FaceSet *faceset);
174 bool add(ElementSet *elementset);
175 bool add(CommSet *commset);
176 bool add(StructuredBlock *structured_block);
177 bool add(const CoordinateFrame &frame);
178
179 const NodeBlockContainer & get_node_blocks() const;
180 const EdgeBlockContainer & get_edge_blocks() const;
181 const FaceBlockContainer & get_face_blocks() const;
182 const ElementBlockContainer & get_element_blocks() const;
183 const SideSetContainer & get_sidesets() const;
184 const NodeSetContainer & get_nodesets() const;
185 const EdgeSetContainer & get_edgesets() const;
186 const FaceSetContainer & get_facesets() const;
187 const ElementSetContainer & get_elementsets() const;
188 const CommSetContainer & get_commsets() const;
189 const StructuredBlockContainer &get_structured_blocks() const;
190 const CoordinateFrameContainer &get_coordinate_frames() const;
191
192 // Retrieve the Grouping Entity with the specified name.
193 // Returns nullptr if the entity does not exist
194 GroupingEntity * get_entity(const std::string &my_name, EntityType io_type) const;
195 GroupingEntity * get_entity(const std::string &my_name) const;
196 NodeBlock * get_node_block(const std::string &my_name) const;
197 EdgeBlock * get_edge_block(const std::string &my_name) const;
198 FaceBlock * get_face_block(const std::string &my_name) const;
199 ElementBlock * get_element_block(const std::string &my_name) const;
200 SideSet * get_sideset(const std::string &my_name) const;
201 SideBlock * get_sideblock(const std::string &my_name) const;
202 NodeSet * get_nodeset(const std::string &my_name) const;
203 EdgeSet * get_edgeset(const std::string &my_name) const;
204 FaceSet * get_faceset(const std::string &my_name) const;
205 ElementSet * get_elementset(const std::string &my_name) const;
206 CommSet * get_commset(const std::string &my_name) const;
207 StructuredBlock *get_structured_block(const std::string &my_name) const;
208
209 const CoordinateFrame &get_coordinate_frame(int64_t id) const;
210
211 // Add the name 'alias' as an alias for the database entity with the
212 // name 'db_name'. Returns true if alias added; false if problems
213 // adding alias.
214 bool add_alias(const std::string &db_name, const std::string &alias);
215 bool add_alias(const GroupingEntity *ge);
216 std::string get_alias(const std::string &alias) const;
217 std::string get_alias__(const std::string &alias) const; // Not locked by mutex
218
219 const AliasMap &get_alias_map() const;
220
221 /// Get a map containing all aliases defined for the entity with basename 'name'
222 int get_aliases(const std::string &my_name, std::vector<std::string> &aliases) const;
223
224 // This routine transfers all relavant aliases from the 'this'
225 // region and applies them to the 'to' file.
226 void transfer_mesh_aliases(Region *to) const;
227
228 // Ensure that the 'this' region has the same ids and names as the 'from' region.
229 void synchronize_id_and_name(const Region *from, bool sync_attribute_field_names = false);
230
231 // Returns true if the passed in name refers to a known Entity
232 // defined on this region. If true, then 'type' (if non-nullptr) is
233 // filled in with the type of the entity; if false, then type (if
234 // non-nullptr) is set to 'INVALID' This function is defined to
235 // consolidate several distinct implementations of this code in
236 // client code. Because of this, the 'type' used in the client
237 // code is repeated here instead of something more generic.
238 bool is_valid_io_entity(const std::string &my_name, unsigned int io_type,
239 std::string *my_type = nullptr) const;
240
241 // Retrieve the element block that contains the specified element
242 // The 'local_id' is the local database id (1-based), not the global id.
243 // returns nullptr if no element block contains this element (local_id <= 0
244 // or greater than number of elements in database)
245 ElementBlock *get_element_block(size_t local_id) const;
246
247 // Retrieve the structured block that contains the specified node
248 // The 'global_offset' is the global offset (0-based)
249 // returns nullptr if no structured block contains this node (local_id <= 0
250 // or greater than number of cell-nodes in database)
251 StructuredBlock *get_structured_block(size_t global_offset) const;
252
253 // Handle implicit properties -- These are calcuated from data stored
254 // in the grouping entity instead of having an explicit value assigned.
255 // An example would be 'element_block_count' for a region.
256 Property get_implicit_property(const std::string &my_name) const override;
257
258 const std::vector<std::string> &get_information_records() const;
259 void add_information_records(const std::vector<std::string> &info);
260 void add_information_record(const std::string &info);
261
262 const std::vector<std::string> &get_qa_records() const;
263 void add_qa_record(const std::string &code, const std::string &code_qa,
264 const std::string &date = "", const std::string &time = "");
265
266 protected:
267 int64_t internal_get_field_data(const Field &field, void *data,
268 size_t data_size = 0) const override;
269
270 int64_t internal_put_field_data(const Field &field, void *data,
271 size_t data_size = 0) const override;
272
273 private:
274 // Add the name 'alias' as an alias for the database entity with the
275 // name 'db_name'. Returns true if alias added; false if problems
276 // adding alias. Not protected by mutex -- call internally only.
277 bool add_alias__(const std::string &db_name, const std::string &alias);
278 bool add_alias__(const GroupingEntity *ge);
279
280 bool begin_mode__(State new_state);
281 bool end_mode__(State current_state);
282
283 void delete_database() override;
284
285 AliasMap aliases_; ///< Stores alias mappings
286
287 // Containers for all grouping entities
288 NodeBlockContainer nodeBlocks;
289 EdgeBlockContainer edgeBlocks;
290 FaceBlockContainer faceBlocks;
291 ElementBlockContainer elementBlocks;
292
293 NodeSetContainer nodeSets;
294 EdgeSetContainer edgeSets;
295 FaceSetContainer faceSets;
296 ElementSetContainer elementSets;
297
298 SideSetContainer sideSets;
299 CommSetContainer commSets;
300 CoordinateFrameContainer coordinateFrames;
301 StructuredBlockContainer structuredBlocks;
302 mutable StateTimeContainer stateTimes;
303
304 int currentState;
305 mutable int stateCount;
306 bool modelDefined;
307 bool transientDefined;
308 };
309 } // namespace Ioss
310
311 /** \brief Get the index (1-based) of the currently-active state.
312 *
313 * \returns The index.
314 */
315 inline int Ioss::Region::get_current_state() const { return currentState; }
316
317 inline bool Ioss::Region::supports_field_type(Ioss::EntityType fld_type) const
318 {
319 return static_cast<unsigned int>((get_database()->entity_field_support() & fld_type) != 0u) != 0u;
320 }
321
322 inline int64_t Ioss::Region::node_global_to_local(int64_t global, bool must_exist) const
323 {
324 return get_database()->node_global_to_local(global, must_exist);
325 }
326
327 /** \brief Get all information records (informative strings) for the region's database.
328 *
329 * \returns The informative strings.
330 */
331 inline const std::vector<std::string> &Ioss::Region::get_information_records() const
332 {
333 IOSS_FUNC_ENTER(m_);
334 return get_database()->get_information_records();
335 }
336
337 /** \brief Add multiple information records (informative strings) to the region's database.
338 *
339 * \param[in] info The strings to add.
340 */
341 inline void Ioss::Region::add_information_records(const std::vector<std::string> &info)
342 {
343 IOSS_FUNC_ENTER(m_);
344 return get_database()->add_information_records(info);
345 }
346
347 /** \brief Add an information record (an informative string) to the region's database.
348 *
349 * \param[in] info The string to add.
350 */
351 inline void Ioss::Region::add_information_record(const std::string &info)
352 {
353 IOSS_FUNC_ENTER(m_);
354 return get_database()->add_information_record(info);
355 }
356
357 /** \brief Add a QA record, which consists of 4 strings, to the region's database
358 *
359 * The 4 function parameters correspond to the 4 QA record strings.
360 *
361 * \param[in] code A descriptive code name, such as the application that modified the database.
362 * \param[in] code_qa A descriptive string, such as the version of the application that modified
363 * the database.
364 * \param[in] date A relevant date, such as the date the database was modified.
365 * \param[in] time A relevant time, such as the time the database was modified.
366 */
367 inline void Ioss::Region::add_qa_record(const std::string &code, const std::string &code_qa,
368 const std::string &date, const std::string &time)
369 {
370 IOSS_FUNC_ENTER(m_);
371 return get_database()->add_qa_record(code, code_qa, date, time);
372 }
373
374 /** \brief Get all QA records, each of which consists of 4 strings, from the region's database.
375 *
376 * The 4 strings that make up a database QA record are:
377 *
378 * 1. A descriptive code name, such as the application that modified the database.
379 *
380 * 2. A descriptive string, such as the version of the application that modified the database.
381 *
382 * 3. A relevant date, such as the date the database was modified.
383 *
384 * 4. A relevant time, such as the time the database was modified.
385 *
386 * \returns All QA records in a single vector. Every 4 consecutive elements of the
387 * vector make up a single QA record.
388 */
389 inline const std::vector<std::string> &Ioss::Region::get_qa_records() const
390 {
391 IOSS_FUNC_ENTER(m_);
392 return get_database()->get_qa_records();
393 }
394
395 #endif
Ioss::REGION
Definition: Ioss_EntityType.h:52
Ioss::Region::modelDefined
bool modelDefined
Definition: Ioss_Region.h:306
Ioss::Region::get_information_records
const std::vector< std::string > & get_information_records() const
Get all information records (informative strings) for the region's database.
Definition: Ioss_Region.h:331
Ioss::Region::end_state
double end_state(int state)
End a state (moment in time).
Definition: Ioss_Region.C:990
Ioss::Region::get_nodesets
const NodeSetContainer & get_nodesets() const
Get all the region's NodeSet objects.
Definition: Ioss_Region.C:1386
Ioss::Property
A named value that has a known type.
Definition: Ioss_Property.h:47
Ioss::Region::get_sideset
SideSet * get_sideset(const std::string &my_name) const
Get the side set with the given name.
Definition: Ioss_Region.C:1783
Ioss::Region::currentState
int currentState
Definition: Ioss_Region.h:304
Ioss::Region::stateTimes
StateTimeContainer stateTimes
Definition: Ioss_Region.h:302
Ioss::Region::get_sideblock
SideBlock * get_sideblock(const std::string &my_name) const
Get the side block with the given name.
Definition: Ioss_Region.C:1804
Ioss::Region::begin_mode
bool begin_mode(State new_state)
Set the Region and the associated DatabaseIO to the given State.
Definition: Ioss_Region.C:598
Ioss_Property.h
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::CoordinateFrameContainer
std::vector< CoordinateFrame > CoordinateFrameContainer
Definition: Ioex_Utils.h:52
Ioss::Region::get_structured_block
StructuredBlock * get_structured_block(const std::string &my_name) const
Get the structured block with the given name.
Definition: Ioss_Region.C:1762
Ioss::DatabaseIO
An input or output Database.
Definition: Ioss_DatabaseIO.h:82
Ioss::FaceSetContainer
std::vector< FaceSet * > FaceSetContainer
Definition: Ioss_Region.h:79
Ioss::Region::end_mode
bool end_mode(State current_state)
Return the Region and the associated DatabaseIO to STATE_CLOSED.
Definition: Ioss_Region.C:665
Ioss::Region::get_alias_map
const AliasMap & get_alias_map() const
Get all original name / alias pairs for the region.
Definition: Ioss_Region.C:1561
Ioss::AliasMap
std::map< std::string, std::string, std::less< std::string > > AliasMap
Definition: Ioss_Region.h:89
Ioss::NodeBlockContainer
std::vector< NodeBlock * > NodeBlockContainer
Definition: Ioss_Region.h:72
Ioss::Region::coordinateFrames
CoordinateFrameContainer coordinateFrames
Definition: Ioss_Region.h:300
Ioss::NodeSet
A collection of nodes.
Definition: Ioss_NodeSet.h:53
Ioss::Region::internal_get_field_data
int64_t internal_get_field_data(const Field &field, void *data, size_t data_size=0) const override
Definition: Ioss_Region.C:2197
Ioss::FaceBlock
A collection of element faces with the same topology.
Definition: Ioss_FaceBlock.h:53
Ioss::FaceSet
A collection of element faces.
Definition: Ioss_FaceSet.h:54
Ioss::GroupingEntity
Base class for all 'grouping' entities. The following derived classes are typical:
Definition: Ioss_GroupingEntity.h:93
Ioss::Region::elementSets
ElementSetContainer elementSets
Definition: Ioss_Region.h:296
Ioss::Region::begin_state
double begin_state(int state)
Begin a state (moment in time).
Definition: Ioss_Region.C:938
Ioss::StructuredBlockContainer
std::vector< StructuredBlock * > StructuredBlockContainer
Definition: Ioss_Region.h:83
Ioss::Region::transfer_mesh_aliases
void transfer_mesh_aliases(Region *to) const
Transfer all relevant aliases from this region to another region.
Definition: Ioss_Region.C:2211
Ioss::Region::node_global_to_local
int64_t node_global_to_local(int64_t global, bool must_exist=true) const
Definition: Ioss_Region.h:322
Ioss::EdgeSet
A collection of element edges.
Definition: Ioss_EdgeSet.h:54
Ioss::Region::get_node_block
NodeBlock * get_node_block(const std::string &my_name) const
Get the node block with the given name.
Definition: Ioss_Region.C:1678
Ioss::Region::faceBlocks
FaceBlockContainer faceBlocks
Definition: Ioss_Region.h:290
Ioss::SideBlock
A collection of element sides having the same topology.
Definition: Ioss_SideBlock.h:61
Ioss::Region::end_mode__
bool end_mode__(State current_state)
Definition: Ioss_Region.C:671
Ioss::Region::is_valid_io_entity
bool is_valid_io_entity(const std::string &my_name, unsigned int io_type, std::string *my_type=nullptr) const
Determine whether the entity with the given name and type exists.
Definition: Ioss_Region.C:1948
Ioss::Region::get_edge_blocks
const EdgeBlockContainer & get_edge_blocks() const
Get all the region's EdgeBlock objects.
Definition: Ioss_Region.C:1356
Ioss::Region::get_commset
CommSet * get_commset(const std::string &my_name) const
Get the comm set with the given name.
Definition: Ioss_Region.C:1906
Ioss::Region::get_edge_block
EdgeBlock * get_edge_block(const std::string &my_name) const
Get the edge block with the given name.
Definition: Ioss_Region.C:1699
Ioss::Region::get_implicit_property
Property get_implicit_property(const std::string &my_name) const override
Get an implicit property – These are calcuated from data stored in the grouping entity instead of hav...
Definition: Ioss_Region.C:2081
Ioss::Region::edgeBlocks
EdgeBlockContainer edgeBlocks
Definition: Ioss_Region.h:289
Ioss_MeshType.h
Ioss_DatabaseIO.h
Ioss::Region::internal_put_field_data
int64_t internal_put_field_data(const Field &field, void *data, size_t data_size=0) const override
Definition: Ioss_Region.C:2202
Ioss::State
State
Access states for a database.
Definition: Ioss_State.h:42
Ioss::Region::mesh_type
MeshType mesh_type() const
Definition: Ioss_Region.C:396
Ioss::Region::transient_defined
bool transient_defined() const
Determine whether the metadata related to the transient data has been set.
Definition: Ioss_Region.h:151
Ioss_State.h
Ioss::ElementBlock
A collection of elements having the same topology.
Definition: Ioss_ElementBlock.h:48
Ioss::EdgeSetContainer
std::vector< EdgeSet * > EdgeSetContainer
Definition: Ioss_Region.h:78
Ioss::Region::aliases_
AliasMap aliases_
Stores alias mappings.
Definition: Ioss_Region.h:285
Ioss::StructuredBlock
A structured zone – i,j,k.
Definition: Ioss_StructuredBlock.h:103
Ioss::ElementSet
A collection of elements.
Definition: Ioss_ElementSet.h:54
Ioss::Region::edgeSets
EdgeSetContainer edgeSets
Definition: Ioss_Region.h:294
Ioss::CommSetContainer
std::vector< CommSet * > CommSetContainer
Definition: Ioss_Region.h:84
Ioss::Region::get_current_state
int get_current_state() const
Get the index (1-based) of the currently-active state.
Definition: Ioss_Region.h:315
Ioss::Region::add_alias__
bool add_alias__(const std::string &db_name, const std::string &alias)
Definition: Ioss_Region.C:1487
Ioss::Region::get_alias__
std::string get_alias__(const std::string &alias) const
Definition: Ioss_Region.C:1525
Ioss::Region::~Region
~Region() override
Definition: Ioss_Region.C:333
Ioss::StateTimeContainer
std::vector< double > StateTimeContainer
Definition: Ioss_Region.h:85
Ioss::Region::supports_field_type
bool supports_field_type(Ioss::EntityType fld_type) const
Definition: Ioss_Region.h:317
Ioss::EdgeBlockContainer
std::vector< EdgeBlock * > EdgeBlockContainer
Definition: Ioss_Region.h:73
Ioss::NodeSetContainer
std::vector< NodeSet * > NodeSetContainer
Definition: Ioss_Region.h:77
Ioss::Region::sideSets
SideSetContainer sideSets
Definition: Ioss_Region.h:298
Ioss::Region::get_structured_blocks
const StructuredBlockContainer & get_structured_blocks() const
Get all the region's StructuredBlock objects.
Definition: Ioss_Region.C:1374
Ioss::Region::add_information_records
void add_information_records(const std::vector< std::string > &info)
Add multiple information records (informative strings) to the region's database.
Definition: Ioss_Region.h:341
Ioss::Region::add_state
virtual int add_state(double time)
Definition: Ioss_Region.h:125
Ioss::Region::begin_mode__
bool begin_mode__(State new_state)
Definition: Ioss_Region.C:623
Ioss::Region::transientDefined
bool transientDefined
Definition: Ioss_Region.h:307
Ioss::Region::get_coordinate_frame
const CoordinateFrame & get_coordinate_frame(int64_t id) const
Get the coordinate frame with the given id.
Definition: Ioss_Region.C:1927
Ioss::Region::structuredBlocks
StructuredBlockContainer structuredBlocks
Definition: Ioss_Region.h:301
Ioss::NodeBlock
A collection of all nodes in the region.
Definition: Ioss_NodeBlock.h:53
Ioss::Region::get_commsets
const CommSetContainer & get_commsets() const
Get all the region's CommSet objects.
Definition: Ioss_Region.C:1410
Ioss_CoordinateFrame.h
Ioss::Region::get_element_blocks
const ElementBlockContainer & get_element_blocks() const
Get all the region's ElementBlock objects.
Definition: Ioss_Region.C:1368
Ioss::Region::get_facesets
const FaceSetContainer & get_facesets() const
Get all the region's FaceSet objects.
Definition: Ioss_Region.C:1398
Ioss::Region::commSets
CommSetContainer commSets
Definition: Ioss_Region.h:299
Ioss::Region::get_elementsets
const ElementSetContainer & get_elementsets() const
Get all the region's ElementSet objects.
Definition: Ioss_Region.C:1404
Ioss::Region::type
EntityType type() const override
Get the EntityType, which indicates the particular type of GroupingEntity this is.
Definition: Ioss_Region.h:108
Ioss::Region::get_edgesets
const EdgeSetContainer & get_edgesets() const
Get all the region's EdgeSet objects.
Definition: Ioss_Region.C:1392
Ioss::Region::elementBlocks
ElementBlockContainer elementBlocks
Definition: Ioss_Region.h:291
Ioss::Region::mesh_type_string
const std::string mesh_type_string() const
Definition: Ioss_Region.C:411
Ioss::Region::get_coordinate_frames
const CoordinateFrameContainer & get_coordinate_frames() const
Get all the region's CoordinateFrame objects.
Definition: Ioss_Region.C:1416
Ioss::Region::model_defined
bool model_defined() const
Determine whether the metadata defining the model (nontransient, geometry, and toploloty) has been se...
Definition: Ioss_Region.h:144
Ioss::Region::add_information_record
void add_information_record(const std::string &info)
Add an information record (an informative string) to the region's database.
Definition: Ioss_Region.h:351
Ioss::CommSet
Definition: Ioss_CommSet.h:51
Ioss::Region::faceSets
FaceSetContainer faceSets
Definition: Ioss_Region.h:295
Ioss::Region::get_face_blocks
const FaceBlockContainer & get_face_blocks() const
Get all the region's FaceBlock objects.
Definition: Ioss_Region.C:1362
Ioss::Region::get_faceset
FaceSet * get_faceset(const std::string &my_name) const
Get the face set with the given name.
Definition: Ioss_Region.C:1864
Ioss::Region::stateCount
int stateCount
Definition: Ioss_Region.h:305
Ioss::Region::nodeSets
NodeSetContainer nodeSets
Definition: Ioss_Region.h:293
Ioss::Region::output_summary
void output_summary(std::ostream &strm, bool do_transient=true)
Print a summary of entities in the region.
Definition: Ioss_Region.C:428
Ioss::Region::get_face_block
FaceBlock * get_face_block(const std::string &my_name) const
Get the face block with the given name.
Definition: Ioss_Region.C:1720
anonymous_namespace{cth_pressure_map.C}::data
std::vector< char > data
Definition: cth_pressure_map.C:73
Ioss::Region::node_major
bool node_major() const
Definition: Ioss_Region.C:394
Ioss::Region
A grouping entity that contains other grouping entities.
Definition: Ioss_Region.h:98
Ioss::Region::short_type_string
std::string short_type_string() const override
Get a short name of the particular type of entity.
Definition: Ioss_Region.h:106
Ioss::Region::get_aliases
int get_aliases(const std::string &my_name, std::vector< std::string > &aliases) const
Get a map containing all aliases defined for the entity with basename 'name'.
Definition: Ioss_Region.C:1543
Ioss::Region::add_state__
virtual int add_state__(double time)
Add a state for a specified time.
Definition: Ioss_Region.C:775
Ioss::Region::get_nodeset
NodeSet * get_nodeset(const std::string &my_name) const
Get the node set with the given name.
Definition: Ioss_Region.C:1822
Ioss::Region::get_elementset
ElementSet * get_elementset(const std::string &my_name) const
Get the element set with the given name.
Definition: Ioss_Region.C:1885
Ioss::Region::add_qa_record
void add_qa_record(const std::string &code, const std::string &code_qa, const std::string &date="", const std::string &time="")
Add a QA record, which consists of 4 strings, to the region's database.
Definition: Ioss_Region.h:367
Ioss::Region::get_element_block
ElementBlock * get_element_block(const std::string &my_name) const
Get the element block with the given name.
Definition: Ioss_Region.C:1741
Ioss::SideSet
A collection of element sides.
Definition: Ioss_SideSet.h:59
Ioss::Region::delete_database
void delete_database() override
Definition: Ioss_Region.C:392
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Ioss::Region::add
bool add(NodeBlock *node_block)
Add a node block to the region.
Definition: Ioss_Region.C:1069
Ioss::SideSetContainer
std::vector< SideSet * > SideSetContainer
Definition: Ioss_Region.h:82
Ioss::Region::get_max_time
std::pair< int, double > get_max_time() const
Get the maximum time step index (1-based) and time for the region.
Definition: Ioss_Region.C:874
Ioss::Region::get_sidesets
const SideSetContainer & get_sidesets() const
Get all the region's SideSet objects.
Definition: Ioss_Region.C:1380
Ioss::MeshType
MeshType
The mesh type – structured, unstructured, hybrid (future), or unknown.
Definition: Ioss_MeshType.h:39
Ioss::Region::get_node_blocks
const NodeBlockContainer & get_node_blocks() const
Get all the region's NodeBlock objects.
Definition: Ioss_Region.C:1350
Ioss::Region::contains_string
std::string contains_string() const override
What does this entity contain.
Definition: Ioss_Region.h:107
Ioss::ElementBlockContainer
std::vector< ElementBlock * > ElementBlockContainer
Definition: Ioss_Region.h:75
IOSS_FUNC_ENTER
#define IOSS_FUNC_ENTER(m)
Definition: Ioss_CodeTypes.h:122
Ioss::Region::synchronize_id_and_name
void synchronize_id_and_name(const Region *from, bool sync_attribute_field_names=false)
Ensure that the restart and results files have the same ids.
Definition: Ioss_Region.C:2264
Ioss::CoordinateFrame
Definition: Ioss_CoordinateFrame.h:42
Ioss::Region::get_edgeset
EdgeSet * get_edgeset(const std::string &my_name) const
Get the edge set with the given name.
Definition: Ioss_Region.C:1843
Ioss::EntityType
EntityType
The particular type of GroupingEntity.
Definition: Ioss_EntityType.h:39
Ioss::FaceBlockContainer
std::vector< FaceBlock * > FaceBlockContainer
Definition: Ioss_Region.h:74
Ioss::Region::Region
Region(DatabaseIO *iodatabase=nullptr, const std::string &my_name="")
Constructor reads in all metadata from disk.
Definition: Ioss_Region.C:291
Ioss::Region::type_string
std::string type_string() const override
Get the name of the particular type of entity.
Definition: Ioss_Region.h:105
Ioss::Region::get_state_time
virtual double get_state_time(int state=-1) const
Get the time corresponding to the specified state or the currently active state.
Definition: Ioss_Region.C:822
Ioss::Region::get_alias
std::string get_alias(const std::string &alias) const
Get the original name for an alias.
Definition: Ioss_Region.C:1519
Ioss::EdgeBlock
A collection of element edges with the same topology.
Definition: Ioss_EdgeBlock.h:53
Ioss::Region::get_min_time
std::pair< int, double > get_min_time() const
Get the minimum time step index (1-based) and time for the region.
Definition: Ioss_Region.C:907
Ioss::Region::nodeBlocks
NodeBlockContainer nodeBlocks
Definition: Ioss_Region.h:288
Ioss::ElementSetContainer
std::vector< ElementSet * > ElementSetContainer
Definition: Ioss_Region.h:80
Ioss_EntityType.h
Ioss_GroupingEntity.h
Ioss::Region::add_alias
bool add_alias(const std::string &db_name, const std::string &alias)
Add an alias for a name in a region.
Definition: Ioss_Region.C:1481
Ioss::Region::get_entity
GroupingEntity * get_entity(const std::string &my_name, EntityType io_type) const
Get an entity of a known EntityType.
Definition: Ioss_Region.C:1569
Ioss::Region::get_qa_records
const std::vector< std::string > & get_qa_records() const
Get all QA records, each of which consists of 4 strings, from the region's database.
Definition: Ioss_Region.h:389