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

A local ID of an edge. More...

#include <RFC_Window_base.h>

Public Member Functions

 Edge_ID ()
 A dummy constructor. More...
 
 Edge_ID (int f, int e)
 Constructor from two integers. More...
 
bool operator< (const Edge_ID &v) const
 Less-than operator. More...
 

Public Attributes

int face_id
 local face id. More...
 
int edge_id
 edge id within the face. More...
 

Detailed Description

A local ID of an edge.

Each edge is identified by a pair of integers: the local face id and a unique id of the edge within a face.

Definition at line 168 of file RFC_Window_base.h.

Constructor & Destructor Documentation

Edge_ID ( )
inline

A dummy constructor.

Definition at line 170 of file RFC_Window_base.h.

170 {}
Edge_ID ( int  f,
int  e 
)
inline

Constructor from two integers.

Parameters
flocal face id.
eedge id within the pane

Definition at line 176 of file RFC_Window_base.h.

176 : face_id( f), edge_id(e) {}
int face_id
local face id.
int edge_id
edge id within the face.

Member Function Documentation

bool operator< ( const Edge_ID v) const
inline

Less-than operator.

Definition at line 182 of file RFC_Window_base.h.

References edge_id, and face_id.

182  {
183  return (face_id < v.face_id ||
184  face_id == v.face_id && edge_id < v.edge_id);
185  }
int face_id
local face id.
*********************************************************************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 edge_id
edge id within the face.

Member Data Documentation

int edge_id

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