OpenCMISS-Zinc C++ API Documentation
Public Types | Public Member Functions | List of all members
OpenCMISS::Zinc::Node Class Reference

Point object used to represent finite element nodes. More...

#include <node.hpp>

Public Types

enum  ChangeFlag {
  CHANGE_FLAG_NONE = CMZN_NODE_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_NODE_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_NODE_CHANGE_FLAG_REMOVE, CHANGE_FLAG_IDENTIFIER = CMZN_NODE_CHANGE_FLAG_IDENTIFIER,
  CHANGE_FLAG_DEFINITION = CMZN_NODE_CHANGE_FLAG_DEFINITION, CHANGE_FLAG_FIELD = CMZN_NODE_CHANGE_FLAG_FIELD
}
 
enum  ValueLabel {
  VALUE_LABEL_INVALID = CMZN_NODE_VALUE_LABEL_INVALID, VALUE_LABEL_VALUE = CMZN_NODE_VALUE_LABEL_VALUE, VALUE_LABEL_D_DS1 = CMZN_NODE_VALUE_LABEL_D_DS1, VALUE_LABEL_D_DS2 = CMZN_NODE_VALUE_LABEL_D_DS2,
  VALUE_LABEL_D2_DS1DS2 = CMZN_NODE_VALUE_LABEL_D2_DS1DS2, VALUE_LABEL_D_DS3 = CMZN_NODE_VALUE_LABEL_D_DS3, VALUE_LABEL_D2_DS1DS3 = CMZN_NODE_VALUE_LABEL_D2_DS1DS3, VALUE_LABEL_D2_DS2DS3 = CMZN_NODE_VALUE_LABEL_D2_DS2DS3,
  VALUE_LABEL_D3_DS1DS2DS3 = CMZN_NODE_VALUE_LABEL_D3_DS1DS2DS3
}
 
typedef int ChangeFlags
 

Public Member Functions

 Node (cmzn_node_id node_id)
 
 Node (const Node &node)
 
Nodeoperator= (const Node &node)
 
bool isValid () const
 
cmzn_node_id getId () const
 
int getIdentifier ()
 
int setIdentifier (int identifier)
 
Nodeset getNodeset () const
 
int merge (const Nodetemplate &nodeTemplate)
 

Detailed Description

Point object used to represent finite element nodes.

Point object used to represent finite element nodes, data points etc. Important notes: An unlimited number of fields may be defined at nodes to store parameters, derivatives, host mesh locations, strings etc. Coordinates are just another field: there can be zero or more coordinate fields defined on a node. Also, since Zinc elements are not iso-parametric, it is not sufficient to define field parameters at a node in the same manner as an existing field: the new field must also be explicitly defined on the elements.

Member Typedef Documentation

Type for passing logical OR of ChangeFlag

Member Enumeration Documentation

Bit flags summarising changes to a node or nodes in a nodeset.

Enumerator
CHANGE_FLAG_NONE 

node(s) not changed

CHANGE_FLAG_ADD 

node(s) added

CHANGE_FLAG_REMOVE 

node(s) removed

CHANGE_FLAG_IDENTIFIER 

node(s) identifier changed

CHANGE_FLAG_DEFINITION 

node(s) definition other than identifier changed; currently none

CHANGE_FLAG_FIELD 

change to field values mapped to node(s)

Enumerated labels for field value/derivative parameters held at nodes.

Enumerator
VALUE_LABEL_INVALID 

Unspecified node value label

VALUE_LABEL_VALUE 

literal field value

VALUE_LABEL_D_DS1 

derivative w.r.t. arc length S1

VALUE_LABEL_D_DS2 

derivative w.r.t. arc length S2

VALUE_LABEL_D2_DS1DS2 

cross derivative w.r.t. arc lengths S1,S2

VALUE_LABEL_D_DS3 

derivative w.r.t. arc length S3

VALUE_LABEL_D2_DS1DS3 

cross derivative w.r.t. arc lengths S1,S3

VALUE_LABEL_D2_DS2DS3 

cross derivative w.r.t. arc lengths S2,S3

VALUE_LABEL_D3_DS1DS2DS3 

triple cross derivative w.r.t. arc lengths S1,S2,S3

Member Function Documentation

cmzn_node_id OpenCMISS::Zinc::Node::getId ( ) const
inline

Return the C handle of the Node object.

Returns
C handle of Node if this objects is valid, 0 otherwise.
int OpenCMISS::Zinc::Node::getIdentifier ( )
inline

Returns the non-negative integer uniquely identifying the node in its nodeset.

Returns
The non-negative integer identifier of the node, or a negative value if node is invalid.
Nodeset OpenCMISS::Zinc::Node::getNodeset ( ) const
inline

Get the nodeset which owns this node.

Returns
Handle to the owning nodeset, or NULL/invalid handle on failure.
bool OpenCMISS::Zinc::Node::isValid ( ) const
inline

Check if this is a valid Node object.

Returns
Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Node::setIdentifier ( int  identifier)
inline

Set an integer uniquely identifying the node in its nodeset.

Parameters
identifierunique identifier to be set for the node
Returns
OpenCMISS::Zinc::OK if set the identifier successfully, any other value on fail.

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