Rocstar  1.0
Rocstar multiphysics simulation application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Node_ID Struct Reference

A global ID of a node. More...

#include <RFC_Window_base.h>

Public Member Functions

 Node_ID ()
 A dummy constructor. More...
 
 Node_ID (int p, int v)
 Constructor from two integers. More...
 
bool operator== (const Node_ID &v) const
 Equal operator. More...
 
bool operator< (const Node_ID &v) const
 Less-than operator. More...
 

Public Attributes

int pane_id
 the id of the owner pane. More...
 
int node_id
 the local id within the pane starting from 1. More...
 

Detailed Description

A global ID of a node.

Each node is identified by a pair of integers: the pane id of its owner, and its local id within the pane.

Definition at line 54 of file RFC_Window_base.h.

Constructor & Destructor Documentation

Node_ID ( )
inline

A dummy constructor.

Definition at line 56 of file RFC_Window_base.h.

56 {}
Node_ID ( int  p,
int  v 
)
inline

Constructor from two integers.

Parameters
pthe id of the owner pane.
vthe local id within the pane.

Definition at line 62 of file RFC_Window_base.h.

62 : pane_id( p), node_id( v) {}
int node_id
the local id within the pane starting from 1.
*********************************************************************Illinois Open Source License ****University of Illinois NCSA **Open Source License University of Illinois All rights reserved ****Developed free of to any person **obtaining a copy of this software and associated documentation to deal with the Software without including without limitation the rights to and or **sell copies of the and to permit persons to whom the **Software is furnished to do subject to the following this list of conditions and the following disclaimers ****Redistributions in binary form must reproduce the above **copyright this list of conditions and the following **disclaimers in the documentation and or other materials **provided with the distribution ****Neither the names of the Center for Simulation of Advanced the University of nor the names of its **contributors may be used to endorse or promote products derived **from this Software without specific prior written permission ****THE SOFTWARE IS PROVIDED AS WITHOUT WARRANTY OF ANY **EXPRESS OR INCLUDING BUT NOT LIMITED TO THE WARRANTIES **OF FITNESS FOR A PARTICULAR PURPOSE AND **NONINFRINGEMENT IN NO EVENT SHALL THE CONTRIBUTORS OR **COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER WHETHER IN AN ACTION OF TORT OR **ARISING OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE **USE OR OTHER DEALINGS WITH THE SOFTWARE v
Definition: roccomf90.h:20
int pane_id
the id of the owner pane.

Member Function Documentation

bool operator< ( const Node_ID v) const
inline

Less-than operator.

Definition at line 70 of file RFC_Window_base.h.

References node_id, and pane_id.

70  {
71  return (pane_id < v.pane_id ||
72  pane_id == v.pane_id && node_id < v.node_id);
73  }
int node_id
the local id within the pane starting from 1.
int pane_id
the id of the owner pane.
bool operator== ( const Node_ID v) const
inline

Equal operator.

Definition at line 67 of file RFC_Window_base.h.

References node_id, and pane_id.

68  { return pane_id == v.pane_id && node_id == v.node_id; }
int node_id
the local id within the pane starting from 1.
int pane_id
the id of the owner pane.

Member Data Documentation

int node_id
int pane_id

the id of the owner pane.

Definition at line 63 of file RFC_Window_base.h.

Referenced by Overlay::get_subnode_id(), Transfer_base::interpolate_fe(), operator<(), operator==(), and Overlay::set_subnode_id().


The documentation for this struct was generated from the following file: