VTK  9.2.6
vtkIOSSUtilities.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkIOSSUtilities.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkIOSSUtilities_h
31 #define vtkIOSSUtilities_h
32 
33 #include "vtkDataArraySelection.h"
34 #include "vtkDoubleArray.h"
35 #include "vtkIOSSReader.h"
36 #include "vtkLogger.h"
37 #include "vtkObject.h"
38 #include "vtkSmartPointer.h"
39 #include "vtkTypeInt32Array.h"
40 #include "vtkTypeInt64Array.h"
41 #include "vtkTypeList.h" // Needed for ArrayList definition
42 
43 // Ioss includes
44 #include <vtk_ioss.h>
45 // clang-format off
46 #include VTK_IOSS(Ioss_Region.h)
47 #include VTK_IOSS(Ioss_Transform.h)
48 #include VTK_IOSS(Ioss_StructuredBlock.h)
49 #include VTK_IOSS(Ioss_SideSet.h)
50 #include VTK_IOSS(Ioss_SideBlock.h)
51 // clang-format on
52 
53 #include <cassert>
54 #include <set>
55 
56 class vtkCellArray;
57 class vtkDataSet;
58 
59 namespace vtkIOSSUtilities
60 {
61 
63 {
68 };
69 
73 class Cache
74 {
75 public:
76  Cache();
77  ~Cache();
78 
82  void ResetAccessCounts();
83 
88  void ClearUnused();
89 
93  void Clear();
94 
95  vtkObject* Find(const Ioss::GroupingEntity* entity, const std::string& cachekey) const;
96  void Insert(const Ioss::GroupingEntity* entity, const std::string& cachekey, vtkObject* array);
97 
98 private:
99  Cache(const Cache&) = delete;
100  void operator=(const Cache&) = delete;
101 
102  class CacheInternals;
103  CacheInternals* Internals;
104 };
105 
111 {
112 public:
115 
119  std::string GetMessages() const;
120 
121 private:
122  std::ostringstream Stream;
123  std::ostream* DebugStream;
124  std::ostream* WarningStream;
125 };
126 
127 using EntityNameType = std::pair<vtkTypeUInt64, std::string>;
128 
135 using ArrayList = typename vtkTypeList::Unique<
137 
142 std::vector<std::pair<int, double>> GetTime(const Ioss::Region* region);
143 
151 std::string GetSanitizedBlockName(const Ioss::Region* region, const std::string& name);
152 
158 template <typename EntityType>
159 void GetEntityAndFieldNames(const Ioss::Region* region, const std::vector<EntityType*>& entities,
160  std::set<EntityNameType>& entity_names, std::set<std::string>& field_names)
161 {
162  for (const auto& entity : entities)
163  {
164  const int64_t id = entity->property_exists("id") ? entity->get_property("id").get_int() : 0;
165  auto name = vtkIOSSUtilities::GetSanitizedBlockName(region, entity->name());
166  entity_names.insert(EntityNameType{ static_cast<vtkTypeUInt64>(id), name });
167 
168  Ioss::NameList attributeNames;
169  entity->field_describe(Ioss::Field::TRANSIENT, &attributeNames);
170  entity->field_describe(Ioss::Field::ATTRIBUTE, &attributeNames);
171  std::copy(
172  attributeNames.begin(), attributeNames.end(), std::inserter(field_names, field_names.end()));
173  }
174 }
178 template <>
179 void GetEntityAndFieldNames<Ioss::SideSet>(const Ioss::Region* region,
180  const std::vector<Ioss::SideSet*>& entities, std::set<EntityNameType>& entity_names,
181  std::set<std::string>& field_names);
182 
189 Ioss::EntityType GetIOSSEntityType(vtkIOSSReader::EntityType vtk_type);
190 
199 
206 vtkSmartPointer<vtkDataArray> GetData(const Ioss::GroupingEntity* entity,
207  const std::string& fieldname, Ioss::Transform* transform = nullptr, Cache* cache = nullptr,
208  const std::string& cachekey = std::string());
209 
218 int GetCellType(const Ioss::ElementTopology* topology);
219 
227 const Ioss::ElementTopology* GetElementTopology(int vtk_cell_type);
228 
240  Ioss::GroupingEntity* group_entity, int& vtk_topology_type, Cache* cache = nullptr);
241 
248  const Ioss::GroupingEntity* group_entity, Cache* cache = nullptr);
249 
256 bool IsFieldTransient(Ioss::GroupingEntity* entity, const std::string& fieldname);
257 
259 
262 std::string GetDisplacementFieldName(Ioss::GroupingEntity* nodeblock);
265 
271 
276 DatabaseFormatType DetectType(const std::string& dbaseName);
277 
283 DatabaseFormatType GetFormat(const Ioss::GroupingEntity* entity);
284 
291 std::vector<Ioss::StructuredBlock*> GetMatchingStructuredBlocks(
292  Ioss::Region* region, const std::string& blockname);
293 };
294 
295 #endif
296 // VTK-HeaderTest-Exclude: vtkIOSSUtilities.h
std::string GetSanitizedBlockName(const Ioss::Region *region, const std::string &name)
This is primarily intended for CGNS.
abstract base class for most VTK objects
Definition: vtkObject.h:62
Remove all duplicate types from TypeList TList, storing the new list in Result.
Definition: vtkTypeList.h:126
Ioss::EntityType GetIOSSEntityType(vtkIOSSReader::EntityType vtk_type)
For the given vtkIOSSReader::EntityType return the corresponding Ioss::EntityType.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
std::vector< Ioss::StructuredBlock * > GetMatchingStructuredBlocks(Ioss::Region *region, const std::string &blockname)
Returns collection of StructuredBlock's matching the selected blockname.
void Insert(const Ioss::GroupingEntity *entity, const std::string &cachekey, vtkObject *array)
DatabaseFormatType GetFormat(const Ioss::GroupingEntity *entity)
Given any GroupingEntity pointer, returns the format that the associated database is in...
typename vtkTypeList::detail::CreateImpl< Ts... >::type Create
Definition: vtkTypeList.h:177
vtkObject * Find(const Ioss::GroupingEntity *entity, const std::string &cachekey) const
bool IsFieldTransient(Ioss::GroupingEntity *entity, const std::string &fieldname)
Returns true if the field is transient.
std::string GetDisplacementFieldName(Ioss::GroupingEntity *nodeblock)
Finds a displacement field name.
const Ioss::ElementTopology * GetElementTopology(int vtk_cell_type)
Returns an Ioss topology element, if possible, given a VTK cell type.
void Clear()
Clears the cache.
vtkSmartPointer< vtkDataArray > GetData(const Ioss::GroupingEntity *entity, const std::string &fieldname, Ioss::Transform *transform=nullptr, Cache *cache=nullptr, const std::string &cachekey=std::string())
Returns a VTK array for a given field (fieldname) on the chosen block (or set) entity.
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
vtkSmartPointer< vtkCellArray > GetConnectivity(Ioss::GroupingEntity *group_entity, int &vtk_topology_type, Cache *cache=nullptr)
Read connectivity information from the group_entity.
std::string GetMessages() const
Provides access to the accumulated messages.
object to represent cell connectivity
Definition: vtkCellArray.h:186
vtkSmartPointer< vtkPoints > GetMeshModelCoordinates(const Ioss::GroupingEntity *group_entity, Cache *cache=nullptr)
Read points from the group_entity.
std::vector< std::pair< int, double > > GetTime(const Ioss::Region *region)
Reads time / timestep information from a region.
void GetEntityAndFieldNames(const Ioss::Region *region, const std::vector< EntityType * > &entities, std::set< EntityNameType > &entity_names, std::set< std::string > &field_names)
Populates entitySelection with available entity block (or set) names and populates fieldSelection wit...
void ResetAccessCounts()
Call this to clear internal count for hits.
internal utilities for vtkIOSSReader
A helper to instantiate on stack to temporarily redirect non-critical messsages emanating from IOSS...
vtkSmartPointer< vtkDataArray > CreateArray(const Ioss::Field &field)
Create an array for the given field.
void InitializeEnvironmentForIOSS()
Must be called before using any Ioss library functions.
DatabaseFormatType DetectType(const std::string &dbaseName)
Given a filename determines and returns the database type.
std::pair< vtkTypeUInt64, std::string > EntityNameType
void ClearUnused()
Removes all cached entries not accessed since most recent call to ResetAccessCounts.