GEOSX
Functions
for NodeManager fixed data

Functions

EdgeMapType const & geos::NodeManager::edgeList () const
 Provide an immutable accessor to the nodes-to-edges relation. More...
 
EdgeMapTypegeos::NodeManager::edgeList ()
 Get a mutable accessor to the node-to-edges relation. More...
 
FaceMapType const & geos::NodeManager::faceList () const
 Provide a const accessor to the nodes-to-faces relation. More...
 
FaceMapTypegeos::NodeManager::faceList ()
 Get the nodes-to-faces relation. More...
 
ElemMapTypegeos::NodeManager::toElementRelation ()
 Get the nodes-to-elements relation. More...
 
ElemMapType const & geos::NodeManager::toElementRelation () const
 Provide a const accessor to the nodes-to-elements relation. More...
 
ArrayOfArrays< localIndex > & geos::NodeManager::elementRegionList ()
 Get the mutable nodes-to-elements-regions relation. More...
 
ArrayOfArraysView< localIndex const > geos::NodeManager::elementRegionList () const
 Provide an immutable arrayView to the nodes-to-elements-regions relation. More...
 
ArrayOfArrays< localIndex > & geos::NodeManager::elementSubRegionList ()
 Get the mutable nodes-to-elements-subregions relation. More...
 
ArrayOfArraysView< localIndex const > geos::NodeManager::elementSubRegionList () const
 Provide an immutable arrayView to the nodes-to-elements-subregions relation. More...
 
ArrayOfArrays< localIndex > & geos::NodeManager::elementList ()
 Get the mutable nodes-to-elements relation. More...
 
ArrayOfArraysView< localIndex const > geos::NodeManager::elementList () const
 Provide an immutable arrayView to the nodes-to-elements indices. More...
 
array2d< real64, nodes::REFERENCE_POSITION_PERM > & geos::NodeManager::referencePosition ()
 Get the mutable reference position array. This table will contain all the node coordinates. More...
 
arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geos::NodeManager::referencePosition () const
 Provide an immutable arrayView of the reference position. This table will contain all the node coordinates. More...
 

Detailed Description

Function Documentation

◆ edgeList() [1/2]

EdgeMapType& geos::NodeManager::edgeList ( )
inline

Get a mutable accessor to the node-to-edges relation.

Returns
reference to nodes-to-edges relation

Definition at line 315 of file NodeManager.hpp.

◆ edgeList() [2/2]

EdgeMapType const& geos::NodeManager::edgeList ( ) const
inline

Provide an immutable accessor to the nodes-to-edges relation.

Returns
const reference to nodes-to-edges relation

Definition at line 309 of file NodeManager.hpp.

◆ elementList() [1/2]

ArrayOfArrays< localIndex >& geos::NodeManager::elementList ( )
inline

Get the mutable nodes-to-elements relation.

Returns
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 389 of file NodeManager.hpp.

◆ elementList() [2/2]

ArrayOfArraysView< localIndex const > geos::NodeManager::elementList ( ) const
inline

Provide an immutable arrayView to the nodes-to-elements indices.

Returns
const reference to nodes-to-elements indices
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 396 of file NodeManager.hpp.

◆ elementRegionList() [1/2]

ArrayOfArrays< localIndex >& geos::NodeManager::elementRegionList ( )
inline

Get the mutable nodes-to-elements-regions relation.

Returns
reference to nodes-to-elements-regions relation
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 349 of file NodeManager.hpp.

◆ elementRegionList() [2/2]

ArrayOfArraysView< localIndex const > geos::NodeManager::elementRegionList ( ) const
inline

Provide an immutable arrayView to the nodes-to-elements-regions relation.

Returns
const reference to nodes-to-elements-regions relation
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 356 of file NodeManager.hpp.

◆ elementSubRegionList() [1/2]

ArrayOfArrays< localIndex >& geos::NodeManager::elementSubRegionList ( )
inline

Get the mutable nodes-to-elements-subregions relation.

Returns
reference to nodes-to-elements-subregions relation
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 363 of file NodeManager.hpp.

◆ elementSubRegionList() [2/2]

ArrayOfArraysView< localIndex const > geos::NodeManager::elementSubRegionList ( ) const
inline

Provide an immutable arrayView to the nodes-to-elements-subregions relation.

Returns
const reference to nodes-to-elements-subregions relation
reference to nodes-to-elements indices

There is an implicit convention here.

elementList binds a node index to multiple elements indices, like n -> (e0, e1,...). elementRegionList and elementSubRegionList respectively bind node indices to the regions/sub-regions: n -> (er0, er1, ...) and n -> (esr0, esr1, ...).

It is assumed in the code that triplets obtained at indices 0, 1, ... of all these relations, (respectively (e0, er0, esr0), (e1, er1, esr1), ...) are consistent. e0 should belong to both er0 and esr0. Same pattern for other indices.

In particular, any mismatch like (e.g.) n -> (e0, e1, ...) and n -> (er1, er0, ...) will probably result in a bug.

Warning
e, er or esr will equal -1 if undefined.
See also
geos::FaceManager::elementList that shares the same kind of pattern.

Definition at line 370 of file NodeManager.hpp.

◆ faceList() [1/2]

FaceMapType& geos::NodeManager::faceList ( )
inline

Get the nodes-to-faces relation.

Returns
reference to nodes-to-faces relation

Definition at line 327 of file NodeManager.hpp.

◆ faceList() [2/2]

FaceMapType const& geos::NodeManager::faceList ( ) const
inline

Provide a const accessor to the nodes-to-faces relation.

Returns
const reference to nodes-to-faces relation

Definition at line 321 of file NodeManager.hpp.

◆ referencePosition() [1/2]

array2d< real64, nodes::REFERENCE_POSITION_PERM >& geos::NodeManager::referencePosition ( )
inline

Get the mutable reference position array. This table will contain all the node coordinates.

Returns
reference position array

Definition at line 404 of file NodeManager.hpp.

◆ referencePosition() [2/2]

arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geos::NodeManager::referencePosition ( ) const
inline

Provide an immutable arrayView of the reference position. This table will contain all the node coordinates.

Returns
an immutable arrayView of the reference position.

Definition at line 411 of file NodeManager.hpp.

◆ toElementRelation() [1/2]

ElemMapType& geos::NodeManager::toElementRelation ( )
inline

Get the nodes-to-elements relation.

Returns
reference to nodes-to-elements relation

Definition at line 333 of file NodeManager.hpp.

◆ toElementRelation() [2/2]

ElemMapType const& geos::NodeManager::toElementRelation ( ) const
inline

Provide a const accessor to the nodes-to-elements relation.

The returned ElemMapType gives access, for one node to the element index, the element sub region, and the element region in relation with a node

Returns
const reference to nodes-to-elements relation

Definition at line 342 of file NodeManager.hpp.