escript  Revision_
Public Member Functions | Protected Attributes
weipa::FinleyNodes Class Reference

Stores and manipulates finley mesh nodes. More...

#include <FinleyNodes.h>

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

List of all members.

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.

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

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

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

Constructor with mesh name.

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

Virtual destructor.

References coords.


Member Function Documentation

virtual const CoordArray& weipa::FinleyNodes::getCoords ( ) const [inline, virtual]

Returns the coordinates of the mesh nodes.

Implements weipa::NodeData.

References coords.

std::string weipa::FinleyNodes::getFullSiloName ( ) const [inline, virtual]

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

Implements weipa::NodeData.

References name, and siloPath.

Referenced by writeToSilo().

virtual const IntVec& weipa::FinleyNodes::getGlobalNodeIndices ( ) const [inline, virtual]

Returns the global node index array.

Implements weipa::NodeData.

References nodeGNI.

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

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

Implements weipa::NodeData.

References nodeDist.

virtual std::string weipa::FinleyNodes::getName ( ) const [inline, virtual]

Returns the name of this node mesh.

Implements weipa::NodeData.

References name.

virtual const IntVec& weipa::FinleyNodes::getNodeDistribution ( ) const [inline, virtual]

Returns the node distribution array.

Implements weipa::NodeData.

References nodeDist.

virtual const IntVec& weipa::FinleyNodes::getNodeIDs ( ) const [inline, virtual]

Returns the node ID array.

Implements weipa::NodeData.

References nodeID.

virtual int weipa::FinleyNodes::getNumDims ( ) const [inline, virtual]

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

Implements weipa::NodeData.

References numDims.

virtual int weipa::FinleyNodes::getNumNodes ( ) const [inline, virtual]

Returns the number of mesh nodes.

Implements weipa::NodeData.

References numNodes.

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().

References nodeGDOF, nodeGNI, nodeGRDFI, nodeGRNI, nodeID, and nodeTag.

Returns a vector with the mesh variable names.

Implements weipa::NodeData.

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

Reads node data from a NetCDF file.

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

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

Sets the silo path to be used when saving.

References siloPath.

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

Writes coordinates to a stream in VTK text format.

Implements weipa::NodeData.

References coords, nodeDist, nodeGNI, numDims, and numNodes.

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

Writes node data to a Silo file.

References getFullSiloName(), nodeGDOF, nodeGNI, nodeGRDFI, nodeGRNI, nodeID, nodeTag, numNodes, and siloPath.


Member Data Documentation

std::string weipa::FinleyNodes::name [protected]

node distribution

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

int weipa::FinleyNodes::numDims [protected]

x, y[, z] coordinates of nodes

Referenced by FinleyNodes(), getNumDims(), initFromDudley(), initFromFinley(), readFromNc(), and writeCoordinatesVTK().

std::string weipa::FinleyNodes::siloPath [protected]

the name of this node mesh

Referenced by getFullSiloName(), setSiloPath(), and writeToSilo().


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