escript  Revision_
SpeckleyNodes.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2018 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 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 #ifndef __WEIPA_SPECKLEYNODES_H__
18 #define __WEIPA_SPECKLEYNODES_H__
19 
20 #include <weipa/NodeData.h>
21 
22 class DBfile;
23 
24 namespace speckley {
25 class SpeckleyDomain;
26 }
27 
28 namespace weipa {
29 
30 class SpeckleyNodes;
31 typedef boost::shared_ptr<SpeckleyNodes> SpeckleyNodes_ptr;
32 
38 class SpeckleyNodes : public NodeData
39 {
40 public:
42  SpeckleyNodes(const std::string& meshName);
43 
44  SpeckleyNodes(SpeckleyNodes_ptr fullNodes, IntVec& requiredNodes,
45  const std::string& meshName);
46 
48  SpeckleyNodes(const SpeckleyNodes& m);
49 
51  virtual ~SpeckleyNodes();
52 
54  bool initFromSpeckley(const speckley::SpeckleyDomain* speckleyDomain);
55 
57  bool writeToSilo(DBfile* dbfile);
58 
60  virtual void writeCoordinatesVTK(std::ostream& os, int ownIndex);
61 
63  void setSiloPath(const std::string& path) { siloPath = path; }
64 
68  const IntVec& getVarDataByName(const std::string& name) const;
69 
71  virtual StringVec getVarNames() const;
72 
74  virtual std::string getName() const { return name; }
75 
77  std::string getFullSiloName() const;
78 
80  virtual const IntVec& getNodeIDs() const { return nodeID; }
81 
83  virtual const IntVec& getNodeDistribution() const { return nodeDist; }
84 
86  virtual const IntVec& getGlobalNodeIndices() const { return nodeID; }
87 
89  virtual const CoordArray& getCoords() const { return coords; }
90 
92  virtual int getNumDims() const { return numDims; }
93 
95  virtual int getNumNodes() const { return numNodes; }
96 
98  virtual int getGlobalNumNodes() const { return globalNumNodes; }
99 
100 protected:
102  int numDims;
103  int numNodes;
108  std::string name;
109  std::string siloPath;
110 };
111 
112 
113 inline std::string SpeckleyNodes::getFullSiloName() const
114 {
115  std::string result(siloPath);
116  if (result.length() == 0 || *result.rbegin() != '/')
117  result += '/';
118  result += name;
119  return result;
120 }
121 
122 } // namespace weipa
123 
124 #endif // __WEIPA_SPECKLEYNODES_H__
125 
weipa::SpeckleyNodes::nodeTag
IntVec nodeTag
node IDs
Definition: SpeckleyNodes.h:105
weipa::SpeckleyNodes::numDims
int numDims
x, y[, z] coordinates of nodes
Definition: SpeckleyNodes.h:101
speckley::SpeckleyDomain::getLocalCoordinate
virtual double getLocalCoordinate(dim_t index, int dim) const =0
returns the index'th coordinate value in given dimension for this rank
weipa::SpeckleyNodes::coords
CoordArray coords
Definition: SpeckleyNodes.h:100
weipa::SpeckleyNodes::siloPath
std::string siloPath
the name of this node mesh
Definition: SpeckleyNodes.h:108
weipa::SpeckleyNodes::nodeID
IntVec nodeID
global number of nodes
Definition: SpeckleyNodes.h:104
weipa::SpeckleyNodes_ptr
boost::shared_ptr< SpeckleyNodes > SpeckleyNodes_ptr
Definition: SpeckleyNodes.h:29
weipa::SpeckleyNodes::getVarNames
virtual StringVec getVarNames() const
Returns a vector with the mesh variable names.
Definition: SpeckleyNodes.cpp:193
weipa
Definition: DataVar.cpp:49
weipa::SpeckleyNodes::getVarDataByName
const IntVec & getVarDataByName(const std::string &name) const
Returns an array of nodal data by the given name.
Definition: SpeckleyNodes.cpp:180
weipa::SpeckleyNodes::writeToSilo
bool writeToSilo(DBfile *dbfile)
Writes node data to a Silo file.
Definition: SpeckleyNodes.cpp:225
speckley
Definition: AbstractAssembler.cpp:17
paso::util::copy
void copy(dim_t N, double *out, const double *in)
out = in
Definition: PasoUtil.h:110
weipa::NodeData
Definition: NodeData.h:37
weipa::SpeckleyNodes::nodeDist
IntVec nodeDist
node tags
Definition: SpeckleyNodes.h:106
weipa::SpeckleyNodes::setSiloPath
void setSiloPath(const std::string &path)
Sets the silo path to be used when saving.
Definition: SpeckleyNodes.h:62
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
speckley::SpeckleyDomain::borrowSampleReferenceIDs
const index_t * borrowSampleReferenceIDs(int fsType) const =0
returns the array of reference numbers for a function space type
weipa::IndexMap
std::map< int, size_t > IndexMap
Definition: weipa.h:61
weipa::CoordArray
std::vector< float * > CoordArray
Definition: weipa.h:60
weipa::SpeckleyNodes::getGlobalNumNodes
virtual int getGlobalNumNodes() const
Returns the total number of mesh nodes for a distributed mesh.
Definition: SpeckleyNodes.h:97
weipa::SpeckleyNodes::globalNumNodes
int globalNumNodes
number of nodes
Definition: SpeckleyNodes.h:103
weipa::SpeckleyNodes::getGlobalNodeIndices
virtual const IntVec & getGlobalNodeIndices() const
Returns the global node index array.
Definition: SpeckleyNodes.h:85
weipa::SpeckleyNodes::~SpeckleyNodes
virtual ~SpeckleyNodes()
Virtual destructor.
Definition: SpeckleyNodes.cpp:109
weipa::SpeckleyNodes::initFromSpeckley
bool initFromSpeckley(const speckley::SpeckleyDomain *speckleyDomain)
Initialises with speckley domain.
Definition: SpeckleyNodes.cpp:119
weipa::SpeckleyNodes::getNodeIDs
virtual const IntVec & getNodeIDs() const
Returns the node ID array.
Definition: SpeckleyNodes.h:79
speckley::SpeckleyDomain
SpeckleyDomain extends the AbstractContinuousDomain interface for the Speckley library and is the bas...
Definition: speckley/src/SpeckleyDomain.h:95
weipa::SpeckleyNodes::numNodes
int numNodes
dimensionality (2 or 3)
Definition: SpeckleyNodes.h:102
weipa::SpeckleyNodes::getCoords
virtual const CoordArray & getCoords() const
Returns the coordinates of the mesh nodes.
Definition: SpeckleyNodes.h:88
speckley::SpeckleyDomain::getNodeDistribution
virtual IndexVector getNodeDistribution() const =0
returns the node distribution vector
speckley::SpeckleyDomain::getNumNodesPerDim
virtual const dim_t * getNumNodesPerDim() const =0
returns the number of nodes per MPI rank in each dimension
weipa::SpeckleyNodes::getName
virtual std::string getName() const
Returns the name of this node mesh.
Definition: SpeckleyNodes.h:73
speckley::SpeckleyDomain::getDataShape
virtual std::pair< int, dim_t > getDataShape(int fsType) const
returns the number of data points per sample, and the number of samples as a pair.
Definition: speckley/src/SpeckleyDomain.cpp:120
weipa::SpeckleyNodes::writeCoordinatesVTK
virtual void writeCoordinatesVTK(std::ostream &os, int ownIndex)
Writes coordinates to a stream in VTK text format.
Definition: SpeckleyNodes.cpp:204
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:82
weipa::SpeckleyNodes::getFullSiloName
std::string getFullSiloName() const
Returns full Silo mesh name, e.g. "/block0000/Nodes".
Definition: SpeckleyNodes.h:112
weipa::StringVec
std::vector< std::string > StringVec
Definition: weipa.h:59
weipa::SpeckleyNodes::getNumDims
virtual int getNumDims() const
Returns the dimensionality of this mesh (2 or 3).
Definition: SpeckleyNodes.h:91
speckley::SpeckleyDomain::getDim
virtual int getDim() const
returns the number of spatial dimensions of the domain
Definition: speckley/src/SpeckleyDomain.h:167
weipa::SpeckleyNodes::getNumNodes
virtual int getNumNodes() const
Returns the number of mesh nodes.
Definition: SpeckleyNodes.h:94
speckley::IndexVector
std::vector< index_t > IndexVector
Definition: Speckley.h:55
weipa::SpeckleyNodes::SpeckleyNodes
SpeckleyNodes(const std::string &meshName)
Constructor with mesh name.
Definition: SpeckleyNodes.cpp:38
speckley::SpeckleyDomain::getNumDataPointsGlobal
virtual dim_t getNumDataPointsGlobal() const =0
returns the number of data points summed across all MPI processes
weipa::IntVec
std::vector< int > IntVec
Definition: weipa.h:58
weipa::SpeckleyNodes::name
std::string name
node distribution
Definition: SpeckleyNodes.h:107
weipa::SpeckleyNodes::getNodeDistribution
virtual const IntVec & getNodeDistribution() const
Returns the node distribution array.
Definition: SpeckleyNodes.h:82
weipa::SpeckleyNodes
Stores and manipulates speckley mesh nodes.
Definition: SpeckleyNodes.h:37
speckley::Nodes
Definition: Speckley.h:72