INMOST
A toolkit for distributed mathematical modeling
INMOST::Edge Class Reference
Inheritance diagram for INMOST::Edge:
Collaboration diagram for INMOST::Edge:

Public Member Functions

 Edge (const Edge &other)
 
 Edge (Mesh *m, HandleType h)
 
 Edge (Mesh *m, HandleType *h)
 
Edgeoperator= (Edge const &other)
 
Edgeoperator-> ()
 
const Edgeoperator-> () const
 
Edgeself ()
 
const Edgeself () const
 
ElementArray< NodegetNodes () const
 Retrieve all the nodes of the element. More...
 
ElementArray< FacegetFaces () const
 Retrieve all the faces of the element. More...
 
ElementArray< CellgetCells () const
 Return all the cells of the element. More...
 
ElementArray< NodegetNodes (MarkerType mask, bool invert_mask=false) const
 
ElementArray< FacegetFaces (MarkerType mask, bool invert_mask=false) const
 
ElementArray< CellgetCells (MarkerType mask, bool invert_mask=false) const
 
Node getBeg () const
 
Node getEnd () const
 
bool SameLine (const ElementArray< Node > &nodes) const
 
Storage::real Length () const
 
void SwapEnds ()
 Swap positions of first node and last node.
 
- Public Member Functions inherited from INMOST::Element
 Element (Mesh *m, HandleType h)
 
 Element (Mesh *m, HandleType *h)
 
 Element (const Element &other)
 
Elementoperator= (Element const &other)
 
Elementoperator-> ()
 
const Elementoperator-> () const
 
Elementself ()
 
const Elementself () const
 
virtual enumerator nbAdjElements (ElementType etype) const
 Retrieve number of adjacent elements. More...
 
virtual ElementArray< ElementgetAdjElements (ElementType etype) const
 Retrieve unordered array of adjacent elements. More...
 
virtual enumerator nbAdjElements (ElementType etype, MarkerType mask, bool invert_mask=false) const
 Retrieve number of adjacent elements with marker. More...
 
virtual ElementArray< ElementgetAdjElements (ElementType etype, MarkerType mask, bool invert_mask=false) const
 Retrieve unordered array of adjacent elements with marker. More...
 
ElementArray< ElementBridgeAdjacencies (ElementType Bridge, ElementType Dest, MarkerType bridge_mask=0, bool bridge_invert=false, MarkerType target_mask=0, bool target_invert=false) const
 
ElementArray< NodeBridgeAdjacencies2Node (ElementType Bridge, MarkerType bridge_mask=0, bool bridge_invert=false, MarkerType target_mask=0, bool target_invert=false) const
 
ElementArray< EdgeBridgeAdjacencies2Edge (ElementType Bridge, MarkerType bridge_mask=0, bool bridge_invert=false, MarkerType target_mask=0, bool target_invert=false) const
 
ElementArray< FaceBridgeAdjacencies2Face (ElementType Bridge, MarkerType bridge_mask=0, bool bridge_invert=false, MarkerType target_mask=0, bool target_invert=false) const
 
ElementArray< CellBridgeAdjacencies2Cell (ElementType Bridge, MarkerType bridge_mask=0, bool bridge_invert=false, MarkerType target_mask=0, bool target_invert=false) const
 
virtual ElementArray< EdgegetEdges () const
 Retrieve all the edges of the element. More...
 
virtual ElementArray< EdgegetEdges (MarkerType mask, bool invert_mask=false) const
 
GeometricType GetGeometricType () const
 
unsigned int GetElementDimension () const
 
Status GetStatus () const
 
void SetStatus (Status status) const
 
Storage::integerGlobalID () const
 
bool CheckElementConnectivity () const
 
void PrintElementConnectivity () const
 
void CastRay (const real *pos, const real *dir, std::map< HandleType, real > &hits) const
 
void ComputeGeometricType () const
 
void Centroid (real *cnt) const
 
void Barycenter (real *cnt) const
 
Storage::real Mean (const MeanFunc &f, real time) const
 
Storage::real Mean (real(*func)(real *x, real t), real time) const
 
bool Boundary () const
 Determine that the element is on the boundary. More...
 
bool Planarity () const
 
bool Hide () const
 If the function returns true then element was hidden, works only inside BeginModification and EndModification, on EndModification all Hidden elements are deleted. More...
 
bool Show () const
 If the function returns true then element was recovered from hidden state, works only inside BeginModification and EndModification. More...
 
bool Delete ()
 Remove element from mesh. More...
 
bool Hidden () const
 
bool New () const
 
void Disconnect (bool delete_upper_adjacent) const
 
void Disconnect (const HandleType *adjacent, INMOST_DATA_ENUM_TYPE num) const
 Disconnect element. More...
 
void Connect (const HandleType *adjacent, INMOST_DATA_ENUM_TYPE num) const
 Connects lower adjacencies to current element. More...
 
void SendTo (std::set< Storage::integer > &procs) const
 Update geometric data for element, calls RecomputeGeometricData from Mesh. More...
 
void SendTo (std::vector< Storage::integer > &procs) const
 
void SendTo (Storage::integer_array procs) const
 
- Public Member Functions inherited from INMOST::Storage
 Storage (const Storage &other)
 
 Storage (Mesh *mesh, HandleType handle)
 
 Storage (Mesh *mesh, HandleType *handle)
 This constructor allows for remote handle modification.
 
Storageoperator= (Storage const &other)
 If there is a link to handle provided (automatically by ElementArray and reference_array), then remote handle value will be modified.
 
__INLINE bool operator< (const Storage &other) const
 
__INLINE bool operator> (const Storage &other) const
 
__INLINE bool operator<= (const Storage &other) const
 
__INLINE bool operator>= (const Storage &other) const
 
__INLINE bool operator== (const Storage &other) const
 
__INLINE bool operator!= (const Storage &other) const
 
__INLINE Storageoperator-> ()
 
__INLINE const Storageoperator-> () const
 
__INLINE Storageself ()
 
__INLINE const Storageself () const
 
__INLINE realReal (const Tag &tag) const
 Retrieve real value associated with Tag. More...
 
__INLINE integerInteger (const Tag &tag) const
 Retrieve integer value associated with Tag. More...
 
__INLINE bulkBulk (const Tag &tag) const
 Retrieve one byte of abstract data associated with Tag. More...
 
__INLINE referenceReference (const Tag &tag) const
 Retrieve Element reference associated with Tag. More...
 
__INLINE remote_referenceRemoteReference (const Tag &tag) const
 Retrieve remote Element reference associated with Tag. More...
 
__INLINE real_array RealArray (const Tag &tag) const
 Retrieve array of real values associated with Tag. More...
 
__INLINE integer_array IntegerArray (const Tag &tag) const
 Retrieve array of integer values associated with Tag. More...
 
__INLINE bulk_array BulkArray (const Tag &tag) const
 Retrieve abstract data associated with Tag as a series of bytes. More...
 
__INLINE reference_array ReferenceArray (const Tag &tag) const
 Retrieve array of Element references associated with Tag. More...
 
__INLINE remote_reference_array RemoteReferenceArray (const Tag &tag) const
 Retrieve array of Element references associated with Tag. More...
 
__INLINE real_array RealArrayDF (const Tag &tag) const
 
__INLINE integer_array IntegerArrayDF (const Tag &tag) const
 
__INLINE bulk_array BulkArrayDF (const Tag &tag) const
 
__INLINE reference_array ReferenceArrayDF (const Tag &tag) const
 
__INLINE remote_reference_array RemoteReferenceArrayDF (const Tag &tag) const
 
__INLINE realRealDF (const Tag &tag) const
 
__INLINE integerIntegerDF (const Tag &tag) const
 
__INLINE bulkBulkDF (const Tag &tag) const
 
__INLINE referenceReferenceDF (const Tag &tag) const
 
__INLINE remote_referenceRemoteReferenceDF (const Tag &tag) const
 
__INLINE real_array RealArrayDV (const Tag &tag) const
 
__INLINE integer_array IntegerArrayDV (const Tag &tag) const
 
__INLINE bulk_array BulkArrayDV (const Tag &tag) const
 
__INLINE reference_array ReferenceArrayDV (const Tag &tag) const
 
__INLINE remote_reference_array RemoteReferenceArrayDV (const Tag &tag) const
 
__INLINE realRealDV (const Tag &tag) const
 
__INLINE integerIntegerDV (const Tag &tag) const
 
__INLINE bulkBulkDV (const Tag &tag) const
 
__INLINE referenceReferenceDV (const Tag &tag) const
 
__INLINE remote_referenceRemoteReferenceDV (const Tag &tag) const
 
__INLINE varVariable (const Tag &tag) const
 Retrieve variable reference associated with Tag.
 
__INLINE varVariableDF (const Tag &tag) const
 
__INLINE varVariableDV (const Tag &tag) const
 
__INLINE var_array VariableArray (const Tag &tag) const
 Retrieve array of variables associated with Tag.
 
__INLINE var_array VariableArrayDF (const Tag &tag) const
 
__INLINE var_array VariableArrayDV (const Tag &tag) const
 
__INLINE INMOST_DATA_ENUM_TYPE GetDataSize (const Tag &tag) const
 Return the data length associated with Tag. More...
 
__INLINE INMOST_DATA_ENUM_TYPE GetDataCapacity (const Tag &tag) const
 Return the size of the structure required to represent the data on current element. More...
 
__INLINE void SetDataSize (const Tag &tag, INMOST_DATA_ENUM_TYPE new_size) const
 Set the length of data associated with Tag. More...
 
__INLINE void GetData (const Tag &tag, INMOST_DATA_ENUM_TYPE shift, INMOST_DATA_ENUM_TYPE size, void *data) const
 Extract part of the data associated with Tag. More...
 
__INLINE void SetData (const Tag &tag, INMOST_DATA_ENUM_TYPE shift, INMOST_DATA_ENUM_TYPE size, const void *data) const
 
__INLINE void DelData (const Tag &tag) const
 
__INLINE bool DelSparseData (const Tag &tag) const
 Deallocates space allocated for sparse data, frees variable array if necessary.
 
__INLINE void DelDenseData (const Tag &tag) const
 Frees variable array or fills field with zeroes.
 
__INLINE bool HaveData (const Tag &tag) const
 Check if any data is associated with Tag.
 
__INLINE ElementType GetElementType () const
 
__INLINE integer GetElementNum () const
 
__INLINE void SetMarker (MarkerType n) const
 
__INLINE bool GetMarker (MarkerType n) const
 
__INLINE void RemMarker (MarkerType n) const
 
__INLINE void SetPrivateMarker (MarkerType n) const
 
__INLINE bool GetPrivateMarker (MarkerType n) const
 
__INLINE void RemPrivateMarker (MarkerType n) const
 
__INLINE void ClearMarkerSpace () const
 
__INLINE void GetMarkerSpace (bulk copy[MarkerFields]) const
 
__INLINE void SetMarkerSpace (bulk source[MarkerFields]) const
 
__INLINE integer LocalID () const
 
__INLINE integer DataLocalID () const
 This number is guaranteed to be between 0 and Mesh::NumberOf(type of element) after Mesh::ReorderEmpty.
 
__INLINE bool isValid () const
 
__INLINE MeshGetMeshLink () const
 
__INLINE HandleType GetHandle () const
 
__INLINE Element getAsElement () const
 
__INLINE Node getAsNode () const
 
__INLINE Edge getAsEdge () const
 
__INLINE Face getAsFace () const
 
__INLINE Cell getAsCell () const
 
__INLINE ElementSet getAsSet () const
 

Static Public Member Functions

static Edge UniteEdges (const ElementArray< Edge > &edges, MarkerType del_protect)
 
static bool TestUniteEdges (const ElementArray< Edge > &edges, MarkerType del_protect)
 
static ElementArray< EdgeSplitEdge (Edge e, const ElementArray< Node > &nodes, MarkerType del_protect)
 
static bool TestSplitEdge (Edge e, const ElementArray< Node > &nodes, MarkerType del_protect)
 
static Node CollapseEdge (Edge e)
 
static bool SameLine (const ElementArray< Edge > &edges)
 
- Static Public Member Functions inherited from INMOST::Element
static const char * GeometricTypeName (GeometricType t)
 
static integer GetGeometricDimension (GeometricType m_type)
 
static const char * StatusName (Status s)
 
static bool CheckConnectivity (Mesh *m)
 

Additional Inherited Members

- Public Types inherited from INMOST::Element
typedef INMOST_DATA_BULK_TYPE GeometricType
 
typedef INMOST_DATA_BULK_TYPE Status
 
typedef inner_reference_array adj_type
 
typedef adj_type::iterator adj_iterator
 
typedef adj_type::const_iterator const_adj_iterator
 
typedef adj_type::reverse_iterator adj_reverse_iterator
 
typedef adj_type::const_reverse_iterator const_adj_reverse_iterator
 
- Public Types inherited from INMOST::Storage
typedef INMOST_DATA_REAL_TYPE real
 Storage type for representing real values.
 
typedef INMOST_DATA_INTEGER_TYPE integer
 Storage type for representing integer values.
 
typedef INMOST_DATA_BULK_TYPE bulk
 Storage type for representing one byte of abstract data.
 
typedef INMOST_DATA_ENUM_TYPE enumerator
 type for representing unsigned integer values.
 
typedef HandleType reference
 Storage type for representing references to Element.
 
typedef RemoteHandleType remote_reference
 Storage type for representing references to Element in another Mesh.
 
typedef shell< realreal_array
 Storage type for representing arrays of real values.
 
typedef shell< integerinteger_array
 Storage type for representing arrays of integer values.
 
typedef shell< bulkbulk_array
 Storage type for representing abstract data as a series of bytes.
 
typedef variable var
 Storage type for representing real value with vector of variations.
 
typedef shell< variablevar_array
 Storage type for representing array of values with vectors of variations.
 
- Static Public Attributes inherited from INMOST::Element
static const GeometricType Unset = 0
 
static const GeometricType Vertex = 1
 
static const GeometricType Line = 2
 
static const GeometricType MultiLine = 3
 
static const GeometricType Tri = 4
 
static const GeometricType Quad = 5
 
static const GeometricType Polygon = 6
 
static const GeometricType MultiPolygon = 7
 
static const GeometricType Tet = 8
 
static const GeometricType Hex = 9
 
static const GeometricType Prism = 10
 
static const GeometricType Pyramid = 11
 
static const GeometricType Polyhedron = 12
 
static const GeometricType Set = 253
 
static const GeometricType MeshPart = 254
 
static const GeometricType MaxType = 255
 
static const Status Owned = 1
 
static const Status Shared = 2
 
static const Status Ghost = 4
 
static const Status Any = 0
 
- Protected Member Functions inherited from INMOST::Element
void SetGeometricType (GeometricType t)
 
- Protected Attributes inherited from INMOST::Storage
HandleType handle
 
HandleType * handle_link
 

Detailed Description

Definition at line 534 of file inmost_mesh.h.

Member Function Documentation

◆ getCells()

ElementArray<Cell> INMOST::Edge::getCells ( ) const
virtual

Return all the cells of the element.

For a node returns unordered set of cells.

For an edge returns unordered set of cells.

For a face returns a pair of cells. In the case Face::CheckNormalOrientation returns true then the normal points from the first cell to the second and in opposite direction otherwise.

For a cell returns itself.

Returns
array of elements
See also
Face::FaceOrientedOutside

Reimplemented from INMOST::Element.

◆ getFaces()

ElementArray<Face> INMOST::Edge::getFaces ( ) const
virtual

Retrieve all the faces of the element.

For a node returns unordered set of faces.

For an edge returns unordered set of faces.

For a face returns itself.

For a cell return ordered set of faces. The order of faces in the cell is preserved from the first construction.

Returns
array of elements

Reimplemented from INMOST::Element.

◆ getNodes()

ElementArray<Node> INMOST::Edge::getNodes ( ) const
virtual

Retrieve all the nodes of the element.

For a node returns itself.

For an edge returns ordered pair of nodes. The order of nodes in the edge is preserved from the first construction.

For a face returns ordered set of nodes. In the case Face::CheckNormalOrientation returns true the order of nodes will follow right hand side rule with respect to normal vector, otherwise it follows left hand side rule with respect to normal vector.

For a cell returns the same order that was provided through suggest_nodes_order in Mesh::CreateCell. In the case suggest_nodes_order was not provided, the order of nodes follows VTK format for known types of elements such as Element::Tet, Element::Prism, Element::Hex, Element::Pyramid. For a general polyhedron the order is unspecified.

Returns
array of elements
See also
Face::CheckNormalOrientation
Face::FaceOrientedOutside

Reimplemented from INMOST::Element.


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