escript Revision_
weipa::FinleyNodes Class Reference

Stores and manipulates finley mesh nodes. More...

#include <FinleyNodes.h>

Inheritance diagram for weipa::FinleyNodes:
weipa::NodeData

Public Member Functions

 FinleyNodes (const std::string &meshName)
 Constructor with mesh name.
 
 FinleyNodes (FinleyNodes_ptr fullNodes, IntVec &requiredNodes, const std::string &meshName)
 
 FinleyNodes (const FinleyNodes &m)
 Copy constructor.
 
virtual ~FinleyNodes ()
 Virtual destructor.
 
bool initFromDudley (const dudley::NodeFile *dudleyFile)
 Initialises with dudley node file.
 
bool initFromFinley (const finley::NodeFile *finleyFile)
 Initialises with finley node file.
 
bool readFromNc (NcFile *ncFile)
 Reads node data from a NetCDF file.
 
bool writeToSilo (DBfile *dbfile)
 Writes node data to a Silo file.
 
virtual void writeCoordinatesVTK (std::ostream &os, int ownIndex)
 Writes coordinates to a stream in VTK text format.
 
void setSiloPath (const std::string &path)
 Sets the silo path to be used when saving.
 
const IntVecgetVarDataByName (const std::string &name) const
 Returns an array of nodal data by the given name.
 
virtual StringVec getVarNames () const
 Returns a vector with the mesh variable names.
 
virtual std::string getName () const
 Returns the name of this node mesh.
 
std::string getFullSiloName () const
 Returns full Silo mesh name, e.g. "/block0000/Nodes".
 
virtual const IntVecgetNodeIDs () const
 Returns the node ID array.
 
virtual const IntVecgetNodeDistribution () const
 Returns the node distribution array.
 
virtual const IntVecgetGlobalNodeIndices () const
 Returns the global node index array.
 
virtual const CoordArraygetCoords () const
 Returns the coordinates of the mesh nodes.
 
virtual int getNumDims () const
 Returns the dimensionality of this mesh (2 or 3).
 
virtual int getNumNodes () const
 Returns the number of mesh nodes.
 
virtual int getGlobalNumNodes () const
 Returns the total number of mesh nodes for a distributed mesh.
 
- Public Member Functions inherited from weipa::NodeData

Protected Attributes

CoordArray coords
 
int numDims
 x, y[, z] coordinates of nodes
 
int numNodes
 dimensionality (2 or 3)
 
IntVec nodeID
 number of nodes
 
IntVec nodeTag
 node IDs
 
IntVec nodeGDOF
 
IntVec nodeGNI
 
IntVec nodeGRDFI
 
IntVec nodeGRNI
 
IntVec nodeDist
 
std::string name
 node distribution
 
std::string siloPath
 the name of this node mesh
 

Additional Inherited Members

- Protected Member Functions inherited from weipa::NodeData
virtual ~NodeData ()
 Virtual destructor.
 

Detailed Description

Stores and manipulates finley mesh nodes.

This class provides functionality to manipulate a finley node file. It is able to load node data from dump files or retrieve it from a finley::NodeFile instance.

Constructor & Destructor Documentation

◆ FinleyNodes() [1/3]

weipa::FinleyNodes::FinleyNodes ( const std::string & meshName)

Constructor with mesh name.

◆ FinleyNodes() [2/3]

weipa::FinleyNodes::FinleyNodes ( FinleyNodes_ptr fullNodes,
IntVec & requiredNodes,
const std::string & meshName )

References nodeDist, and numDims.

◆ FinleyNodes() [3/3]

weipa::FinleyNodes::FinleyNodes ( const FinleyNodes & m)

Copy constructor.

References coords, name, nodeDist, nodeGDOF, nodeGNI, nodeGRDFI, nodeGRNI, nodeID, nodeTag, numDims, and numNodes.

◆ ~FinleyNodes()

weipa::FinleyNodes::~FinleyNodes ( )
virtual

Virtual destructor.

Member Function Documentation

◆ getCoords()

virtual const CoordArray & weipa::FinleyNodes::getCoords ( ) const
inlinevirtual

Returns the coordinates of the mesh nodes.

Implements weipa::NodeData.

References coords.

◆ getFullSiloName()

std::string weipa::FinleyNodes::getFullSiloName ( ) const
inlinevirtual

Returns full Silo mesh name, e.g. "/block0000/Nodes".

Implements weipa::NodeData.

References name, and siloPath.

◆ getGlobalNodeIndices()

virtual const IntVec & weipa::FinleyNodes::getGlobalNodeIndices ( ) const
inlinevirtual

Returns the global node index array.

Implements weipa::NodeData.

References nodeGNI.

◆ getGlobalNumNodes()

int weipa::FinleyNodes::getGlobalNumNodes ( ) const
virtual

Returns the total number of mesh nodes for a distributed mesh.

Implements weipa::NodeData.

◆ getName()

virtual std::string weipa::FinleyNodes::getName ( ) const
inlinevirtual

Returns the name of this node mesh.

Implements weipa::NodeData.

References name.

◆ getNodeDistribution()

virtual const IntVec & weipa::FinleyNodes::getNodeDistribution ( ) const
inlinevirtual

Returns the node distribution array.

Implements weipa::NodeData.

References nodeDist.

◆ getNodeIDs()

virtual const IntVec & weipa::FinleyNodes::getNodeIDs ( ) const
inlinevirtual

Returns the node ID array.

Implements weipa::NodeData.

References nodeID.

◆ getNumDims()

virtual int weipa::FinleyNodes::getNumDims ( ) const
inlinevirtual

Returns the dimensionality of this mesh (2 or 3).

Implements weipa::NodeData.

References numDims.

◆ getNumNodes()

virtual int weipa::FinleyNodes::getNumNodes ( ) const
inlinevirtual

Returns the number of mesh nodes.

Implements weipa::NodeData.

References numNodes.

◆ getVarDataByName()

const IntVec & weipa::FinleyNodes::getVarDataByName ( const std::string & name) const

Returns an array of nodal data by the given name.

The name must be one of the names returned by getVarNames().

◆ getVarNames()

StringVec weipa::FinleyNodes::getVarNames ( ) const
virtual

Returns a vector with the mesh variable names.

Implements weipa::NodeData.

◆ initFromDudley()

◆ initFromFinley()

◆ readFromNc()

bool weipa::FinleyNodes::readFromNc ( NcFile * ncFile)

Reads node data from a NetCDF file.

◆ setSiloPath()

void weipa::FinleyNodes::setSiloPath ( const std::string & path)
inline

Sets the silo path to be used when saving.

References siloPath.

◆ writeCoordinatesVTK()

void weipa::FinleyNodes::writeCoordinatesVTK ( std::ostream & os,
int ownIndex )
virtual

Writes coordinates to a stream in VTK text format.

Implements weipa::NodeData.

◆ writeToSilo()

bool weipa::FinleyNodes::writeToSilo ( DBfile * dbfile)

Writes node data to a Silo file.

Member Data Documentation

◆ coords

CoordArray weipa::FinleyNodes::coords
protected

Referenced by FinleyNodes(), and getCoords().

◆ name

std::string weipa::FinleyNodes::name
protected

node distribution

Referenced by FinleyNodes(), getFullSiloName(), and getName().

◆ nodeDist

IntVec weipa::FinleyNodes::nodeDist
protected

◆ nodeGDOF

IntVec weipa::FinleyNodes::nodeGDOF
protected

Referenced by FinleyNodes().

◆ nodeGNI

IntVec weipa::FinleyNodes::nodeGNI
protected

◆ nodeGRDFI

IntVec weipa::FinleyNodes::nodeGRDFI
protected

Referenced by FinleyNodes().

◆ nodeGRNI

IntVec weipa::FinleyNodes::nodeGRNI
protected

Referenced by FinleyNodes().

◆ nodeID

IntVec weipa::FinleyNodes::nodeID
protected

number of nodes

Referenced by FinleyNodes(), and getNodeIDs().

◆ nodeTag

IntVec weipa::FinleyNodes::nodeTag
protected

node IDs

Referenced by FinleyNodes().

◆ numDims

int weipa::FinleyNodes::numDims
protected

x, y[, z] coordinates of nodes

Referenced by FinleyNodes(), FinleyNodes(), and getNumDims().

◆ numNodes

int weipa::FinleyNodes::numNodes
protected

dimensionality (2 or 3)

Referenced by FinleyNodes(), and getNumNodes().

◆ siloPath

std::string weipa::FinleyNodes::siloPath
protected

the name of this node mesh

Referenced by getFullSiloName(), and setSiloPath().


The documentation for this class was generated from the following files: