escript  Revision_
NodeData.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2020 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014-2017 by Centre for Geoscience Computing (GeoComp)
14 * Development from 2019 by School of Earth and Environmental Sciences
15 **
16 *****************************************************************************/
17 
18 #ifndef __WEIPA_NODEDATA_H__
19 #define __WEIPA_NODEDATA_H__
20 
21 #include <weipa/weipa.h>
22 #include <ostream>
23 
24 namespace weipa {
25 
27 class NodeData
28 {
29 public:
31  virtual void writeCoordinatesVTK(std::ostream& os, int ownIndex) = 0;
32 
34  virtual StringVec getVarNames() const = 0;
35 
37  virtual std::string getName() const = 0;
38 
40  virtual std::string getFullSiloName() const = 0;
41 
43  virtual const IntVec& getNodeIDs() const = 0;
44 
46  virtual const IntVec& getNodeDistribution() const = 0;
47 
49  virtual const IntVec& getGlobalNodeIndices() const = 0;
50 
52  virtual const CoordArray& getCoords() const = 0;
53 
55  virtual int getNumDims() const = 0;
56 
58  virtual int getNumNodes() const = 0;
59 
61  virtual int getGlobalNumNodes() const = 0;
62 
63 protected:
65  virtual ~NodeData() {}
66 };
67 
68 } // namespace weipa
69 
70 #endif // __WEIPA_NODEDATA_H__
71 
Definition: NodeData.h:28
virtual const IntVec & getNodeIDs() const =0
Returns the node ID array.
virtual ~NodeData()
Virtual destructor.
Definition: NodeData.h:65
virtual int getNumNodes() const =0
Returns the number of mesh nodes.
virtual int getGlobalNumNodes() const =0
Returns the total number of mesh nodes for a distributed mesh.
virtual const IntVec & getNodeDistribution() const =0
Returns the node distribution array.
virtual void writeCoordinatesVTK(std::ostream &os, int ownIndex)=0
Writes coordinates to a stream in VTK text format.
virtual int getNumDims() const =0
Returns the dimensionality of this mesh (2 or 3).
virtual std::string getName() const =0
Returns the name of this node mesh.
virtual StringVec getVarNames() const =0
Returns a vector with the mesh variable names.
virtual const IntVec & getGlobalNodeIndices() const =0
Returns the global node index array.
virtual const CoordArray & getCoords() const =0
Returns the coordinates of the mesh nodes.
virtual std::string getFullSiloName() const =0
Returns full Silo mesh name, e.g. "/block0000/Nodes".
Definition: DataVar.cpp:51
std::vector< std::string > StringVec
Definition: weipa.h:61
std::vector< int > IntVec
Definition: weipa.h:60
std::vector< float * > CoordArray
Definition: weipa.h:62