GEOSX
Functions
for NodeManager fixed data

Functions

EdgeMapType const & geosx::NodeManager::edgeList () const
 Provide an immutable accessor to the nodes-to-edges relation. More...
 
EdgeMapTypegeosx::NodeManager::edgeList ()
 Get a mutable accessor to the node-to-edges relation. More...
 
FaceMapType const & geosx::NodeManager::faceList () const
 Provide a const accessor to the nodes-to-faces relation. More...
 
FaceMapTypegeosx::NodeManager::faceList ()
 Get the nodes-to-faces relation. More...
 
ElemMapTypegeosx::NodeManager::toElementRelation ()
 Get the nodes-to-elements relation. More...
 
ElemMapType const & geosx::NodeManager::toElementRelation () const
 Provide a const accessor to the nodes-to-elements relation. More...
 
ArrayOfArrays< localIndex > & geosx::NodeManager::elementRegionList ()
 Get the mutable nodes-to-elements-regions relation. More...
 
ArrayOfArraysView< localIndex const > geosx::NodeManager::elementRegionList () const
 Provide an immutable arrayView to the nodes-to-elements-regions relation. More...
 
ArrayOfArrays< localIndex > & geosx::NodeManager::elementSubRegionList ()
 Get the mutable nodes-to-elements-subregions relation. More...
 
ArrayOfArraysView< localIndex const > geosx::NodeManager::elementSubRegionList () const
 Provide an immutable arrayView to the nodes-to-elements-subregions relation. More...
 
ArrayOfArrays< localIndex > & geosx::NodeManager::elementList ()
 Get the mutable nodes-to-elements indices. More...
 
ArrayOfArraysView< localIndex const > geosx::NodeManager::elementList () const
 Provide an immutable arrayView to the nodes-to-elements indices. More...
 
array2d< real64, nodes::REFERENCE_POSITION_PERM > & geosx::NodeManager::referencePosition ()
 Get the mutable reference position array. This table will contain all the node coordinates. More...
 
arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geosx::NodeManager::referencePosition () const
 Provide an immutable arrayView of the reference position. This table will contain all the node coordinates. More...
 
array2d< real64, nodes::REFERENCE_POSITION_PERM > & geosx::NodeManager::embSurfNodesPosition ()
 Return the reference position array of the nodes of the embedded surfaces. More...
 
arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geosx::NodeManager::embSurfNodesPosition () const
 Return an immutable arrayView of the position. More...
 
array2d< real64, nodes::TOTAL_DISPLACEMENT_PERM > & geosx::NodeManager::totalDisplacement ()
 Get a mutable total displacement array. More...
 
arrayView2d< real64 const, nodes::TOTAL_DISPLACEMENT_USD > geosx::NodeManager::totalDisplacement () const
 Provide an immutable arrayView to the total displacement array. More...
 
array2d< real64, nodes::INCR_DISPLACEMENT_PERM > & geosx::NodeManager::incrementalDisplacement ()
 Get a mutable incremental displacement array. More...
 
arrayView2d< real64 const, nodes::INCR_DISPLACEMENT_USD > geosx::NodeManager::incrementalDisplacement () const
 Provide an immutable arrayView to the incremental displacement array. More...
 
array2d< real64, nodes::VELOCITY_PERM > & geosx::NodeManager::velocity ()
 Get a mutable velocity array. More...
 
arrayView2d< real64 const, nodes::VELOCITY_USD > geosx::NodeManager::velocity () const
 Provide an immutable arrayView to the velocity array. More...
 
array2d< real64, nodes::ACCELERATION_PERM > & geosx::NodeManager::acceleration ()
 Get a mutable acceleration array. More...
 
arrayView2d< real64 const, nodes::ACCELERATION_USD > geosx::NodeManager::acceleration () const
 Provide an immutable arrayView to the acceleration array. More...
 

Detailed Description

Function Documentation

◆ acceleration() [1/2]

array2d< real64, nodes::ACCELERATION_PERM >& geosx::NodeManager::acceleration ( )
inline

Get a mutable acceleration array.

Returns
the acceleration array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the acceleration array does not exist

Definition at line 486 of file NodeManager.hpp.

◆ acceleration() [2/2]

arrayView2d< real64 const, nodes::ACCELERATION_USD > geosx::NodeManager::acceleration ( ) const
inline

Provide an immutable arrayView to the acceleration array.

Returns
immutable arrayView of the acceleration array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the acceleration array does not exist

Definition at line 494 of file NodeManager.hpp.

◆ edgeList() [1/2]

EdgeMapType const& geosx::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 330 of file NodeManager.hpp.

◆ edgeList() [2/2]

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

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

Returns
reference to nodes-to-edges relation

Definition at line 336 of file NodeManager.hpp.

◆ elementList() [1/2]

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

Get the mutable nodes-to-elements indices.

Returns
reference to nodes-to-elements indices

Definition at line 393 of file NodeManager.hpp.

◆ elementList() [2/2]

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

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

Returns
const reference to nodes-to-elements indices

Definition at line 400 of file NodeManager.hpp.

◆ elementRegionList() [1/2]

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

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

Returns
reference to nodes-to-elements-regions relation

Definition at line 369 of file NodeManager.hpp.

◆ elementRegionList() [2/2]

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

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

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

Definition at line 375 of file NodeManager.hpp.

◆ elementSubRegionList() [1/2]

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

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

Returns
reference to nodes-to-elements-subregions relation

Definition at line 381 of file NodeManager.hpp.

◆ elementSubRegionList() [2/2]

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

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

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

Definition at line 387 of file NodeManager.hpp.

◆ embSurfNodesPosition() [1/2]

array2d< real64, nodes::REFERENCE_POSITION_PERM >& geosx::NodeManager::embSurfNodesPosition ( )
inline

Return the reference position array of the nodes of the embedded surfaces.

Returns
the location of the nodes of the embedded surfaces

Definition at line 423 of file NodeManager.hpp.

◆ embSurfNodesPosition() [2/2]

arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geosx::NodeManager::embSurfNodesPosition ( ) const
inline

Return an immutable arrayView of the position.

Returns
immutable arrayView of the location of the nodes of the embedded surfaces.

Definition at line 430 of file NodeManager.hpp.

◆ faceList() [1/2]

FaceMapType const& geosx::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 342 of file NodeManager.hpp.

◆ faceList() [2/2]

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

Get the nodes-to-faces relation.

Returns
reference to nodes-to-faces relation

Definition at line 348 of file NodeManager.hpp.

◆ incrementalDisplacement() [1/2]

array2d< real64, nodes::INCR_DISPLACEMENT_PERM >& geosx::NodeManager::incrementalDisplacement ( )
inline

Get a mutable incremental displacement array.

Returns
the incremental displacement array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the incremental displacement does not exist

Definition at line 454 of file NodeManager.hpp.

◆ incrementalDisplacement() [2/2]

arrayView2d< real64 const, nodes::INCR_DISPLACEMENT_USD > geosx::NodeManager::incrementalDisplacement ( ) const
inline

Provide an immutable arrayView to the incremental displacement array.

Returns
immutable arrayView of the incremental displacement array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the total incremental does not exist

Definition at line 462 of file NodeManager.hpp.

◆ referencePosition() [1/2]

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

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

Returns
reference position array

Definition at line 408 of file NodeManager.hpp.

◆ referencePosition() [2/2]

arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > geosx::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 415 of file NodeManager.hpp.

◆ toElementRelation() [1/2]

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

Get the nodes-to-elements relation.

Returns
reference to nodes-to-elements relation

Definition at line 354 of file NodeManager.hpp.

◆ toElementRelation() [2/2]

ElemMapType const& geosx::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 363 of file NodeManager.hpp.

◆ totalDisplacement() [1/2]

array2d< real64, nodes::TOTAL_DISPLACEMENT_PERM >& geosx::NodeManager::totalDisplacement ( )
inline

Get a mutable total displacement array.

Returns
the total displacement array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the total displacement does not exist

Definition at line 438 of file NodeManager.hpp.

◆ totalDisplacement() [2/2]

arrayView2d< real64 const, nodes::TOTAL_DISPLACEMENT_USD > geosx::NodeManager::totalDisplacement ( ) const
inline

Provide an immutable arrayView to the total displacement array.

Returns
immutable arrayView of the total displacement array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the total displacement does not exist

Definition at line 446 of file NodeManager.hpp.

◆ velocity() [1/2]

array2d< real64, nodes::VELOCITY_PERM >& geosx::NodeManager::velocity ( )
inline

Get a mutable velocity array.

Returns
the velocity array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the velocity array does not exist

Definition at line 470 of file NodeManager.hpp.

◆ velocity() [2/2]

arrayView2d< real64 const, nodes::VELOCITY_USD > geosx::NodeManager::velocity ( ) const
inline

Provide an immutable arrayView to the velocity array.

Returns
immutable arrayView of the velocity array if it exists, or an error is thrown if it does not exist
Note
An error is thrown if the velocity array does not exist

Definition at line 478 of file NodeManager.hpp.