xc
Vertex.h
1 // -*-c++-*-
2 //----------------------------------------------------------------------------
3 // XC program; finite element analysis code
4 // for structural analysis and design.
5 //
6 // Copyright (C) Luis C. Pérez Tato
7 //
8 // This program derives from OpenSees <http://opensees.berkeley.edu>
9 // developed by the «Pacific earthquake engineering research center».
10 //
11 // Except for the restrictions that may arise from the copyright
12 // of the original program (see copyright_opensees.txt)
13 // XC is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU General Public License as published by
15 // the Free Software Foundation, either version 3 of the License, or
16 // (at your option) any later version.
17 //
18 // This software is distributed in the hope that it will be useful, but
19 // WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU General Public License for more details.
22 //
23 //
24 // You should have received a copy of the GNU General Public License
25 // along with this program.
26 // If not, see <http://www.gnu.org/licenses/>.
27 //----------------------------------------------------------------------------
28 /* ****************************************************************** **
29 ** OpenSees - Open System for Earthquake Engineering Simulation **
30 ** Pacific Earthquake Engineering Research Center **
31 ** **
32 ** **
33 ** (C) Copyright 1999, The Regents of the University of California **
34 ** All Rights Reserved. **
35 ** **
36 ** Commercial use of this program without express permission of the **
37 ** University of California, Berkeley, is strictly prohibited. See **
38 ** file 'COPYRIGHT' in main directory for information on usage and **
39 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
40 ** **
41 ** Developed by: **
42 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
43 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
44 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
45 ** **
46 ** ****************************************************************** */
47 
48 // $Revision: 1.3 $
49 // $Date: 2005/11/03 23:11:55 $
50 // $Source: /usr/local/cvs/OpenSees/SRC/graph/graph/Vertex.h,v $
51 
52 
53 #ifndef Vertex_h
54 #define Vertex_h
55 
56 // Written: fmk
57 // Revision: A
58 //
59 // Description: This file contains the class definition for Vertex.
60 // Vertex is an element of a graph.
61 //
62 // What: "@(#) Vertex.h, revA"
63 
64 #include "utility/tagged/TaggedObject.h"
65 #include "utility/actor/actor/MovableObject.h"
66 #include "utility/matrix/ID.h"
67 
68 #define START_VERTEX_NUM 0
69 namespace XC {
70 
72 //
80 class Vertex: public TaggedObject, public MovableObject
81  {
82  private:
83  int myRef;
84  double myWeight;
85  int myColor;
86  int myDegree;
87  int myTmp;
88  std::set<int> myAdjacency;
89  protected:
90  int sendData(Communicator &);
91  int recvData(const Communicator &);
92 
93  public:
94  Vertex(int tag= 0, int ref= 0, double weight=0, int color =0);
95 
96  virtual void setWeight(double newWeight);
97  virtual void setColor(int newColor);
98  virtual void setTmp(int newTmp);
99 
100  virtual int getRef(void) const;
101  virtual double getWeight(void) const;
102  virtual int getColor(void) const;
103  virtual int getTmp(void) const;
104 
105  virtual int addEdge(int otherTag);
106  virtual int getDegree(void) const;
107  virtual const std::set<int> &getAdjacency(void) const;
108  virtual void setAdjacency(const std::set<int> &adj)
109  { myAdjacency = adj; }
110 
111  virtual void Print(std::ostream &os, int flag =0) const;
112  int sendSelf(Communicator &);
113  int recvSelf(const Communicator &);
114  };
115 } // end of XC namespace
116 
117 #endif
118 
virtual void setWeight(double newWeight)
Assigns a weight to the vertex.
Definition: Vertex.cpp:74
Vertex of a graph.
Definition: Vertex.h:80
int recvData(const Communicator &)
Receives object members through the communicator argument.
Definition: Vertex.cpp:168
Communication parameters between processes.
Definition: Communicator.h:66
virtual double getWeight(void) const
Returns the weight of the vertex.
Definition: Vertex.cpp:90
int sendData(Communicator &)
Send object members through the communicator argument.
Definition: Vertex.cpp:157
int recvSelf(const Communicator &)
Receives vertex data.
Definition: Vertex.cpp:197
Object that can move between processes.
Definition: MovableObject.h:100
virtual void Print(std::ostream &os, int flag=0) const
Print stuff.
Definition: Vertex.cpp:138
virtual int getRef(void) const
Returns the vertices integer reference.
Definition: Vertex.cpp:86
virtual int getDegree(void) const
Returns the vertex degree on the graph.
Definition: Vertex.cpp:121
virtual int getColor(void) const
Returns the color of the vertex.
Definition: Vertex.cpp:94
virtual void setColor(int newColor)
Assigns a color to the vertex.
Definition: Vertex.cpp:78
virtual int getTmp(void) const
Returns the vertices temporary variable.
Definition: Vertex.cpp:98
virtual void setTmp(int newTmp)
To set the temporary variable of the vertex to newTmp.
Definition: Vertex.cpp:82
int sendSelf(Communicator &)
Send vertex data.
Definition: Vertex.cpp:182
Object idenfied by an integer (tag).
Definition: TaggedObject.h:92
virtual const std::set< int > & getAdjacency(void) const
Return the adjacency list of the vertex in the graph.
Definition: Vertex.cpp:128
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
virtual int addEdge(int otherTag)
Appends an edge to the vertex.
Definition: Vertex.cpp:113
Vertex(int tag=0, int ref=0, double weight=0, int color=0)
Constructor.
Definition: Vertex.cpp:68