Rocstar  1.0
Rocstar multiphysics simulation application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Pane_node_accessors.h
Go to the documentation of this file.
1 /* *******************************************************************
2  * Rocstar Simulation Suite *
3  * Copyright@2015, Illinois Rocstar LLC. All rights reserved. *
4  * *
5  * Illinois Rocstar LLC *
6  * Champaign, IL *
7  * www.illinoisrocstar.com *
8  * sales@illinoisrocstar.com *
9  * *
10  * License: See LICENSE file in top level of distribution package or *
11  * http://opensource.org/licenses/NCSA *
12  *********************************************************************/
13 /* *******************************************************************
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, *
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES *
16  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND *
17  * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR *
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE *
21  * USE OR OTHER DEALINGS WITH THE SOFTWARE. *
22  *********************************************************************/
23 
27 /* Author: T.J. Alumbaugh
28  * Date: October 19, 2004
29  */
30 
31 #ifndef _PANE_NODE_ACCESSORS_H_
32 #define _PANE_NODE_ACCESSORS_H_
33 
34 #include "roccom.h"
35 #include <cassert>
36 #include <algorithm>
37 
38 COM_BEGIN_NAME_SPACE
39 
41 public:
43 
47  Pane_node_enumerator( const Pane *pane, int i,
48  const Connectivity *conn=NULL);
49 
51  int next();
52 
54  int dimension() const { return _pane->dimension(); }
55 
57  int id() const {
58  return _node_num;
59  }
60 
61  // Obtain a reference to the pane
62  inline const Pane* pane() const { return _pane; }
63 
64 protected:
65  const Pane *_pane; // Owner pane.
67  bool position_allowed3D();
68  bool position_allowed2D();
69  int _node_num; //pane level id of node
70  int ni;
71  int nj;
72  int nk;
73  int _buffer;
75  void set_first() {
77  }
78 
79 };
80 
81 
82 COM_END_NAME_SPACE
83 
84 #endif // _PANE_NODE_ENUMERATOR_H_
85 // EOF
86 
87 
88 
89 
90 
91 
A Pane object contains a mesh, pane attribute, and field variables.
Definition: Pane.h:43
const Connectivity * _conn
const Pane * pane() const
This file contains the prototypes for Roccom API.
int id() const
Get the local id of the element within the pane.
int next()
Go to the next element within the connectivity tables of a pane.
blockLoc i
Definition: read.cpp:79
bool position_allowed2D()
Determine in the current node number is a real node or a ghost node If it is a ghost node...
bool position_allowed3D()
Determine in the current node number is a real node or a ghost node If it is a ghost node...
int dimension() const
Get the dimension of the base pane.
int dimension() const
Dimension of the pane.
Definition: Pane.h:99
Encapsulates an element-connectivity of a mesh.
Definition: Connectivity.h:41